|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.security.auth.message.config.AuthConfigFactory
com.sun.xml.wss.provider.wsit.JMACAuthConfigFactory
public class JMACAuthConfigFactory
This class implements methods in the abstract class AuthConfigFactory.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.security.auth.message.config.AuthConfigFactory |
---|
javax.security.auth.message.config.AuthConfigFactory.RegistrationContext |
Field Summary |
---|
Fields inherited from class javax.security.auth.message.config.AuthConfigFactory |
---|
DEFAULT_FACTORY_SECURITY_PROPERTY |
Constructor Summary | |
---|---|
JMACAuthConfigFactory(java.lang.ClassLoader loader)
|
Method Summary | |
---|---|
java.lang.String[] |
detachListener(javax.security.auth.message.config.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. |
javax.security.auth.message.config.AuthConfigProvider |
getConfigProvider(java.lang.String layer,
java.lang.String appContext,
javax.security.auth.message.config.RegistrationListener listener)
Get a registered AuthConfigProvider from the factory. |
javax.security.auth.message.config.AuthConfigFactory.RegistrationContext |
getRegistrationContext(java.lang.String registrationID)
Get the the registration context for the identified registration. |
java.lang.String[] |
getRegistrationIDs(javax.security.auth.message.config.AuthConfigProvider provider)
Get the registration identifiers for all registrations of the provider instance at the factory. |
static java.net.URL |
loadFromClasspath(java.lang.String configFileName)
|
void |
refresh()
Cause the factory to reprocess its persisent declarative representation of provider registrations. |
java.lang.String |
registerConfigProvider(javax.security.auth.message.config.AuthConfigProvider provider,
java.lang.String layer,
java.lang.String appContext,
java.lang.String description)
|
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, a provider of ServerAuthConfig and/or ClientAuthConfig objects for a message layer and application context identifier. |
boolean |
removeRegistration(java.lang.String registrationID)
Remove the identified provider registration from the factory and invoke any listeners associated with the removed registration. |
Methods inherited from class javax.security.auth.message.config.AuthConfigFactory |
---|
getFactory, setFactory |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JMACAuthConfigFactory(java.lang.ClassLoader loader)
Method Detail |
---|
public javax.security.auth.message.config.AuthConfigProvider getConfigProvider(java.lang.String layer, java.lang.String appContext, javax.security.auth.message.config.RegistrationListener listener)
getConfigProvider
in class javax.security.auth.message.config.AuthConfigFactory
layer
- a String identifying the message layer
for which the registered AuthConfigProvider is
to be returned. This argument may be null.appContext
- a String that identifys the application messaging
context for which the registered AuthConfigProvider
is to be returned. This argument may be null.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.
All factories shall employ the following precedence rules to select the registered AuthConfigProvider that matches the layer and appContext arguments:
public java.lang.String registerConfigProvider(java.lang.String className, java.util.Map properties, java.lang.String layer, java.lang.String appContext, java.lang.String description)
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 via this method must update (according to the replacement rules described above), the persistent declarative representation of provider registrations employed by the factory constructor.
registerConfigProvider
in class javax.security.auth.message.config.AuthConfigFactory
className
- the fully qualified name of an AuthConfigProvider
implementation class. This argument must not be null.properties
- a Map object containing the initialization
properties to be passed to 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.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.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).description
- a text String descripting the provider.
this value may be null.
java.lang.SecurityException
- if the caller does not have
permission to register a provider at the factory.
AuthException
- if the provider
construction or registration fails.public java.lang.String registerConfigProvider(javax.security.auth.message.config.AuthConfigProvider provider, java.lang.String layer, java.lang.String appContext, java.lang.String description)
registerConfigProvider
in class javax.security.auth.message.config.AuthConfigFactory
public boolean removeRegistration(java.lang.String registrationID)
removeRegistration
in class javax.security.auth.message.config.AuthConfigFactory
registrationID
- a String that identifies a provider registration
at the factory
java.lang.SecurityException
- if the caller does not have
permission to unregister the provider at the factory.public java.lang.String[] detachListener(javax.security.auth.message.config.RegistrationListener listener, java.lang.String layer, java.lang.String appContext)
detachListener
in class javax.security.auth.message.config.AuthConfigFactory
listener
- the RegistrationListener to be detached.layer
- a String identifying the message layer or null.appContext
- a String value identifying the application contex
or null.
java.lang.SecurityException
- if the caller does not have
permission to detach the listener from the factory.public java.lang.String[] getRegistrationIDs(javax.security.auth.message.config.AuthConfigProvider provider)
getRegistrationIDs
in class javax.security.auth.message.config.AuthConfigFactory
provider
- the AuthConfigurationProvider whose registration
identifiers are to be returned. This argument may be
null, in which case, it indicates that the the id's of
all active registration within the factory are returned.
public javax.security.auth.message.config.AuthConfigFactory.RegistrationContext getRegistrationContext(java.lang.String registrationID)
getRegistrationContext
in class javax.security.auth.message.config.AuthConfigFactory
registrationID
- a String that identifies a provider registration
at the factory
public void refresh()
A factory should only replace an existing registration when a change of provider implementation class or initialization properties has occured. re
refresh
in class javax.security.auth.message.config.AuthConfigFactory
AuthException
- if an error occured during the
reinitialization.
java.lang.SecurityException
- if the caller does not have permission
to refresh the factory.public static java.net.URL loadFromClasspath(java.lang.String configFileName)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |