javax.security.jacc
Class PolicyConfigurationFactory
java.lang.Object
javax.security.jacc.PolicyConfigurationFactory
public abstract class PolicyConfigurationFactory
extends java.lang.Object
Abstract factory and finder class for obtaining the instance of the class
that implements the PolicyConfigurationFactory of a provider. The factory
will be used to instantiate PolicyConfiguration objects that will be used
by the deployment tools of the container to create and manage policy
contexts within the Policy Provider.
Implementation classes must have a public no argument constructor that may
be used to create an operational instance of the factory implementation class.
abstract 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.
|
static PolicyConfigurationFactory | getPolicyConfigurationFactory() - This static method uses a system property to find and instantiate (via a
public constructor) a provider specific factory implementation class.
|
abstract 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
public abstract PolicyConfiguration getPolicyConfiguration(String contextID,
boolean remove)
throws PolicyContextException
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.
contextID
- A String identifying the policy context whose
PolicyConfiguration interface is to be returned. The value passed to
this parameter must not be null.remove
- A boolean value that establishes whether or not the policy
statements of an existing policy context are to be removed before its
PolicyConfiguration object is returned. If the value passed to this
parameter is true, the policy statements of an existing policy context
will be removed. If the value is false, they will not be removed.
- an Object that implements the PolicyConfiguration Interface
matched to the Policy provider and corresponding to the identified
policy context.
PolicyContextException
- if the implementation throws a checked
exception that has not been accounted for by the getPolicyConfiguration
method signature. The exception thrown by the implementation class will
be encapsulated (during construction) in the thrown PolicyContextException.
getPolicyConfigurationFactory
public static PolicyConfigurationFactory getPolicyConfigurationFactory()
throws ClassNotFoundException,
PolicyContextException
This static method uses a system property to find and instantiate (via a
public constructor) a provider specific factory implementation class.
The name of the provider specific factory implementation class is
obtained from the value of the system property,
javax.security.jacc.PolicyConfigurationFactory.provider
.
- the singleton instance of the provider specific
PolicyConfigurationFactory implementation class.
PolicyContextException
- if the implementation throws a checked
exception that has not been accounted for by the
getPolicyConfigurationFactory method signature. The exception thrown by
the implementation class will be encapsulated (during construction) in
the thrown PolicyContextException
inService
public abstract boolean inService(String contextID)
throws PolicyContextException
This method determines if the identified policy context exists with
state "inService" in the Policy provider associated with the factory.
contextID
- A string identifying a policy context
- true if the identified policy context exists within the provider
and its state is "inService", false otherwise.
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.