Index (JASPIC 3.1 API Documentation - Apache Tomcat 11.0.23)

# Index

A C D F G I J M N P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## A

AliasRequest(String) - Constructor for class jakarta.security.auth.message.callback.PrivateKeyCallback.AliasRequest
  Creates a new `AliasRequest` with the specified keystore alias.
AliasRequest(String) - Constructor for class jakarta.security.auth.message.callback.SecretKeyCallback.AliasRequest
  Constructs an AliasRequest with the specified alias.
AuthConfig - Interface in jakarta.security.auth.message.config
  Provides configuration information for a JASPIC authentication mechanism.
AuthConfigFactory - Class in jakarta.security.auth.message.config
  Factory for obtaining and managing `AuthConfigProvider` instances.
AuthConfigFactory() - Constructor for class jakarta.security.auth.message.config.AuthConfigFactory
  Protected constructor for subclasses.
AuthConfigFactory.RegistrationContext - Interface in jakarta.security.auth.message.config
  Provides information about a registered `AuthConfigProvider`.
AuthConfigProvider - Interface in jakarta.security.auth.message.config
  Provides `ClientAuthConfig` and `ServerAuthConfig` instances to JASPIC authentication modules.
AUTHENTICATE_CONTENT - Static variable in interface jakarta.security.auth.message.MessagePolicy.ProtectionPolicy
  Identifier for a policy that requires authentication of the message content.
AUTHENTICATE_RECIPIENT - Static variable in interface jakarta.security.auth.message.MessagePolicy.ProtectionPolicy
  Identifier for a policy that requires authentication of the recipient.
AUTHENTICATE_SENDER - Static variable in interface jakarta.security.auth.message.MessagePolicy.ProtectionPolicy
  Identifier for a policy that requires authentication of the sender.
AuthException - Exception Class in jakarta.security.auth.message
  Exception thrown when a JASPIC authentication operation fails.
AuthException() - Constructor for exception class jakarta.security.auth.message.AuthException
  Constructs an AuthException with no detail message.
AuthException(String) - Constructor for exception class jakarta.security.auth.message.AuthException
  Constructs an AuthException with the specified detail message.
AuthException(String, Throwable) - Constructor for exception class jakarta.security.auth.message.AuthException
  Construct an instance of AuthException.
AuthException(Throwable) - Constructor for exception class jakarta.security.auth.message.AuthException
  Construct an instance of AuthException.
AuthStatus - Class in jakarta.security.auth.message
  Represents the status returned by JASPIC authentication operations.

## C

CallerPrincipalCallback - Class in jakarta.security.auth.message.callback
  Callback that enables an authentication module to inform the runtime of the caller principal or name of the caller principal.
CallerPrincipalCallback(Subject, String) - Constructor for class jakarta.security.auth.message.callback.CallerPrincipalCallback
  Constructs a callback with a Subject and a caller name.
CallerPrincipalCallback(Subject, Principal) - Constructor for class jakarta.security.auth.message.callback.CallerPrincipalCallback
  Constructs a callback with a Subject and a Principal.
CertStoreCallback - Class in jakarta.security.auth.message.callback
  Callback that enables a runtime to inform authentication modules of the `CertStore` to use for certificate validation.
CertStoreCallback() - Constructor for class jakarta.security.auth.message.callback.CertStoreCallback
  Constructs an empty CertStoreCallback.
cleanSubject(MessageInfo, Subject) - Method in interface jakarta.security.auth.message.ClientAuth
  Remove principals and/or credentials from the subject that were previously added by this authentication mechanism.
cleanSubject(MessageInfo, Subject) - Method in interface jakarta.security.auth.message.ServerAuth
  Remove principals and/or credentials from the subject that were previously added by this authentication mechanism.
clearPassword() - Method in class jakarta.security.auth.message.callback.PasswordValidationCallback
  Clears the password from memory for security purposes.
ClientAuth - Interface in jakarta.security.auth.message
  Defines the contract for client-side authentication in JASPIC.
ClientAuthConfig - Interface in jakarta.security.auth.message.config
  Client-side authentication configuration obtained from an `AuthConfigProvider`.
ClientAuthContext - Interface in jakarta.security.auth.message.config
  Runtime context for client-side JASPIC authentication.
ClientAuthModule - Interface in jakarta.security.auth.message.module
  A pluggable client-side authentication module in JASPIC.

## D

DEFAULT_FACTORY_SECURITY_PROPERTY - Static variable in class jakarta.security.auth.message.config.AuthConfigFactory
  The name of the `Security` property used to specify the AuthConfigFactory implementation class.
