Package javax.security.jacc

Class EJBRoleRefPermission

  • All Implemented Interfaces:
    java.io.Serializable, java.security.Guard
    public final class EJBRoleRefPermission
extends java.security.Permission
implements java.io.Serializable

    Class for EJB isCallerInRole (String reference) permissions. An EJBRoleRefPermission is a named permission and has actions.

    The name of an EJBRoleRefPermission contains the value of the ejb-name element in the application's deployment descriptor that identifies the EJB in whose context the permission is being evaluated.

    The actions of an EJBRoleRefPermission identifies the role reference to which the permission applies. An EJBRoleRefPermission is checked to determine if the subject is a member of the role identified by the reference.

    Implementations of this class MAY implement newPermissionCollection or inherit its implementation from the super class.

    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String actions
      The security-role-ref/role-link value
      private int hashCode  
      private static long serialVersionUID  

    • Constructor Summary

      Constructors 
      Constructor Description
      EJBRoleRefPermission​(java.lang.String ejbName, java.lang.String actions)
      Creates a new EJBRoleRefPermission with the specified name and actions.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)
      Checks two EJBRoleRefPermission objects for equality.
      java.lang.String getActions()
      Returns a canonical String representation of the actions of this EJBRoleRefPermission.
      int hashCode()
      Returns the hash code value for this EJBRoleRefPermission.
      boolean implies​(java.security.Permission permission)
      Determines if the argument Permission is "implied by" this EJBRoleRefPermission.
      java.lang.String toString()
      Returns the String representation of this permission, which has the following form:

      • Methods inherited from class java.security.Permission

        checkGuard, getName, newPermissionCollection

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • actions

        private java.lang.String actions
        The security-role-ref/role-link value

      • hashCode

        private transient int hashCode

    • Constructor Detail

      • EJBRoleRefPermission

        public EJBRoleRefPermission​(java.lang.String ejbName,
                            java.lang.String actions)

        Creates a new EJBRoleRefPermission with the specified name and actions.

        Parameters:
        ejbName - - the ejb-name that identifies the EJB in whose context the role references are to be evaluated.
        actions - - identifies the role reference to which the permission pertains. The role reference is scoped to the EJB identified in the name parameter. The value of the role reference must not be null or the empty string.

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object o)

        Checks two EJBRoleRefPermission objects for equality. EJBRoleRefPermission objects are equivalent if they have case equivalent name and actions values.

        Two Permission objects, P1 and P2, are equivalent if and only if P1.implies(P2) && P2.implies(P1).

        Specified by:
        equals in class java.security.Permission
        Parameters:
        o - - the EJBRoleRefPermission object being tested for equality with this EJBRoleRefPermission.
        Returns:
        true if the argument EJBRoleRefPermission object is equivalent to this EJBRoleRefPermission.

      • getActions

        public java.lang.String getActions()

        Returns a canonical String representation of the actions of this EJBRoleRefPermission.

        Specified by:
        getActions in class java.security.Permission
        Returns:
        a String containing the canonicalized actions of this EJBRoleRefPermission.

      • hashCode

        public int hashCode()

        Returns the hash code value for this EJBRoleRefPermission. The properties of the returned hash code must be as follows:

        • During the lifetime of a Java application, the hashCode method must return the same integer value, every time it is called on a EJBRoleRefPermission object. The value returned by hashCode for a particular EJBRoleRefPermission need not remain consistent from one execution of an application to another.
        • If two EJBRoleRefPermission objects are equal according to the equals method, then calling the hash- Code method on each of the two Permission objects must produce the same integer result (within an application).

        Specified by:
        hashCode in class java.security.Permission
        Returns:
        the integer hash code value for this object.

      • implies

        public boolean implies​(java.security.Permission permission)

        Determines if the argument Permission is "implied by" this EJBRoleRefPermission. For this to be the case,

        • The argument must be an instance of EJBRoleRefPermission with name equivalent to that of this EJBRoleRefPermission, and with the role reference equivalent to that of this EJBRoleRefPermission applies.

        The name and actions comparisons described above are case sensitive.

        Specified by:
        implies in class java.security.Permission
        Parameters:
        permission - - “this” EJBRoleRefPermission is checked to see if it implies the argument permission.
        Returns:
        true if the specified permission is implied by this object, false if not.

      • toString

        public java.lang.String toString()

        Returns the String representation of this permission, which has the following form: 

         [ejb-name,role-ref=actions]

        Overrides:
        toString in class java.security.Permission