com.ibm.websphere.wim.security.authz
Class Entitlement

java.lang.Object
  extended by com.ibm.websphere.wim.security.authz.Entitlement
All Implemented Interfaces:
java.io.Serializable

public class Entitlement
extends java.lang.Object
implements java.io.Serializable

A class representing an entitlement.

See Also:
Serialized Form

Field Summary
static java.lang.String ATTRIB_METHOD_READ
           
static java.lang.String ATTRIB_METHOD_WRITE
           
static java.lang.String METHOD_GET_ENTITLEMENTS
           
static java.lang.String OBJECT_METHOD_CREATE
           
static java.lang.String OBJECT_METHOD_DELETE
           
static java.lang.String OBJECT_METHOD_DELETE_DSC
           
static java.lang.String OBJECT_METHOD_GET
           
static java.lang.String OBJECT_METHOD_SEARCH
           
static java.lang.String OBJECT_METHOD_UPDATE
           
 
Constructor Summary
Entitlement(java.lang.String method)
          Constructs an object entitlement.
Entitlement(java.lang.String method, java.lang.String object)
          Constructs an object entitlement.
Entitlement(java.lang.String method, java.lang.String object, java.lang.String attribute)
          Constructs an attribute entitlement.
 
Method Summary
 boolean equals(java.lang.Object object)
          Compares this entitlement to another object.
 java.lang.String getAttribute()
          Returns the attribute.
 java.lang.String getMethod()
          Returns the method.
 java.lang.String getObject()
          Returns the object.
 int hashCode()
          Returns the hash code.
 boolean isAttributeEntitlement()
          Indicates whether this is an attribute entitlement.
 boolean isAttributeMethodAllowed(java.lang.String method, java.lang.String attribute)
          Indicates whether the attribute method is allowed.
 boolean isObjectMethodAllowed(java.lang.String method)
          Indicates whether the object method is allowed.
 java.lang.String toSimpleString()
          Returns the entitlement as a simple string where the hierarchical structures have been removed.
 java.lang.String toString()
          Returns the entitlement as a string.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

OBJECT_METHOD_CREATE

public static final java.lang.String OBJECT_METHOD_CREATE
See Also:
Constant Field Values

OBJECT_METHOD_DELETE

public static final java.lang.String OBJECT_METHOD_DELETE
See Also:
Constant Field Values

OBJECT_METHOD_DELETE_DSC

public static final java.lang.String OBJECT_METHOD_DELETE_DSC
See Also:
Constant Field Values

OBJECT_METHOD_GET

public static final java.lang.String OBJECT_METHOD_GET
See Also:
Constant Field Values

OBJECT_METHOD_SEARCH

public static final java.lang.String OBJECT_METHOD_SEARCH
See Also:
Constant Field Values

OBJECT_METHOD_UPDATE

public static final java.lang.String OBJECT_METHOD_UPDATE
See Also:
Constant Field Values

ATTRIB_METHOD_READ

public static final java.lang.String ATTRIB_METHOD_READ
See Also:
Constant Field Values

ATTRIB_METHOD_WRITE

public static final java.lang.String ATTRIB_METHOD_WRITE
See Also:
Constant Field Values

METHOD_GET_ENTITLEMENTS

public static final java.lang.String METHOD_GET_ENTITLEMENTS
See Also:
Constant Field Values
Constructor Detail

Entitlement

public Entitlement(java.lang.String method)
Constructs an object entitlement.

Parameters:
method - Method

Entitlement

public Entitlement(java.lang.String method,
                   java.lang.String object)
Constructs an object entitlement.

Parameters:
method - Method
object - Object

Entitlement

public Entitlement(java.lang.String method,
                   java.lang.String object,
                   java.lang.String attribute)
Constructs an attribute entitlement.

Parameters:
method - Method
object - Object
attribute - Attribute
Method Detail

getMethod

public java.lang.String getMethod()
Returns the method.

Return:
Method

getObject

public java.lang.String getObject()
Returns the object.

Return:
Object

getAttribute

public java.lang.String getAttribute()
Returns the attribute.

Return:
Attribute

isAttributeEntitlement

public boolean isAttributeEntitlement()
Indicates whether this is an attribute entitlement.

Return:
Whether this is an attribute entitlement

isObjectMethodAllowed

public boolean isObjectMethodAllowed(java.lang.String method)
Indicates whether the object method is allowed.

Parameters:
method - Method
Return:
Whether the object method is allowed

isAttributeMethodAllowed

public boolean isAttributeMethodAllowed(java.lang.String method,
                                        java.lang.String attribute)
Indicates whether the attribute method is allowed.

Parameters:
method - Method
attribute - Attribute
Return:
Whether the attribute method is allowed

equals

public boolean equals(java.lang.Object object)
Compares this entitlement to another object.

Overrides:
equals in class java.lang.Object
Parameters:
object - Object

hashCode

public int hashCode()
Returns the hash code.

Overrides:
hashCode in class java.lang.Object
Return:
Hash code

toString

public java.lang.String toString()
Returns the entitlement as a string.

Overrides:
toString in class java.lang.Object
Return:
Entitlement string

toSimpleString

public java.lang.String toSimpleString()
Returns the entitlement as a simple string where the hierarchical structures have been removed.

Return:
Simple entitlement string