|
| |
|
| java.lang.Object
 org.objectweb.jonas_lib.security.jacc.JPolicyConfiguration
| JPolicyConfiguration | | public class JPolicyConfiguration implements PolicyConfiguration(Code) | | Defines the PolicyConfiguration implementation class of JACC
author:
Florent Benoit |
| Method Summary | |
| public void | addToExcludedPolicy(Permission permission)
Used to add a single excluded policy statement to this PolicyConfiguration.
Parameters:
permission - the permission to be added to the excluded policy statements.
throws:
SecurityException - if called by an AccessControlContext that hasnot been granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy context whoseinterface is this PolicyConfiguration Object is "deleted" or "inService"when this method is called.
throws:
PolicyContextException - if the implementation throws a checked exceptionthat has not been accounted for by the addToExcludedPolicy methodsignature. | | public void | addToExcludedPolicy(PermissionCollection permissions)
Used to add excluded policy statements to this PolicyConfiguration.
Parameters:
permissions - the collection of permissions to be added to theexcluded policy statements. | | public void | addToRole(String roleName, Permission permission)
Used to add a single permission to a named role in this PolicyConfiguration. | | public void | addToRole(String roleName, PermissionCollection permissions)
Used to add permissions to a named role in this PolicyConfiguration. | | public void | addToUncheckedPolicy(Permission permission)
Used to add a single unchecked policy statement to this PolicyConfiguration.
Parameters:
permission - the permission to be added to the unchecked policy statements.
throws:
SecurityException - if called by an AccessControlContext that has notbeen granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy context whoseinterface is this PolicyConfiguration Object is "deleted" or"inService" when this method is called.
throws:
PolicyContextException - if the implementation throws a checked exceptionthat has not been accounted for by the addToUncheckedPolicy methodsignature. | | public void | addToUncheckedPolicy(PermissionCollection permissions)
Used to add unchecked policy statements to this PolicyConfiguration.
Parameters:
permissions - the collection of permissions to be added asunchecked policy statements. | | public void | commit()
This method is used to set to "inService" the state of the policy
context whose interface is this PolicyConfiguration Object.
Only those policy contexts whose state is "inService" will be included
in the policy contexts processed by the Policy.refresh method. | | public void | delete()
Causes all policy statements to be deleted from this PolicyConfiguration
and sets its internal state such that calling any method, other than delete,
getContextID, or inService on the PolicyConfiguration will be rejected and
cause an UnsupportedOperationException to be thrown.
This operation has no affect on any linked PolicyConfigurations other than
removing any links involving the deleted PolicyConfiguration.
throws:
SecurityException - if called by an AccessControlContext that hasnot been granted the "setPolicy" SecurityPermission.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by the delete methodsignature. | | public boolean | equals(Object obj)
Indicates whether some other object is "equal to" this one.
Parameters:
obj - the reference object with which to compare. | | public String | getContextID()
This method returns this object's policy context identifier.
this object's policy context identifier.
throws:
SecurityException - if called by an AccessControlContextthat has not been granted the "setPolicy" SecurityPermission.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by the getContextIDmethod signature. | | public PermissionCollection | getExcludedPermissions()
| | public PermissionCollection | getPermissionsForPrincipal(Principal principal)
| | public PermissionCollection | getUncheckedPermissions()
| | public int | hashCode()
Gets a hash code value for the object. | | public boolean | inService()
This method is used to determine if the policy context whose interface
is this PolicyConfiguration Object is in the "inService" state.
true if the state of the associated policy context is"inService"; false otherwise.
throws:
SecurityException - if called by an AccessControlContext thathas not been granted the "setPolicy" SecurityPermission.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by the inServicemethod signature. | | public void | linkConfiguration(PolicyConfiguration link)
Creates a relationship between this configuration and another such that
they share the same principal-to-role mappings.
PolicyConfigurations are linked to apply a common principal-to-role
mapping to multiple seperately manageable PolicyConfigurations,
as is required when an application is composed of multiple modules.
Note that the policy statements which comprise a role, or comprise
the excluded or unchecked policy collections in a PolicyConfiguration
are unaffected by the configuration being linked to another.
Parameters:
link - a reference to a different PolicyConfiguration than thisPolicyConfiguration. | | public void | removeExcludedPolicy()
Used to remove any excluded policy statements from this PolicyConfiguration.
throws:
SecurityException - if called by an AccessControlContext thathas not been granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy contextwhose interface is this PolicyConfiguration Object is "deleted"or "inService" when this method is called.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by theremoveExcludedPolicy method signature. | | public void | removeRole(String roleName)
Used to remove a role and all its permissions from this PolicyConfiguration. | | public void | removeUncheckedPolicy()
Used to remove any unchecked policy statements from this PolicyConfiguration.
throws:
SecurityException - if called by an AccessControlContext that has notbeen granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy contextwhose interface is this PolicyConfiguration Object is "deleted" or"inService" when this method is called.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by the removeUncheckedPolicymethod signature. | | protected void | resetState()
|
| JPolicyConfiguration | | public JPolicyConfiguration(String contextID)(Code) | | Constructor of a new PolicyConfiguration object
Parameters:
contextID - Identifier of this PolicyConfiguration object |
| addToExcludedPolicy | | public void addToExcludedPolicy(Permission permission) throws PolicyContextException, SecurityException, UnsupportedOperationException(Code) | | Used to add a single excluded policy statement to this PolicyConfiguration.
Parameters:
permission - the permission to be added to the excluded policy statements.
throws:
SecurityException - if called by an AccessControlContext that hasnot been granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy context whoseinterface is this PolicyConfiguration Object is "deleted" or "inService"when this method is called.
throws:
PolicyContextException - if the implementation throws a checked exceptionthat has not been accounted for by the addToExcludedPolicy methodsignature. The exception thrown by the implementation class will beencapsulated (during construction) in the thrown PolicyContextException. |
| addToExcludedPolicy | | public void addToExcludedPolicy(PermissionCollection permissions) throws PolicyContextException, SecurityException, UnsupportedOperationException(Code) | | Used to add excluded policy statements to this PolicyConfiguration.
Parameters:
permissions - the collection of permissions to be added to theexcluded policy statements. The collection may be eithera homogenous or heterogenous collection.
throws:
SecurityException - if called by an AccessControlContext thathas not been granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policycontext whose interface is this PolicyConfiguration Objectis "deleted" or "inService" when this method is called.
throws:
PolicyContextException - if the implementation throws achecked exception that has not been accounted for bythe addToExcludedPolicy method signature. The exceptionthrown by the implementation class will be encapsulated(during construction) in the thrown PolicyContextException. |
| addToRole | | public void addToRole(String roleName, Permission permission) throws PolicyContextException, SecurityException, UnsupportedOperationException(Code) | | Used to add a single permission to a named role in this PolicyConfiguration.
Parameters:
roleName - the name of the Role to which the permission is to be added.
Parameters:
permission - the permission to be added to the role.
throws:
SecurityException - if called by an AccessControlContext that has notbeen granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy contextwhose interface is this PolicyConfiguration Object is "deleted"or "inService" when this method is called.
throws:
PolicyContextException - - if the implementation throws a checked exceptionthat has not been accounted for by the addToRole method signature.The exception thrown by the implementation class will be encapsulated(during construction) in the thrown PolicyContextException. |
| addToRole | | public void addToRole(String roleName, PermissionCollection permissions) throws PolicyContextException, SecurityException, UnsupportedOperationException(Code) | | Used to add permissions to a named role in this PolicyConfiguration.
Parameters:
roleName - the name of the Role to which the permissions are to be added.
Parameters:
permissions - the collection of permissions to be added to the role.The collection may be either a homogenous or heterogenous collection.
throws:
SecurityException - if called by an AccessControlContext that hasnot been granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy context whoseinterface is this PolicyConfiguration Object is "deleted" orinService" when this method is called.
throws:
PolicyContextException - - if the implementation throws a checked exceptionthat has not been accounted for by the addToRole method signature.The exception thrown by the implementation class will be encapsulated(during construction) in the thrown PolicyContextException. |
| addToUncheckedPolicy | | public void addToUncheckedPolicy(Permission permission) throws PolicyContextException, SecurityException, UnsupportedOperationException(Code) | | Used to add a single unchecked policy statement to this PolicyConfiguration.
Parameters:
permission - the permission to be added to the unchecked policy statements.
throws:
SecurityException - if called by an AccessControlContext that has notbeen granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy context whoseinterface is this PolicyConfiguration Object is "deleted" or"inService" when this method is called.
throws:
PolicyContextException - if the implementation throws a checked exceptionthat has not been accounted for by the addToUncheckedPolicy methodsignature. The exception thrown by the implementation class will beencapsulated (during construction) in the thrown PolicyContextException. |
| addToUncheckedPolicy | | public void addToUncheckedPolicy(PermissionCollection permissions) throws PolicyContextException, SecurityException, UnsupportedOperationException(Code) | | Used to add unchecked policy statements to this PolicyConfiguration.
Parameters:
permissions - the collection of permissions to be added asunchecked policy statements. The collection may be either ahomogenous or heterogenous collection.
throws:
SecurityException - if called by an AccessControlContext thathas not been granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policycontext whose interface is this PolicyConfiguration Objectis "deleted" or "inService" when this method is called.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by theaddToUncheckedPolicy method signature. The exception thrown bythe implementation class will be encapsulated (during construction)in the thrown PolicyContextException. |
| commit | | public void commit() throws PolicyContextException, SecurityException, UnsupportedOperationException(Code) | | This method is used to set to "inService" the state of the policy
context whose interface is this PolicyConfiguration Object.
Only those policy contexts whose state is "inService" will be included
in the policy contexts processed by the Policy.refresh method. A policy
context whose state is "inService" may be returned to the "open" state
by calling the getPolicyConfiguration method of the PolicyConfiguration
factory with the policy context identifier of the policy context.
When the state of a policy context is "inService", calling any method
other than commit, delete, getContextID, or inService on its
PolicyConfiguration Object will cause an UnsupportedOperationException
to be thrown.
throws:
SecurityException - if called by an AccessControlContext that hasnot been granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy contextwhose interface is this PolicyConfiguration Object is "deleted"when this method is called.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by the commit methodsignature. The exception thrown by the implementation classwill be encapsulated (during construction) in the thrownPolicyContextException. |
| delete | | public void delete() throws PolicyContextException, SecurityException(Code) | | Causes all policy statements to be deleted from this PolicyConfiguration
and sets its internal state such that calling any method, other than delete,
getContextID, or inService on the PolicyConfiguration will be rejected and
cause an UnsupportedOperationException to be thrown.
This operation has no affect on any linked PolicyConfigurations other than
removing any links involving the deleted PolicyConfiguration.
throws:
SecurityException - if called by an AccessControlContext that hasnot been granted the "setPolicy" SecurityPermission.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by the delete methodsignature. The exception thrown by the implementation class willbe encapsulated (during construction) in the thrownPolicyContextException. |
| equals | | public boolean equals(Object obj)(Code) | | Indicates whether some other object is "equal to" this one.
Parameters:
obj - the reference object with which to compare. true if this object is the same as the obj argument;false otherwise. |
| getContextID | | public String getContextID() throws PolicyContextException, SecurityException(Code) | | This method returns this object's policy context identifier.
this object's policy context identifier.
throws:
SecurityException - if called by an AccessControlContextthat has not been granted the "setPolicy" SecurityPermission.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by the getContextIDmethod signature. The exception thrown by the implementationclass will be encapsulated (during construction) in thethrown PolicyContextException. |
| getExcludedPermissions | | public PermissionCollection getExcludedPermissions()(Code) | | Gets the excluded permission
the excluded permission |
| getPermissionsForPrincipal | | public PermissionCollection getPermissionsForPrincipal(Principal principal)(Code) | | Gets the permissions for a given principal
Parameters:
principal - given principal the permissions for a given principal |
| getUncheckedPermissions | | public PermissionCollection getUncheckedPermissions()(Code) | | Gets the excluded permission
the excluded permission |
| hashCode | | public int hashCode()(Code) | | Gets a hash code value for the object.
a hash code value for this object. |
| inService | | public boolean inService() throws PolicyContextException, SecurityException(Code) | | This method is used to determine if the policy context whose interface
is this PolicyConfiguration Object is in the "inService" state.
true if the state of the associated policy context is"inService"; false otherwise.
throws:
SecurityException - if called by an AccessControlContext thathas not been granted the "setPolicy" SecurityPermission.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by the inServicemethod signature. The exception thrown by the implementationclass will be encapsulated (during construction) in the thrownPolicyContextException. |
| linkConfiguration | | public void linkConfiguration(PolicyConfiguration link) throws IllegalArgumentException, PolicyContextException, SecurityException, UnsupportedOperationException(Code) | | Creates a relationship between this configuration and another such that
they share the same principal-to-role mappings.
PolicyConfigurations are linked to apply a common principal-to-role
mapping to multiple seperately manageable PolicyConfigurations,
as is required when an application is composed of multiple modules.
Note that the policy statements which comprise a role, or comprise
the excluded or unchecked policy collections in a PolicyConfiguration
are unaffected by the configuration being linked to another.
Parameters:
link - a reference to a different PolicyConfiguration than thisPolicyConfiguration. The relationship formed by this method issymetric, transitive and idempotent. If the argumentPolicyConfiguration does not have a different Policy contextidentifier than this PolicyConfiguration no relationship isformed, and an exception, as described below, is thrown.
throws:
SecurityException - if called by an AccessControlContext thathas not been granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy contextwhose interface is this PolicyConfiguration Object is "deleted"or "inService" when this method is called.
throws:
IllegalArgumentException - if called with an argumentPolicyConfiguration whose Policy context is equivalentto that of this PolicyConfiguration.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by the linkConfigurationmethod signature. The exception thrown by the implementationclass will be encapsulated (during construction) in thethrown PolicyContextException. |
| removeExcludedPolicy | | public void removeExcludedPolicy() throws PolicyContextException, SecurityException, UnsupportedOperationException(Code) | | Used to remove any excluded policy statements from this PolicyConfiguration.
throws:
SecurityException - if called by an AccessControlContext thathas not been granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy contextwhose interface is this PolicyConfiguration Object is "deleted"or "inService" when this method is called.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by theremoveExcludedPolicy method signature. The exception thrownby the implementation class will be encapsulated(during construction) in the thrown PolicyContextException. |
| removeRole | | public void removeRole(String roleName) throws PolicyContextException, SecurityException, UnsupportedOperationException(Code) | | Used to remove a role and all its permissions from this PolicyConfiguration.
Parameters:
roleName - the name of the Role to remove from this PolicyConfiguration.
throws:
SecurityException - if called by an AccessControlContext that has notbeen granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy context whoseinterface is this PolicyConfiguration Object is "deleted" or "inService"when this method is called.
throws:
PolicyContextException - if the implementation throws a checked exceptionthat has not been accounted for by the removeRole method signature.The exception thrown by the implementation class will be encapsulated(during construction) in the thrown PolicyContextException. |
| removeUncheckedPolicy | | public void removeUncheckedPolicy() throws PolicyContextException, SecurityException, UnsupportedOperationException(Code) | | Used to remove any unchecked policy statements from this PolicyConfiguration.
throws:
SecurityException - if called by an AccessControlContext that has notbeen granted the "setPolicy" SecurityPermission.
throws:
UnsupportedOperationException - if the state of the policy contextwhose interface is this PolicyConfiguration Object is "deleted" or"inService" when this method is called.
throws:
PolicyContextException - if the implementation throws a checkedexception that has not been accounted for by the removeUncheckedPolicymethod signature. The exception thrown by the implementationclass will be encapsulated (during construction) in the thrownPolicyContextException. |
| resetState | | protected void resetState()(Code) | | Reset to OPEN state (Used by PolicyConfigurationFactory)
|
|
|
|