| java.lang.Object javax.security.jacc.PolicyConfigurationFactory
PolicyConfigurationFactory | abstract public class PolicyConfigurationFactory (Code) | | author: Scott.Stark@jboss.org author: Ron Monzillo, Gary Ellison (javadoc) version: $Revision: 57196 $ |
Method Summary | |
abstract public PolicyConfiguration | getPolicyConfiguration(String contextID, boolean remove) This method is used to obtain an instance of the provider specific class
that implements the PolicyConfiguration interface that corresponds to the
identified policy context within the provider. | public static PolicyConfigurationFactory | getPolicyConfigurationFactory() This static method uses the javax.security.jacc.PolicyConfigurationFactory.provider
system property to create a provider factory implementation. | abstract public boolean | inService(String contextID) This method determines if the identified policy context exists with state
"inService" in the Policy provider associated with the factory. |
getPolicyConfiguration | abstract public PolicyConfiguration getPolicyConfiguration(String contextID, boolean remove) throws PolicyContextException(Code) | | This method is used to obtain an instance of the provider specific class
that implements the PolicyConfiguration interface that corresponds to the
identified policy context within the provider. The methods of the
PolicyConfiguration interface are used to define the policy statements of
the identified policy context.
If at the time of the call, the identified policy context does not exist
in the provider, then the policy context will be created in the provider
and the Object that implements the context's PolicyConfiguration Interface
will be returned. If the state of the identified context is "deleted" or
"inService" it will be transitioned to the "open" state as a result of the
call. The states in the lifecycle of a policy context are defined by the
PolicyConfiguration interface.
For a given value of policy context identifier, this method must always
return the same instance of PolicyConfiguration and there must be at most
one actual instance of a PolicyConfiguration with a given policy context
identifier (during a process context).
To preserve the invariant that there be at most one PolicyConfiguration
object for a given policy context, it may be necessary for this method to
be thread safe.
Parameters: contextID - - the policy context ID indicates whichPolicyConfiguration to return. This must not be null. Parameters: remove - - A boolean flag that establishes whether or not the policystatements of an existing policy context are to be removed before itsPolicyConfiguration object is returned. If the value passed to thisparameter is true, the policy statements of an existing policy contextwill be removed. If the value is false, they will not be removed. a PolicyConfiguration instance throws: PolicyContextException - |
getPolicyConfigurationFactory | public static PolicyConfigurationFactory getPolicyConfigurationFactory() throws ClassNotFoundException, PolicyContextException(Code) | | This static method uses the javax.security.jacc.PolicyConfigurationFactory.provider
system property to create a provider factory implementation. The provider
class must provide a public no-arg ctor.
the PolicyConfigurationFactory singleton throws: SecurityException - - when the caller does not have aSecurityPermission(setPolicy) permission. throws: ClassNotFoundException - - when the class named by the systemproperty could not be found or because the value of the systemproperty is null. throws: PolicyContextException - - if the PolicyConfigurationFactory ctorthrows an exception other than those in the getPolicyConfigurationFactorymethod signature. The exception will be encapsulated in aPolicyContextException as its cause. |
inService | abstract public boolean inService(String contextID) throws PolicyContextException(Code) | | This method determines if the identified policy context exists with state
"inService" in the Policy provider associated with the factory.
Parameters: contextID - - the context ID for selecting the policy true if the identified policy context exists within the providerand its state is "inService", false otherwise. throws: PolicyContextException - |
|
|