Class 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
    • Constructor Detail

      • ZoneRoleRequirement

        public ZoneRoleRequirement()
        Empty ctor for xml serialization
      • ZoneRoleRequirement

        public ZoneRoleRequirement​(@Nullable
                                   java.lang.String zone,
                                   @Nullable
                                   java.lang.String role)
    • 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 class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object