Class ZoneRoleRequirement
- java.lang.Object
-
- com.inductiveautomation.ignition.common.user.ZoneRoleRequirement
-
- All Implemented Interfaces:
java.io.Serializable
public class ZoneRoleRequirement extends java.lang.Object implements java.io.Serializable
Represents a permission requirement, where the request must originate from a specific security zone and/or be initiated by a user which has a certain role.Represents a Security Zone and/or a Rolename. Either may be null or blank, which indicates that permission will be granted.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ZoneRoleRequirement.PermissionResult
-
Constructor Summary
Constructors Constructor Description ZoneRoleRequirement()
Empty ctor for xml serializationZoneRoleRequirement(java.lang.String zone, java.lang.String role)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ZoneRoleRequirement.PermissionResult
checkAccess(java.util.Collection<java.lang.String> roles, java.util.Collection<java.lang.String> zones)
Given a collection of zones and roles that are present for a request, check whether or not this requirement is satisfied.boolean
equals(java.lang.Object o)
static ZoneRoleRequirement
getEmptyZoneRoleRequirement()
Used by NamedQuery to make a default any/any security zone requirement.java.lang.String
getRole()
java.lang.String
getZone()
int
hashCode()
void
setRole(java.lang.String role)
void
setZone(java.lang.String zone)
-
-
-
Method Detail
-
getEmptyZoneRoleRequirement
public static ZoneRoleRequirement getEmptyZoneRoleRequirement()
Used by NamedQuery to make a default any/any security zone requirement.- Returns:
- A new ZoneRoleRequirement with both zone and role set to null.
-
getZone
@Nullable public java.lang.String getZone()
-
setZone
public void setZone(java.lang.String zone)
-
getRole
@Nullable public java.lang.String getRole()
-
setRole
public void setRole(java.lang.String role)
-
checkAccess
public ZoneRoleRequirement.PermissionResult checkAccess(@Nullable java.util.Collection<java.lang.String> roles, @Nullable java.util.Collection<java.lang.String> zones)
Given a collection of zones and roles that are present for a request, check whether or not this requirement is satisfied.- Parameters:
roles
- List of roles the requester has. May be null; null returns denied.zones
- List of zones the requester is in. May be null; null should match Default.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-