Top Inners Fields Constructors Methods
jakarta.security.auth.message.config

public abstract Class AuthConfigFactory

extends Object
Class Inheritance
Known Direct Subclasses
org.apache.catalina.authenticator.jaspic.AuthConfigFactoryImpl
Imports
java.security.AccessController, .Permission, .PrivilegedAction, .PrivilegedActionException, .PrivilegedExceptionAction, .Security, .SecurityPermission, java.util.Map, jakarta.security.auth.message.module.ServerAuthModule

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
AuthConfigFactory.RegistrationContext

Field Summary

Modifier and TypeField and Description
public static final String
DEFAULT_FACTORY_SECURITY_PROPERTY

private static final String
DEFAULT_JASPI_AUTHCONFIGFACTORYIMPL

private static volatile AuthConfigFactory
factory

public static final String
GET_FACTORY_PERMISSION_NAME

public static final SecurityPermission
getFactorySecurityPermission

Deprecated for removal. Following JEP 411
public static final String
PROVIDER_REGISTRATION_PERMISSION_NAME

public static final SecurityPermission
providerRegistrationSecurityPermission

Deprecated for removal. Following JEP 411
public static final String
SET_FACTORY_PERMISSION_NAME

public static final SecurityPermission
setFactorySecurityPermission

Deprecated for removal. Following JEP 411

Constructor Summary

AccessConstructor and Description
public
AuthConfigFactory()

Method Summary

Modifier and TypeMethod and Description
private static void
checkPermission(Permission permission)
Deprecated for removal. Following JEP 411

public abstract String[]
detachListener(RegistrationListener listener, String layer, String appContext)

public abstract AuthConfigProvider
getConfigProvider(String layer, String appContext, RegistrationListener listener)

public static AuthConfigFactory
getFactory()

private static String
getFactoryClassName()

public abstract AuthConfigFactory.RegistrationContext
getRegistrationContext(String registrationID)

public abstract String[]
getRegistrationIDs(AuthConfigProvider provider)

public abstract void
refresh()

public abstract String
registerConfigProvider(String className, Map<String, String> properties, String layer, String appContext, String description)

public abstract String
registerConfigProvider(AuthConfigProvider provider, String layer, String appContext, String description)

public abstract String

Returns:

A string identifier for the created registration
registerServerAuthModule(ServerAuthModule
The ServerAuthModule to register
serverAuthModule, Object
The associated application context
context)

Convenience method for registering a ServerAuthModule that should have the same effect as calling registerConfigProvider(AuthConfigProvider, String, String, String) with the implementation providing the appropriate AuthConfigProvider generated from the provided context.

public abstract boolean
removeRegistration(String registrationID)

public abstract void
removeServerAuthModule(Object
The associated application context
context)

Convenience method for deregistering a ServerAuthModule that should have the same effect as calling AuthConfigFactory#removeRegistration(String).

public static synchronized void
setFactory(AuthConfigFactory factory)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULT_FACTORY_SECURITY_PROPERTYback to summary
public static final String DEFAULT_FACTORY_SECURITY_PROPERTY
DEFAULT_JASPI_AUTHCONFIGFACTORYIMPLback to summary
private static final String DEFAULT_JASPI_AUTHCONFIGFACTORYIMPL
factoryback to summary
private static volatile AuthConfigFactory factory
GET_FACTORY_PERMISSION_NAMEback to summary
public static final String GET_FACTORY_PERMISSION_NAME
getFactorySecurityPermissionback to summary
public static final SecurityPermission getFactorySecurityPermission

Deprecated

for removal.

Following JEP 411

Annotations
@Deprecated
forRemoval:true
PROVIDER_REGISTRATION_PERMISSION_NAMEback to summary
public static final String PROVIDER_REGISTRATION_PERMISSION_NAME
providerRegistrationSecurityPermissionback to summary
public static final SecurityPermission providerRegistrationSecurityPermission

Deprecated

for removal.

Following JEP 411

Annotations
@Deprecated
forRemoval:true
SET_FACTORY_PERMISSION_NAMEback to summary
public static final String SET_FACTORY_PERMISSION_NAME
setFactorySecurityPermissionback to summary
public static final SecurityPermission setFactorySecurityPermission

Deprecated

for removal.

Following JEP 411

Annotations
@Deprecated
forRemoval:true

Constructor Detail

AuthConfigFactoryback to summary
public AuthConfigFactory()

Method Detail

checkPermissionback to summary
private static void checkPermission(Permission permission)

Deprecated

for removal.

Following JEP 411

Annotations
@Deprecated
forRemoval:true
detachListenerback to summary
public abstract String[] detachListener(RegistrationListener listener, String layer, String appContext)
getConfigProviderback to summary
public abstract AuthConfigProvider getConfigProvider(String layer, String appContext, RegistrationListener listener)
getFactoryback to summary
public static AuthConfigFactory getFactory()
getFactoryClassNameback to summary
private static String getFactoryClassName()
getRegistrationContextback to summary
public abstract AuthConfigFactory.RegistrationContext getRegistrationContext(String registrationID)
getRegistrationIDsback to summary
public abstract String[] getRegistrationIDs(AuthConfigProvider provider)
refreshback to summary
public abstract void refresh()
registerConfigProviderback to summary
public abstract String registerConfigProvider(String className, Map<String, String> properties, String layer, String appContext, String description)
registerConfigProviderback to summary
public abstract String registerConfigProvider(AuthConfigProvider provider, String layer, String appContext, String description)
registerServerAuthModuleback to summary
public abstract String registerServerAuthModule(ServerAuthModule serverAuthModule, Object context)

Convenience method for registering a ServerAuthModule that should have the same effect as calling registerConfigProvider(AuthConfigProvider, String, String, String) with the implementation providing the appropriate AuthConfigProvider generated from the provided context.

Parameters
serverAuthModule:ServerAuthModule

The ServerAuthModule to register

context:Object

The associated application context

Returns:String

A string identifier for the created registration

Since
Authentication 3.0
removeRegistrationback to summary
public abstract boolean removeRegistration(String registrationID)
removeServerAuthModuleback to summary
public abstract void removeServerAuthModule(Object context)

Convenience method for deregistering a ServerAuthModule that should have the same effect as calling AuthConfigFactory#removeRegistration(String).

Parameters
context:Object

The associated application context

Since
Authentication 3.0
setFactoryback to summary
public static synchronized void setFactory(AuthConfigFactory factory)
jakarta.security.auth.message.config back to summary

public Interface AuthConfigFactory.RegistrationContext

Known Direct Implementers
org.apache.catalina.authenticator.jaspic.AuthConfigFactoryImpl.RegistrationContextImpl

Method Summary

Modifier and TypeMethod and Description
public String
getAppContext()

public String
getDescription()

public String
getMessageLayer()

public boolean
isPersistent()

Method Detail

getAppContextback to summary
public String getAppContext()
getDescriptionback to summary
public String getDescription()
getMessageLayerback to summary
public String getMessageLayer()
isPersistentback to summary
public boolean isPersistent()