PolicyConfigurationFactory (JBoss J2EE API) - JBoss 4.0.1 sp1 j2ee API Documentation 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.security.jacc
Class PolicyConfigurationFactory

java.lang.Object
  javax.security.jacc.PolicyConfigurationFactory

public abstract class PolicyConfigurationFactory
extends Object

Version:: $Revision: 1.4 $
Author:: Scott.Stark@jboss.org, Ron Monzillo, Gary Ellison (javadoc)

Constructor Summary

PolicyConfigurationFactory()


Method Summary

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 the javax.security.jacc.PolicyConfigurationFactory.provider system property to create a provider factory implementation.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PolicyConfigurationFactory

public PolicyConfigurationFactory()

Method Detail

getPolicyConfigurationFactory

public static PolicyConfigurationFactory getPolicyConfigurationFactory()
                                                                throws ClassNotFoundException,
                                                                       PolicyContextException

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.

Returns:: the PolicyConfigurationFactory singleton
Throws:: SecurityException - - when the caller does not have a SecurityPermission(setPolicy) permission.; ClassNotFoundException - - when the class named by the system property could not be found or because the value of the system property is null.; PolicyContextException - - if the PolicyConfigurationFactory ctor throws an exception other than those in the getPolicyConfigurationFactory method signature. The exception will be encapsulated in a PolicyContextException as its cause.

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.

Parameters:: contextID - - the policy context ID indicates which PolicyConfiguration to return. This must not be null.; remove - - A boolean flag 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.
Returns:: a PolicyConfiguration instance
Throws:: 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.

Parameters:: contextID - - the context ID for selecting the policy
Returns:: true if the identified policy context exists within the provider and its state is "inService", false otherwise.
Throws:: PolicyContextException