SecurityPolicyItem Class

com.bea.p13n.entitlements.policy
SecurityPolicyItem Class

public class SecurityPolicyItem

    extends PolicyItem

This class encapsulates the information comprising a single Security Policy. It is used to collect and hold security policy attributes during the process of building and managing security policies.

The SecurityPolicyManager is used for persistence related operations upon SecurityPolicyItems.


Hierarchy
Object
  PolicyItem
    SecurityPolicyItem
All Implemented Interfaces

Cloneable, Serializable

Constructor Summary

SecurityPolicyItem()

This no-args constructor allows a SecurityPolicyItem to be created and initialized piecemeal by an application.
SecurityPolicyItem(String aEntAppName, String aWebAppName, String aResourceId, List aUserList, List aGroupList, List aRoleList, String aCapability, P13nContextHandler aContextHandler)

Initialize a new security policy.
 

Method Summary

public Object
clone()
Clone
public String
getCapability()
Returns the optional capability name used to identify this security policy.
public String
getDescription()
Gets the optional description used to describe this security policy.
public List
getRoleList()
Returns the list of roles used within this security policy.
public void
setCapability(String aCapabilityName)
Sets the optional capability name used to identify this security policy.
public void
setDescription(String aDescription)
Sets the optional description used to describe this security policy.
public void
setRoleList(List aRoleList)
Sets the list of roles used within this security policy.
 
Methods from  com.bea.p13n.entitlements.policy.PolicyItem
getContextHandler, getEntAppName, getGroupList, getPolicyUser, getResourceId, getUserList, getWebAppName, setContextHandler, setEntAppName, setGroupList, setPolicyUser, setResourceId, setUserList, setWebAppName
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Constructor Detail

SecurityPolicyItem

public SecurityPolicyItem()
This no-args constructor allows a SecurityPolicyItem to be created and initialized piecemeal by an application.

SecurityPolicyItem

public SecurityPolicyItem(String aEntAppName, 
                          String aWebAppName, 
                          String aResourceId, 
                          List aUserList, 
                          List aGroupList, 
                          List aRoleList, 
                          String aCapability, 
                          P13nContextHandler aContextHandler)
Initialize a new security policy. Note that none of the parameters are required to construct this class, however certain operations will not succeed unless the required parameters for that operation are valid. Also, for example, if this object is used to persist a policy without a user list being initialized, it is assumed there are no user predicates required in the policy.
 

Method Detail

clone() Method

public Object clone()
throws CloneNotSupportedException
Clone

Overrides
PolicyItem.clone()

Returns

Clone of a SecurityPolicyItem

Exceptions

CloneNotSupportedException

getCapability() Method

public String getCapability()
Returns the optional capability name used to identify this security policy.

Returns

String name of capability, or null or empty string if none exists

getDescription() Method

public String getDescription()
Gets the optional description used to describe this security policy.


getRoleList() Method

public List getRoleList()
Returns the list of roles used within this security policy.

Returns

List of roles or null if none exist

setCapability(String) Method

public void setCapability(String aCapabilityName)
Sets the optional capability name used to identify this security policy.


setDescription(String) Method

public void setDescription(String aDescription)
Sets the optional description used to describe this security policy.


setRoleList(List) Method

public void setRoleList(List aRoleList)
Sets the list of roles used within this security policy.