File	Doc	Category	Size	Date	Package
AuthConfigFactory.java	API Doc	Glassfish v2 API	25487	Fri May 04 22:36:12 BST 2007	javax.security.auth.message.config

AuthConfigFactory

• java.lang.Object

Fields Summary
private static AuthConfigFactory	factory
public static final String	DEFAULT_FACTORY_SECURITY_PROPERTY The name of the Security property used to define the default AuthConfigFactory implementation class.
private static SecurityPermission	getPerm
private static SecurityPermission	setPerm

Constructors Summary

Methods Summary
private static void	checkPermission(java.security.Permission p) utility method to check for permission to operate on the factory. exception SecurityException if the caller does not have permission to operate on the factory. SecurityManager sm = System.getSecurityManager(); if (sm != null) { sm.checkPermission(p); }
public abstract java.lang.String[]	detachListener(RegistrationListener listener, java.lang.String layer, java.lang.String appContext) Disassociate the listener from all the provider registrations whose layer and appContext values are matched by the corresponding arguments to this method. Factories should periodically notify Listeners to effectively detach listeners that are no longer in use. param listener The RegistrationListener to be detached. param layer A String identifying the message layer or null. param appContext A String value identifying the application contex or null. return An array of String values where each value identifies a provider registration from which the listener was removed. This method never returns null; it returns an empty array if the listener was not removed from any registrations. exception SecurityException If the caller does not have permission to detach the listener from the factory.
public abstract AuthConfigProvider	getConfigProvider(java.lang.String layer, java.lang.String appContext, RegistrationListener listener) Get a registered AuthConfigProvider from the factory. Get the provider of ServerAuthConfig and ClientAuthConfig objects registered for the identified message layer and application context. All factories shall employ the following precedence rules to select the registered AuthConfigProvider that matches the layer and appContext arguments: The provider specifically registered for the values passed as the layer and appContext arguments shall be selected. If no provider is selected according to the preceding rule, the provider specifically registered for the value passed as the appContext argument and for all (that is, null) layers shall be selected. If no provider is selected according to the preceding rules, the provider specifically registered for the value passed as the layer argument and for all (that is, null) appContexts shall be selected. If no provider is selected according to the preceding rules, the provider registered for all (that is, null) layers and for all (that is, null) appContexts shall be selected. If no provider is selected according to the preceding rules, the factory shall terminate its search for a registered provider. The above precedence rules apply equivalently to registrations created with a null or non-null className argument. param layer A String identifying the message layer for which the registered AuthConfigProvider is to be returned. The value of this argument may be null. param appContext A String that identifies the application messaging context for which the registered AuthConfigProvider is to be returned. The value of this argument may be null. param listener The RegistrationListener whose notify method is to be invoked if the corresponding registration is unregistered or replaced. The value of this argument may be null. return The implementation of the AuthConfigProvider interface registered at the factory for the layer and appContext, or null if no AuthConfigProvider is selected. An argument listener is attached even if the return value is null.
public static synchronized javax.security.auth.message.config.AuthConfigFactory	getFactory() Get the system-wide AuthConfigFactory implementation. If a non-null system-wide factory instance is defined at the time of the call, for example, with setFactory, it will be returned. Otherwise, an attempt will be made to construct an instance of the default AuthConfigFactory implementation class. The fully qualified class name of the default factory implementation class is obtained from the value of the authconfigprovider.factory security property. When an instance of the default factory implementation class is successfully constructed by this method, this method will set it as the system-wide factory instance. The absolute pathname of the Java security properties file is JAVA_HOME/lib/security/java.security, where JAVA_HOME refers to the directory where the JDK was installed. return The non-null system-wide AuthConfigFactory instance set at the time of the call, or if that value was null, the value of the system-wide factory instance established by this method. This method returns null when the system-wide factory was not defined when this method was called and no default factory name was defined via the security property. exception AuthException If an error occurred during the class loading, or construction of the default AuthConfigFactory implementation class. exception SecurityException If the caller does not have permission to retrieve the factory, or set it as the system-wide instance. checkPermission(getPerm); if (AuthConfigFactory.factory == null) { final String className = Security.getProperty (DEFAULT_FACTORY_SECURITY_PROPERTY); if (className != null) { checkPermission(setPerm); try { AuthConfigFactory.factory = (AuthConfigFactory) java.security.AccessController.doPrivileged (new java.security.PrivilegedExceptionAction() { public Object run() throws ClassNotFoundException, InstantiationException, IllegalAccessException { ClassLoader loader = Thread.currentThread(). getContextClassLoader(); Class clazz = Class.forName (className,true,loader); return clazz.newInstance(); } }); } catch (java.security.PrivilegedActionException pae) { throw (SecurityException) new SecurityException().initCause(pae.getException()); } } } return AuthConfigFactory.factory;
public abstract javax.security.auth.message.config.AuthConfigFactory$RegistrationContext	getRegistrationContext(java.lang.String registrationID) Get the the registration context for the identified registration. param registrationID A String that identifies a provider registration at the factory return A RegistrationContext or null. When a Non-null value is returned, it is a copy of the registration context corresponding to the registration. Null is returned when the registration identifier does not correpond to an active registration
public abstract java.lang.String[]	getRegistrationIDs(AuthConfigProvider provider) Get the registration identifiers for all registrations of the provider instance at the factory. param provider The AuthConfigurationProvider whose registration identifiers are to be returned. This argument may be null, in which case it indicates that the IDs of all active registrations within the factory are to be returned. return An array of String values where each value identifies a provider registration at the factory. This method never returns null; it returns an empty array when there are no registrations at the factory for the identified provider.
public abstract void	refresh() Cause the factory to reprocess its persisent declarative representation of provider registrations. A factory should only replace an existing registration when a change of provider implementation class or initialization properties has occurred. exception AuthException If an error occured during the reinitialization. exception SecurityException If the caller does not have permission to refresh the factory.
public abstract java.lang.String	registerConfigProvider(java.lang.String className, java.util.Map properties, java.lang.String layer, java.lang.String appContext, java.lang.String description) Registers within the factory and records within the factory's persistent declarative representation of provider registrations a provider of ServerAuthConfig and/or ClientAuthConfig objects for a message layer and application context identifier. This method typically constructs an instance of the provider before registering it with the factory. Factories may extend or modify the persisted registrations of existing provider instances, if those instances were registered with ClassName and properties arguments equivalent to those passed in the current call. This method employs the two argument constructor required to be supported by every implementation of the AuthConfigProvider interface, and this method must pass a null value for the factory argument of the constructor. AuthConfigProviderImpl AuthConfigProviderImpl(Map properties, AuthConfigFactory factory). At most one registration may exist within the factory for a given combination of message layer and appContext. Any pre-existing registration with identical values for layer and appContext is replaced by a subsequent registration. When replacement occurs, the registration identifier, layer, and appContext identifier remain unchanged, and the AuthConfigProvider (with initialization properties) and description are replaced. Within the lifetime of its Java process, a factory must assign unique registration identifiers to registrations, and must never assign a previously used registration identifier to a registration whose message layer and or appContext identifier differ from the previous use. Programmatic registrations performed by using this method must update (according to the replacement rules described above) the persistent declarative representation of provider registrations employed by the factory constructor. param className The fully qualified name of an AuthConfigProvider implementation class (or null). Calling this method with a null value for this parameter shall cause getConfigProvider to return null when it is called with layer and appContext values for which the resulting registration is the best match. param properties A Map object containing the initialization properties to be passed to the properties argument of the provider constructor. This argument may be null. When this argument is not null, all the values and keys occuring in the Map must be of type String. param layer A String identifying the message layer for which the provider will be registered at the factory. A null value may be passed as an argument for this parameter, in which case the provider is registered at all layers. param appContext A String value that may be used by a runtime to request a configuration object from this provider. A null value may be passed as an argument for this parameter, in which case the provider is registered for all configuration ids (at the indicated layers). param description A text String describing the provider. This value may be null. return A String identifier assigned by the factory to the provider registration, and that may be used to remove the registration from the factory. exception SecurityException If the caller does not have permission to register a provider at the factory. exception AuthException If the provider construction (given a non-null className) or registration fails.
public abstract java.lang.String	registerConfigProvider(AuthConfigProvider provider, java.lang.String layer, java.lang.String appContext, java.lang.String description) Registers within the (in-memory) factory, a provider of ServerAuthConfig and/or ClientAuthConfig objects for a message layer and application context identifier. This method does NOT effect the factory's persistent declarative representation of provider registrations, and is intended to be used by providers to perform self-Registration. At most one registration may exist within the factory for a given combination of message layer and appContext. Any pre-existing registration with identical values for layer and appContext is replaced by a subsequent registration. When replacement occurs, the registration identifier, layer, and appContext identifier remain unchanged, and the AuthConfigProvider (with initialization properties) and description are replaced. Within the lifetime of its Java process, a factory must assign unique registration identifiers to registrations, and must never assign a previously used registration identifier to a registration whose message layer and or appContext identifier differ from the previous use. param provider The AuthConfigProvider to be registered at the factory (or null). Calling this method with a null value for this parameter shall cause getConfigProvider to return null when it is called with layer and appContext values for which the resulting registration is the best match. param layer A String identifying the message layer for which the provider will be registered at the factory. A null value may be passed as an argument for this parameter, in which case the provider is registered at all layers. param appContext A String value that may be used by a runtime to request a configuration object from this provider. A null value may be passed as an argument for this parameter, in which case the provider is registered for all configuration ids (at the indicated layers). param description A text String describing the provider. This value may be null. return A String identifier assigned by the factory to the provider registration, and that may be used to remove the registration from the factory. exception SecurityException If the caller does not have permission to register a provider at the factory. exception AuthException If the provider registration fails.
public abstract boolean	removeRegistration(java.lang.String registrationID) Remove the identified provider registration from the factory (and from the persistent declarative representation of provider registrations, if appropriate) and invoke any listeners associated with the removed registration. param registrationID A String that identifies a provider registration at the factory return True if there was a registration with the specified identifier and it was removed. Return false if the registrationID was invalid. exception SecurityException If the caller does not have permission to unregister the provider at the factory.
public static synchronized void	setFactory(javax.security.auth.message.config.AuthConfigFactory factory) Set the system-wide AuthConfigFactory implementation. If an implementation was set previously, it will be replaced. Listeners are not notified of a change to the registered factory. param factory The AuthConfigFactory instance, which may be null. exception SecurityException If the caller does not have permission to set the factory. checkPermission(setPerm); AuthConfigFactory.factory = factory;