File	Doc	Category	Size	Date	Package
PolicyConfiguration.java	API Doc	Glassfish v2 API	26875	Fri May 04 22:36:00 BST 2007	javax.security.jacc

PolicyConfiguration

Fields Summary

Constructors Summary

Methods Summary
public void	addToExcludedPolicy(java.security.PermissionCollection permissions) Used to add excluded policy statements to this PolicyConfiguration. param permissions the collection of permissions to be added to the excluded policy statements. The collection may be either a homogenous or heterogenous collection. throws java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws java.lang.UnsupportedOperationException if the state of the policy context whose interface is this PolicyConfiguration Object is "deleted" or "inService" when this method is called. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been accounted for by the addToExcludedPolicy method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.
public void	addToExcludedPolicy(java.security.Permission permission) Used to add a single excluded policy statement to this PolicyConfiguration. param permission the permission to be added to the excluded policy statements. throws java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws java.lang.UnsupportedOperationException if the state of the policy context whose interface is this PolicyConfiguration Object is "deleted" or "inService" when this method is called. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been accounted for by the addToExcludedPolicy method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.
public void	addToRole(java.lang.String roleName, java.security.PermissionCollection permissions) Used to add permissions to a named role in this PolicyConfiguration. If the named Role does not exist in the PolicyConfiguration, it is created as a result of the call to this function. It is the job of the Policy provider to ensure that all the permissions added to a role are granted to principals "mapped to the role". param roleName the name of the Role to which the permissions are to be added. param permissions the collection of permissions to be added to the role. The collection may be either a homogenous or heterogenous collection. throws java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws java.lang.UnsupportedOperationException if the state of the policy context whose interface is this PolicyConfiguration Object is "deleted" or "inService" when this method is called. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that 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.
public void	addToRole(java.lang.String roleName, java.security.Permission permission) Used to add a single permission to a named role in this PolicyConfiguration. If the named Role does not exist in the PolicyConfiguration, it is created as a result of the call to this function. It is the job of the Policy provider to ensure that all the permissions added to a role are granted to principals "mapped to the role". param roleName the name of the Role to which the permission is to be added. param permission the permission to be added to the role. throws java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws java.lang.UnsupportedOperationException if the state of the policy context whose interface is this PolicyConfiguration Object is "deleted" or "inService" when this method is called. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that 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.
public void	addToUncheckedPolicy(java.security.PermissionCollection permissions) Used to add unchecked policy statements to this PolicyConfiguration. param permissions the collection of permissions to be added as unchecked policy statements. The collection may be either a homogenous or heterogenous collection. throws java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws java.lang.UnsupportedOperationException if the state of the policy context whose interface is this PolicyConfiguration Object is "deleted" or "inService" when this method is called. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been accounted for by the addToUncheckedPolicy method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.
public void	addToUncheckedPolicy(java.security.Permission permission) Used to add a single unchecked policy statement to this PolicyConfiguration. param permission the permission to be added to the unchecked policy statements. throws java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws java.lang.UnsupportedOperationException if the state of the policy context whose interface is this PolicyConfiguration Object is "deleted" or "inService" when this method is called. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been accounted for by the addToUncheckedPolicy method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.
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. 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 java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws java.lang.UnsupportedOperationException if the state of the policy context whose interface is this PolicyConfiguration Object is "deleted" when this method is called. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been accounted for by the commit method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.
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 java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been accounted for by the delete method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.
public java.lang.String	getContextID() This method returns this object's policy context identifier. return this object's policy context identifier. throws java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been accounted for by the getContextID method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.
public boolean	inService() This method is used to determine if the policy context whose interface is this PolicyConfiguration Object is in the "inService" state. return true if the state of the associated policy context is "inService"; false otherwise. throws java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been accounted for by the inService method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.
public void	linkConfiguration(javax.security.jacc.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. param link a reference to a different PolicyConfiguration than this PolicyConfiguration. The relationship formed by this method is symetric, transitive and idempotent. If the argument PolicyConfiguration does not have a different Policy context identifier than this PolicyConfiguration no relationship is formed, and an exception, as described below, is thrown. throws java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws java.lang.UnsupportedOperationException if the state of the policy context whose interface is this PolicyConfiguration Object is "deleted" or "inService" when this method is called. throws java.lang.IllegalArgumentException if called with an argument PolicyConfiguration whose Policy context is equivalent to that of this PolicyConfiguration. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been accounted for by the linkConfiguration method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.
public void	removeExcludedPolicy() Used to remove any excluded policy statements from this PolicyConfiguration. throws java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws java.lang.UnsupportedOperationException if the state of the policy context whose interface is this PolicyConfiguration Object is "deleted" or "inService" when this method is called. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been accounted for by the removeExcludedPolicy method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.
public void	removeRole(java.lang.String roleName) Used to remove a role and all its permissions from this PolicyConfiguration. param roleName the name of the Role to remove from this PolicyConfiguration. throws java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws java.lang.UnsupportedOperationException if the state of the policy context whose interface is this PolicyConfiguration Object is "deleted" or "inService" when this method is called. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that 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.
public void	removeUncheckedPolicy() Used to remove any unchecked policy statements from this PolicyConfiguration. throws java.lang.SecurityException if called by an AccessControlContext that has not been granted the "setPolicy" SecurityPermission. throws java.lang.UnsupportedOperationException if the state of the policy context whose interface is this PolicyConfiguration Object is "deleted" or "inService" when this method is called. throws javax.security.jacc.PolicyContextException if the implementation throws a checked exception that has not been accounted for by the removeUncheckedPolicy method signature. The exception thrown by the implementation class will be encapsulated (during construction) in the thrown PolicyContextException.