detachListener(RegistrationListener, String, String) - Method in class jakarta.security.auth.message.config.AuthConfigFactory
  Detaches a listener from all registrations matching the given layer and application context, returning the affected registration IDs.
DigestRequest(byte[], String) - Constructor for class jakarta.security.auth.message.callback.PrivateKeyCallback.DigestRequest
  Creates a new `DigestRequest` with the specified digest value and digest algorithm.

## F

FAILURE - Static variable in class jakarta.security.auth.message.AuthStatus
  Authentication failed and no further message exchange will change the outcome.

## G

get(MessageInfo) - Method in interface jakarta.security.auth.message.MessagePolicy.Target
  Retrieves the target value from the given message.
getAlgorithm() - Method in class jakarta.security.auth.message.callback.PrivateKeyCallback.DigestRequest
  Returns the digest algorithm used for this request.
getAlias() - Method in class jakarta.security.auth.message.callback.PrivateKeyCallback.AliasRequest
  Returns the keystore alias for this request.
getAlias() - Method in class jakarta.security.auth.message.callback.SecretKeyCallback.AliasRequest
  Returns the alias of the requested secret key.
getAppContext() - Method in interface jakarta.security.auth.message.config.AuthConfig
  Returns the application context for which this configuration applies.
getAppContext() - Method in interface jakarta.security.auth.message.config.AuthConfigFactory.RegistrationContext
  Returns the application context for this registration.
getAuthContext(String, Subject, Map) - Method in interface jakarta.security.auth.message.config.ClientAuthConfig
  Creates a `ClientAuthContext` for the specified authentication context ID.
getAuthContext(String, Subject, Map) - Method in interface jakarta.security.auth.message.config.ServerAuthConfig
  Returns the `ServerAuthContext` for the given authentication context ID.
getAuthContextID(MessageInfo) - Method in interface jakarta.security.auth.message.config.AuthConfig
  Determines the authentication context ID for the given message.
getCertStore() - Method in class jakarta.security.auth.message.callback.CertStoreCallback
  Returns the CertStore set by the runtime.
getChain() - Method in class jakarta.security.auth.message.callback.PrivateKeyCallback
  Returns the certificate chain resolved by the runtime.
getClientAuthConfig(String, String, CallbackHandler) - Method in interface jakarta.security.auth.message.config.AuthConfigProvider
  Returns the client-side authentication configuration for the specified layer and application context.
getConfigProvider(String, String, RegistrationListener) - Method in class jakarta.security.auth.message.config.AuthConfigFactory
  Returns the `AuthConfigProvider` for the specified message layer and application context.
getDescription() - Method in interface jakarta.security.auth.message.config.AuthConfigFactory.RegistrationContext
  Returns the description of this registration.
getDigest() - Method in class jakarta.security.auth.message.callback.PrivateKeyCallback.DigestRequest
  Returns the digest value for this request.
getFactory() - Static method in class jakarta.security.auth.message.config.AuthConfigFactory
  Returns the singleton AuthConfigFactory instance.
getGroups() - Method in class jakarta.security.auth.message.callback.GroupPrincipalCallback
  Returns the group names associated with this callback.
getID() - Method in interface jakarta.security.auth.message.MessagePolicy.ProtectionPolicy
  Returns the unique identifier for this protection policy.
getIssuer() - Method in class jakarta.security.auth.message.callback.PrivateKeyCallback.IssuerSerialNumRequest
  Returns the issuer distinguished name for this request.
getKey() - Method in class jakarta.security.auth.message.callback.PrivateKeyCallback
  Returns the private key resolved by the runtime.
getKey() - Method in class jakarta.security.auth.message.callback.SecretKeyCallback
  Returns the secret key.
getMap() - Method in interface jakarta.security.auth.message.MessageInfo
  Returns a map of additional context information associated with this authentication exchange.
getMessageLayer() - Method in interface jakarta.security.auth.message.config.AuthConfig
  Returns the message layer for which this configuration applies.
getMessageLayer() - Method in interface jakarta.security.auth.message.config.AuthConfigFactory.RegistrationContext
  Returns the message layer for this registration.
getName() - Method in class jakarta.security.auth.message.callback.CallerPrincipalCallback
  Returns the name associated with this callback, or `null` if a Principal was provided instead.
getPassword() - Method in class jakarta.security.auth.message.callback.PasswordValidationCallback
  Returns the password to be validated.
