Class JaspiAuthConfigProvider

java.lang.Object

org.eclipse.jetty.ee9.security.jaspi.provider.JaspiAuthConfigProvider

All Implemented Interfaces:

jakarta.security.auth.message.config.AuthConfigProvider

public class JaspiAuthConfigProvider
extends Object
implements jakarta.security.auth.message.config.AuthConfigProvider

A Jetty implementation of the AuthConfigProvider to allow registration of a ServerAuthModule directly without having to write a custom AuthConfigProvider.

If this is being constructed by an AuthConfigFactory after being passed in as a className, then you will need to provide the property ServerAuthModule containing the fully qualified name of the ServerAuthModule class you wish to use.

Constructor Summary

Constructors

Constructor	Description
JaspiAuthConfigProvider(jakarta.security.auth.message.module.ServerAuthModule serverAuthModule)
JaspiAuthConfigProvider(jakarta.security.auth.message.module.ServerAuthModule serverAuthModule, Map properties)
JaspiAuthConfigProvider(String className)
JaspiAuthConfigProvider(String className, Map properties)
JaspiAuthConfigProvider(Map properties, jakarta.security.auth.message.config.AuthConfigFactory factory)	Constructor with signature and implementation that's required by API.

Method Summary

Modifier and Type	Method	Description
jakarta.security.auth.message.config.ClientAuthConfig	getClientAuthConfig(String layer, String appContext, CallbackHandler handler)
jakarta.security.auth.message.config.ServerAuthConfig	getServerAuthConfig(String layer, String appContext, CallbackHandler handler)
void	refresh()

Methods inherited from class Object

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

Constructor Details

JaspiAuthConfigProvider

public JaspiAuthConfigProvider(Map properties,
 jakarta.security.auth.message.config.AuthConfigFactory factory)

Constructor with signature and implementation that's required by API.

The property map must contain the ServerAuthModule property containing the fully qualified name of the ServerAuthModule class you wish to use. If this constructor is being used for self-registration an optional property of appContext can be used specify the appContext value to register the provider.

Parameters:

properties - A Map of initialization properties.

factory - The AuthConfigFactory to register on.

JaspiAuthConfigProvider

public JaspiAuthConfigProvider(String className)

Parameters:

className - The fully qualified name of a ServerAuthModule class.

JaspiAuthConfigProvider

public JaspiAuthConfigProvider(String className,
 Map properties)

Parameters:

className - The fully qualified name of a ServerAuthModule class.

properties - A Map of initialization properties.

JaspiAuthConfigProvider

public JaspiAuthConfigProvider(jakarta.security.auth.message.module.ServerAuthModule serverAuthModule)

Parameters:

serverAuthModule - The instance of ServerAuthModule to use.

JaspiAuthConfigProvider

public JaspiAuthConfigProvider(jakarta.security.auth.message.module.ServerAuthModule serverAuthModule,
 Map properties)

Parameters:

serverAuthModule - The instance of ServerAuthModule to use.

properties - A Map of initialization properties.

Method Details

getClientAuthConfig

public jakarta.security.auth.message.config.ClientAuthConfig getClientAuthConfig(String layer,
 String appContext,
 CallbackHandler handler)

Specified by:

getClientAuthConfig in interface jakarta.security.auth.message.config.AuthConfigProvider

getServerAuthConfig

public jakarta.security.auth.message.config.ServerAuthConfig getServerAuthConfig(String layer,
 String appContext,
 CallbackHandler handler)

Specified by:

getServerAuthConfig in interface jakarta.security.auth.message.config.AuthConfigProvider

refresh

public void refresh()

Specified by:

refresh in interface jakarta.security.auth.message.config.AuthConfigProvider