getPrincipal() - Method in class jakarta.security.auth.message.callback.CallerPrincipalCallback
  Returns the Principal associated with this callback, or `null` if a name was provided instead.
getProtectionPolicy() - Method in class jakarta.security.auth.message.MessagePolicy.TargetPolicy
  Returns the protection policy associated with this target policy.
getRegistrationContext(String) - Method in class jakarta.security.auth.message.config.AuthConfigFactory
  Returns the `AuthConfigFactory.RegistrationContext` for the given registration ID.
getRegistrationIDs(AuthConfigProvider) - Method in class jakarta.security.auth.message.config.AuthConfigFactory
  Returns the registration IDs associated with the given AuthConfigProvider.
getRequest() - Method in class jakarta.security.auth.message.callback.PrivateKeyCallback
  Returns the request associated with this callback.
getRequest() - Method in class jakarta.security.auth.message.callback.SecretKeyCallback
  Returns the request associated with this callback.
getRequestMessage() - Method in interface jakarta.security.auth.message.MessageInfo
  Returns the request message object associated with this authentication exchange.
getResponseMessage() - Method in interface jakarta.security.auth.message.MessageInfo
  Returns the response message object associated with this authentication exchange.
getResult() - Method in class jakarta.security.auth.message.callback.PasswordValidationCallback
  Returns the result of the password validation.
getSerialNum() - Method in class jakarta.security.auth.message.callback.PrivateKeyCallback.IssuerSerialNumRequest
  Returns the certificate serial number for this request.
getServerAuthConfig(String, String, CallbackHandler) - Method in interface jakarta.security.auth.message.config.AuthConfigProvider
  Returns the server-side authentication configuration for the specified layer and application context.
getSubject() - Method in class jakarta.security.auth.message.callback.CallerPrincipalCallback
  Returns the Subject associated with this callback.
getSubject() - Method in class jakarta.security.auth.message.callback.GroupPrincipalCallback
  Returns the Subject associated with this callback.
getSubject() - Method in class jakarta.security.auth.message.callback.PasswordValidationCallback
  Returns the `Subject` associated with this callback.
getSubjectKeyID() - Method in class jakarta.security.auth.message.callback.PrivateKeyCallback.SubjectKeyIDRequest
  Returns the subject key identifier for this request.
getSupportedMessageTypes() - Method in interface jakarta.security.auth.message.module.ClientAuthModule
  Returns the array of MessageInfo implementation classes supported by this module.
getSupportedMessageTypes() - Method in interface jakarta.security.auth.message.module.ServerAuthModule
  Returns the array of message types supported by the module.
getTargetPolicies() - Method in class jakarta.security.auth.message.MessagePolicy
  Returns the target policies associated with this message policy.
getTargets() - Method in class jakarta.security.auth.message.MessagePolicy.TargetPolicy
  Returns the targets associated with this target policy.
getTrustStore() - Method in class jakarta.security.auth.message.callback.TrustStoreCallback
  Returns the trust store.
getUsername() - Method in class jakarta.security.auth.message.callback.PasswordValidationCallback
  Returns the username to be validated.
GroupPrincipalCallback - Class in jakarta.security.auth.message.callback
  Callback that enables an authentication module to inform the runtime of the groups a user is in.
GroupPrincipalCallback(Subject, String[]) - Constructor for class jakarta.security.auth.message.callback.GroupPrincipalCallback
  Constructs a callback with a Subject and an array of group names.

## I

initialize(MessagePolicy, MessagePolicy, CallbackHandler, Map) - Method in interface jakarta.security.auth.message.module.ClientAuthModule
  Initializes the authentication module with the given policies, callback handler, and options.
initialize(MessagePolicy, MessagePolicy, CallbackHandler, Map) - Method in interface jakarta.security.auth.message.module.ServerAuthModule
  Initialize the authentication module.
isMandatory() - Method in class jakarta.security.auth.message.MessagePolicy
  Indicates whether this policy is mandatory.
isPersistent() - Method in interface jakarta.security.auth.message.config.AuthConfigFactory.RegistrationContext
  Indicates whether this registration persists beyond the current container lifecycle.
isProtected() - Method in interface jakarta.security.auth.message.config.AuthConfig
  Indicates whether the authentication mechanism is protected, meaning that the configuration data is stored securely.
IssuerSerialNumRequest(X500Principal, BigInteger) - Constructor for class jakarta.security.auth.message.callback.PrivateKeyCallback.IssuerSerialNumRequest
  Creates a new `IssuerSerialNumRequest` with the specified issuer and serial number.

## J

jakarta.security.auth.message - package jakarta.security.auth.message
jakarta.security.auth.message.callback - package jakarta.security.auth.message.callback
jakarta.security.auth.message.config - package jakarta.security.auth.message.config
jakarta.security.auth.message.module - package jakarta.security.auth.message.module

## M

MessageInfo - Interface in jakarta.security.auth.message
  Represents the request and response messages associated with a message-based authentication exchange.
MessagePolicy - Class in jakarta.security.auth.message
  Defines the security policy requirements for a message-based authentication module.
MessagePolicy(MessagePolicy.TargetPolicy[], boolean) - Constructor for class jakarta.security.auth.message.MessagePolicy
  Creates a new `MessagePolicy` with the specified target policies and mandatory flag.
MessagePolicy.ProtectionPolicy - Interface in jakarta.security.auth.message
  Defines the level of protection to be applied to a message.
MessagePolicy.Target - Interface in jakarta.security.auth.message
  Defines how to extract target information from a message for policy evaluation.
MessagePolicy.TargetPolicy - Class in jakarta.security.auth.message
  Associates a set of targets with a protection policy.

## N

notify(String, String) - Method in interface jakarta.security.auth.message.config.RegistrationListener
  Notifies the listener of a registration event.

## P

PasswordValidationCallback - Class in jakarta.security.auth.message.callback
  A callback that enables an authentication module to supply a username and password to the runtime and obtain the result of password validation.
PasswordValidationCallback(Subject, String, char[]) - Constructor for class jakarta.security.auth.message.callback.PasswordValidationCallback
  Creates a new `PasswordValidationCallback` with the specified subject, username, and password.
PrivateKeyCallback - Class in jakarta.security.auth.message.callback
  A callback that enables an authentication module to request a certificate chain and private key from the runtime.
PrivateKeyCallback(PrivateKeyCallback.Request) - Constructor for class jakarta.security.auth.message.callback.PrivateKeyCallback
  Creates a new `PrivateKeyCallback` with the specified request.
PrivateKeyCallback.AliasRequest - Class in jakarta.security.auth.message.callback
  A request to retrieve a certificate chain and private key by keystore alias.
PrivateKeyCallback.DigestRequest - Class in jakarta.security.auth.message.callback
  A request to retrieve a certificate chain and private key by certificate digest value.
PrivateKeyCallback.IssuerSerialNumRequest - Class in jakarta.security.auth.message.callback
  A request to retrieve a certificate chain and private key by the issuer distinguished name and certificate serial number.
PrivateKeyCallback.Request - Interface in jakarta.security.auth.message.callback
  Base interface for private key requests.
PrivateKeyCallback.SubjectKeyIDRequest - Class in jakarta.security.auth.message.callback
  A request to retrieve a certificate chain and private key by the Subject Key Identifier extension value.
put(MessageInfo, Object) - Method in interface jakarta.security.auth.message.MessagePolicy.Target
  Stores the target value in the given message.

## R

refresh() - Method in interface jakarta.security.auth.message.config.AuthConfig
  Refreshes the configuration, reloading any changed settings.
refresh() - Method in class jakarta.security.auth.message.config.AuthConfigFactory
  Refreshes all registered AuthConfigProviders, causing them to reload their configuration.
refresh() - Method in interface jakarta.security.auth.message.config.AuthConfigProvider
  Refreshes the configuration, reloading any changed settings from the underlying source.
registerConfigProvider(AuthConfigProvider, String, String, String) - Method in class jakarta.security.auth.message.config.AuthConfigFactory
  Registers an AuthConfigProvider instance.
registerConfigProvider(String, Map, String, String, String) - Method in class jakarta.security.auth.message.config.AuthConfigFactory
  Registers an AuthConfigProvider by class name with the given properties.
registerServerAuthModule(ServerAuthModule, Object) - Method in class jakarta.security.auth.message.config.AuthConfigFactory
  Convenience method for registering a `ServerAuthModule` that should have the same effect as calling `AuthConfigFactory.registerConfigProvider(AuthConfigProvider, String, String, String)` with the implementation providing the appropriate `AuthConfigProvider` generated from the provided context.
RegistrationListener - Interface in jakarta.security.auth.message.config
  Listener interface for JASPIC registration events.
remove(MessageInfo) - Method in interface jakarta.security.auth.message.MessagePolicy.Target
  Removes the target value from the given message.
removeRegistration(String) - Method in class jakarta.security.auth.message.config.AuthConfigFactory
  Removes a registration by its ID.
removeServerAuthModule(Object) - Method in class jakarta.security.auth.message.config.AuthConfigFactory
  Convenience method for deregistering a `ServerAuthModule` that should have the same effect as calling `AuthConfigFactory.removeRegistration(String)`.

## S

SecretKeyCallback - Class in jakarta.security.auth.message.callback
  A callback enabling an authentication module to request a secret key from the runtime, by supplying an alias.
SecretKeyCallback(SecretKeyCallback.Request) - Constructor for class jakarta.security.auth.message.callback.SecretKeyCallback
  Constructs a SecretKeyCallback with the specified request.
SecretKeyCallback.AliasRequest - Class in jakarta.security.auth.message.callback
  A request for a secret key identified by its alias.
SecretKeyCallback.Request - Interface in jakarta.security.auth.message.callback
  Represents a request for a secret key.
secureRequest(MessageInfo, Subject) - Method in interface jakarta.security.auth.message.ClientAuth
  Secure (authenticate) the request.
secureResponse(MessageInfo, Subject) - Method in interface jakarta.security.auth.message.ServerAuth
  Secure (authenticate) the response.
SEND_CONTINUE - Static variable in class jakarta.security.auth.message.AuthStatus
  Authentication is in progress and further message exchange is required.
SEND_FAILURE - Static variable in class jakarta.security.auth.message.AuthStatus
  Authentication failed and the failure response should be sent to the peer.
SEND_SUCCESS - Static variable in class jakarta.security.auth.message.AuthStatus
  Authentication succeeded and the response should be sent to the peer.
ServerAuth - Interface in jakarta.security.auth.message
  Provides server-side authentication of requests and response signing.
ServerAuthConfig - Interface in jakarta.security.auth.message.config
  Server-side authentication configuration obtained from an `AuthConfigProvider`.
ServerAuthContext - Interface in jakarta.security.auth.message.config
  Provides server-side authentication of requests and response signing.
ServerAuthModule - Interface in jakarta.security.auth.message.module
  Provides server-side authentication of requests and response signing.
setCertStore(CertStore) - Method in class jakarta.security.auth.message.callback.CertStoreCallback
  Sets the CertStore to be used for certificate validation.
setFactory(AuthConfigFactory) - Static method in class jakarta.security.auth.message.config.AuthConfigFactory
  Programmatically sets the AuthConfigFactory instance.
setKey(PrivateKey, Certificate[]) - Method in class jakarta.security.auth.message.callback.PrivateKeyCallback
  Sets the private key and certificate chain resolved by the runtime in response to the request.
setKey(SecretKey) - Method in class jakarta.security.auth.message.callback.SecretKeyCallback
  Sets the secret key obtained by the runtime.
setRequestMessage(Object) - Method in interface jakarta.security.auth.message.MessageInfo
  Sets the request message object for this authentication exchange.
setResponseMessage(Object) - Method in interface jakarta.security.auth.message.MessageInfo
  Sets the response message object for this authentication exchange.
setResult(boolean) - Method in class jakarta.security.auth.message.callback.PasswordValidationCallback
  Sets the result of the password validation performed by the runtime.
setTrustStore(KeyStore) - Method in class jakarta.security.auth.message.callback.TrustStoreCallback
  Sets the trust store to be used for certificate validation.
SubjectKeyIDRequest(byte[]) - Constructor for class jakarta.security.auth.message.callback.PrivateKeyCallback.SubjectKeyIDRequest
  Creates a new `SubjectKeyIDRequest` with the specified subject key identifier.
SUCCESS - Static variable in class jakarta.security.auth.message.AuthStatus
  Authentication succeeded and no further message exchange is required.

## T

TargetPolicy(MessagePolicy.Target[], MessagePolicy.ProtectionPolicy) - Constructor for class jakarta.security.auth.message.MessagePolicy.TargetPolicy
  Creates a new `TargetPolicy` with the specified targets and protection policy.
toString() - Method in class jakarta.security.auth.message.AuthStatus
TrustStoreCallback - Class in jakarta.security.auth.message.callback
  A Callback enabling an authentication module to request a truststore from the runtime.
TrustStoreCallback() - Constructor for class jakarta.security.auth.message.callback.TrustStoreCallback
  Constructs a new TrustStoreCallback.

## V

validateRequest(MessageInfo, Subject, Subject) - Method in interface jakarta.security.auth.message.ServerAuth
  Validate the request.
validateResponse(MessageInfo, Subject, Subject) - Method in interface jakarta.security.auth.message.ClientAuth
  Validate a response.

A C D F G I J M N P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form