A C D F G I J M N P R S T V

A

AliasRequest(String) - Constructor for class javax.security.auth.message.callback.PrivateKeyCallback.AliasRequest

Construct an AliasRequest with an alias.

AliasRequest(String) - Constructor for class javax.security.auth.message.callback.SecretKeyCallback.AliasRequest

Construct an AliasRequest with an alias.

AuthConfig - Interface in javax.security.auth.message.config

This interface defines the common functionality implemented by Authentication context configuration objects.

AuthConfigFactory - Class in javax.security.auth.message.config

This class is used to obtain AuthConfigProvider objects that can be used to obtain authentication context configuration objects, that is, ClientAuthConfig and ServerAuthConfig objects.

AuthConfigFactory() - Constructor for class javax.security.auth.message.config.AuthConfigFactory

AuthConfigFactory.RegistrationContext - Interface in javax.security.auth.message.config

Represents the layer identifier, application context identifier, and description components of an AuthConfigProvider registration at the factory.

AuthConfigProvider - Interface in javax.security.auth.message.config

This interface is implemented by objects that can be used to obtain authentication context configuration objects, that is, ClientAuthConfig or ServerAuthConfig objects.

AUTHENTICATE_CONTENT - Static variable in interface javax.security.auth.message.MessagePolicy.ProtectionPolicy

The identifier for a ProtectionPolicy that indicates that the origin of data within the message is to be authenticated (that is, the message is to be protected such that its recipients can establish who defined the message content).

AUTHENTICATE_RECIPIENT - Static variable in interface javax.security.auth.message.MessagePolicy.ProtectionPolicy

The identifier for a ProtectionPolicy that indicates that the message recipient is to be authenticated.

AUTHENTICATE_SENDER - Static variable in interface javax.security.auth.message.MessagePolicy.ProtectionPolicy

The identifier for a ProtectionPolicy that indicates that the sending entity is to be authenticated.

AuthException - Exception in javax.security.auth.message

A generic authentication exception.

AuthException() - Constructor for exception javax.security.auth.message.AuthException

Constructs an AuthException with no detail message.

AuthException(String) - Constructor for exception javax.security.auth.message.AuthException

Constructs an AuthException with the specified detail message.

AuthStatus - Class in javax.security.auth.message

The AuthStatus class is used to represent return values from Authentication modules and Authentication Contexts.

C

CallerPrincipalCallback - Class in javax.security.auth.message.callback

Callback for setting the container's caller (or remote user) principal.

CallerPrincipalCallback(Subject, Principal) - Constructor for class javax.security.auth.message.callback.CallerPrincipalCallback

Create a CallerPrincipalCallback to set the container's representation of the caller principal

CallerPrincipalCallback(Subject, String) - Constructor for class javax.security.auth.message.callback.CallerPrincipalCallback

Create a CallerPrincipalCallback to set the container's representation of the caller principal.

CertStoreCallback - Class in javax.security.auth.message.callback

Callback for CertStore.

CertStoreCallback() - Constructor for class javax.security.auth.message.callback.CertStoreCallback

cleanSubject(MessageInfo, Subject) - Method in interface javax.security.auth.message.ClientAuth

Remove implementation specific principals and credentials from the subject.

cleanSubject(MessageInfo, Subject) - Method in interface javax.security.auth.message.ServerAuth

Remove method specific principals and credentials from the subject.

clearPassword() - Method in class javax.security.auth.message.callback.PasswordValidationCallback

Clear the password.

ClientAuth - Interface in javax.security.auth.message

An implementation of this interface is used to secure service request messages, and validate received service response messages.

ClientAuthConfig - Interface in javax.security.auth.message.config

This interface encapsulates the configuration of ClientAuthContext objects for a message layer and application context (for example, the messaging context of a specific application, or set of applications).

ClientAuthContext - Interface in javax.security.auth.message.config

This ClientAuthContext class encapsulates ClientAuthModules that are used to secure service requests made by a client, and to validate any responses received to those requests.

ClientAuthModule - Interface in javax.security.auth.message.module

A ClientAuthModule secures request messages, and validates received response messages.

D

DEFAULT_FACTORY_SECURITY_PROPERTY - Static variable in class javax.security.auth.message.config.AuthConfigFactory

The name of the Security property used to define the default AuthConfigFactory implementation class.

detachListener(RegistrationListener, String, String) - Method in class javax.security.auth.message.config.AuthConfigFactory

Disassociate the listener from all the provider registrations whose layer and appContext values are matched by the corresponding arguments to this method.

DigestRequest(byte[], String) - Constructor for class javax.security.auth.message.callback.PrivateKeyCallback.DigestRequest

Constructs a DigestRequest with a digest value and algorithm identifier.

F

FAILURE - Static variable in class javax.security.auth.message.AuthStatus

Indicates that the message processing by the authentication module was NOT successful, and that the module replaced the application message with an error message.

G

get(MessageInfo) - Method in interface javax.security.auth.message.MessagePolicy.Target

Get the Object identified by the Target from the MessageInfo.

GET_FACTORY_PERMISSION_NAME - Static variable in class javax.security.auth.message.config.AuthConfigFactory

The name of the SecurityPermission required to call getFactory

getAlgorithm() - Method in class javax.security.auth.message.callback.PrivateKeyCallback.DigestRequest

Get the algorithm identifier.

getAlias() - Method in class javax.security.auth.message.callback.PrivateKeyCallback.AliasRequest

Get the alias.

getAlias() - Method in class javax.security.auth.message.callback.SecretKeyCallback.AliasRequest

Get the alias.

getAppContext() - Method in interface javax.security.auth.message.config.AuthConfig

Get the application context identifier of this authentication context configuration object.

getAppContext() - Method in interface javax.security.auth.message.config.AuthConfigFactory.RegistrationContext

Get the application context identifier from the registration context

getAuthContext(String, Subject, Map) - Method in interface javax.security.auth.message.config.ClientAuthConfig

Get a ClientAuthContext instance from this ClientAuthConfig.

getAuthContext(String, Subject, Map) - Method in interface javax.security.auth.message.config.ServerAuthConfig

Get a ServerAuthContext instance from this ServerAuthConfig.

getAuthContextID(MessageInfo) - Method in interface javax.security.auth.message.config.AuthConfig

Get the authentication context identifier corresponding to the request and response objects encapsulated in messageInfo.

getCertStore() - Method in class javax.security.auth.message.callback.CertStoreCallback

Used by the CertStore user to obtain the CertStore set within the Callback.

getChain() - Method in class javax.security.auth.message.callback.PrivateKeyCallback

Used to obtain the certificate chain set within the Callback.

getClientAuthConfig(String, String, CallbackHandler) - Method in interface javax.security.auth.message.config.AuthConfigProvider

Get an instance of ClientAuthConfig from this provider.

getConfigProvider(String, String, RegistrationListener) - Method in class javax.security.auth.message.config.AuthConfigFactory

Get a registered AuthConfigProvider from the factory.

getDescription() - Method in interface javax.security.auth.message.config.AuthConfigFactory.RegistrationContext

Get the description from the registration context

getDigest() - Method in class javax.security.auth.message.callback.PrivateKeyCallback.DigestRequest

Get the digest value.

getFactory() - Static method in class javax.security.auth.message.config.AuthConfigFactory

Get the system-wide AuthConfigFactory implementation.

getFactorySecurityPermission - Static variable in class javax.security.auth.message.config.AuthConfigFactory

The SecurityPermission, with name AuthConfigFactory.GET_FACTORY_PERMISSION_NAME, that is used to authorize access to the getFactory method.

getGroups() - Method in class javax.security.auth.message.callback.GroupPrincipalCallback

Get the array of group names.

getID() - Method in interface javax.security.auth.message.MessagePolicy.ProtectionPolicy

Get the ProtectionPolicy identifier.

getIssuer() - Method in class javax.security.auth.message.callback.PrivateKeyCallback.IssuerSerialNumRequest

Get the issuer.

getKey() - Method in class javax.security.auth.message.callback.PrivateKeyCallback

Used to obtain the private key set within the Callback.

getKey() - Method in class javax.security.auth.message.callback.SecretKeyCallback

Used to obtain the secret key set within the Callback.

getMap() - Method in interface javax.security.auth.message.MessageInfo

Get (a reference to) the Map object of this MessageInfo.

getMessageLayer() - Method in interface javax.security.auth.message.config.AuthConfig

Get the message layer name of this authentication context configuration object.

getMessageLayer() - Method in interface javax.security.auth.message.config.AuthConfigFactory.RegistrationContext

Get the layer name from the registration context

getName() - Method in class javax.security.auth.message.callback.CallerPrincipalCallback

Get the caller principal name.

getPassword() - Method in class javax.security.auth.message.callback.PasswordValidationCallback

Get the password.

getPrincipal() - Method in class javax.security.auth.message.callback.CallerPrincipalCallback

Get the caller principal.

getProtectionPolicy() - Method in class javax.security.auth.message.MessagePolicy.TargetPolicy

Get the ProtectionPolicy that applies to the targets.

getRegistrationContext(String) - Method in class javax.security.auth.message.config.AuthConfigFactory

Get the the registration context for the identified registration.

getRegistrationIDs(AuthConfigProvider) - Method in class javax.security.auth.message.config.AuthConfigFactory

Get the registration identifiers for all registrations of the provider instance at the factory.

getRequest() - Method in class javax.security.auth.message.callback.PrivateKeyCallback

Used by the CallbackHandler to get the Request object that identifies the private key to be returned.

getRequest() - Method in class javax.security.auth.message.callback.SecretKeyCallback

Used by the CallbackHandler to get the Request object which identifies the secret key to be returned.

getRequestMessage() - Method in interface javax.security.auth.message.MessageInfo

Get the request message object from this MessageInfo.

getResponseMessage() - Method in interface javax.security.auth.message.MessageInfo

Get the response message object from this MessageInfo.

getResult() - Method in class javax.security.auth.message.callback.PasswordValidationCallback

Get the authentication result.

getSerialNum() - Method in class javax.security.auth.message.callback.PrivateKeyCallback.IssuerSerialNumRequest

Get the serial number.

getServerAuthConfig(String, String, CallbackHandler) - Method in interface javax.security.auth.message.config.AuthConfigProvider

Get an instance of ServerAuthConfig from this provider.

getSubject() - Method in class javax.security.auth.message.callback.CallerPrincipalCallback

Get the Subject in which the handler will distinguish the caller principal

getSubject() - Method in class javax.security.auth.message.callback.GroupPrincipalCallback

Get the Subject in which the handler will establish the group principals.

getSubject() - Method in class javax.security.auth.message.callback.PasswordValidationCallback

Get the subject.

getSubjectKeyID() - Method in class javax.security.auth.message.callback.PrivateKeyCallback.SubjectKeyIDRequest

Get the subjectKeyID.

getSupportedMessageTypes() - Method in interface javax.security.auth.message.module.ClientAuthModule

Get the one or more Class objects representing the message types supported by the module.

getSupportedMessageTypes() - Method in interface javax.security.auth.message.module.ServerAuthModule

Get the one or more Class objects representing the message types supported by the module.

getTargetPolicies() - Method in class javax.security.auth.message.MessagePolicy

Get the target policies that comprise the authentication policy.

getTargets() - Method in class javax.security.auth.message.MessagePolicy.TargetPolicy

Get the array of layer-specific target descriptors that identify the one or more message parts to which the specified message protection policy applies.

getTrustStore() - Method in class javax.security.auth.message.callback.TrustStoreCallback

Used by the TrustStore user to obtain the TrustStore set within the Callback.

getUsername() - Method in class javax.security.auth.message.callback.PasswordValidationCallback

Get the username.

GroupPrincipalCallback - Class in javax.security.auth.message.callback

Callback establishing group principals within the argument subject.

GroupPrincipalCallback(Subject, String[]) - Constructor for class javax.security.auth.message.callback.GroupPrincipalCallback

Create a GroupPrincipalCallback to establish the container's representation of the corresponding group principals within the Subject.

I

initialize(MessagePolicy, MessagePolicy, CallbackHandler, Map) - Method in interface javax.security.auth.message.module.ClientAuthModule

Initialize this module with request and response message policies to enforce, a CallbackHandler, and any module-specific configuration properties.

initialize(MessagePolicy, MessagePolicy, CallbackHandler, Map) - Method in interface javax.security.auth.message.module.ServerAuthModule

Initialize this module with request and response message policies to enforce, a CallbackHandler, and any module-specific configuration properties.

isMandatory() - Method in class javax.security.auth.message.MessagePolicy

Get the MessagePolicy modifier.

isPersistent() - Method in interface javax.security.auth.message.config.AuthConfigFactory.RegistrationContext

Get the persisted status from the registration context.

isProtected() - Method in interface javax.security.auth.message.config.AuthConfig

Used to determine whether the authentication context configuration object encapsulates any protected authentication contexts.

IssuerSerialNumRequest(X500Principal, BigInteger) - Constructor for class javax.security.auth.message.callback.PrivateKeyCallback.IssuerSerialNumRequest

Constructs a IssuerSerialNumRequest with an issuer/serial number.

J

javax.security.auth.message - package javax.security.auth.message

This package defines the core interfaces of Jakarta Authentication.

javax.security.auth.message.callback - package javax.security.auth.message.callback

This package defines callback interfaces that may be used by a pluggable authentication mechanisms (aka message authentication modules) to interact with the container (aka message processing runtime) that invoked the module.

javax.security.auth.message.config - package javax.security.auth.message.config

This package defines the interfaces implemented by Jakarta Authentication compatible configuration systems.

javax.security.auth.message.module - package javax.security.auth.message.module

This package defines the interfaces implemented by Jakarta Authentication compatible authentication mechanisms.

M

MessageInfo - Interface in javax.security.auth.message

A container (message processing runtime) uses this interface to pass messages and message processing state to authentication contexts for processing by authentication mechanisms (modules).

MessagePolicy - Class in javax.security.auth.message

This class defines a message authentication policy.

MessagePolicy(MessagePolicy.TargetPolicy[], boolean) - Constructor for class javax.security.auth.message.MessagePolicy

Create a MessagePolicy instance with an array of target policies.

MessagePolicy.ProtectionPolicy - Interface in javax.security.auth.message

This interface is used to represent message authentication policy.

MessagePolicy.Target - Interface in javax.security.auth.message

This interface is used to represent and perform message targeting.

MessagePolicy.TargetPolicy - Class in javax.security.auth.message

This class defines the message protection policies for specific Targets.

N

notify(String, String) - Method in interface javax.security.auth.message.config.RegistrationListener

Notify the listener that a registration with which it was associated was replaced or unregistered.

P

PasswordValidationCallback - Class in javax.security.auth.message.callback

Callback for PasswordValidation.

PasswordValidationCallback(Subject, String, char[]) - Constructor for class javax.security.auth.message.callback.PasswordValidationCallback

Create a PasswordValidationCallback.

PrivateKeyCallback - Class in javax.security.auth.message.callback

Callback for acquiring a Public Key Infrastructure (PKI) private key and its corresponding certificate chain.

PrivateKeyCallback(PrivateKeyCallback.Request) - Constructor for class javax.security.auth.message.callback.PrivateKeyCallback

Constructs this PrivateKeyCallback with a private key Request object.

PrivateKeyCallback.AliasRequest - Class in javax.security.auth.message.callback

Request type for private keys that are identified using an alias.

PrivateKeyCallback.DigestRequest - Class in javax.security.auth.message.callback

Request type for private keys that are identified using a certificate digest or thumbprint.

PrivateKeyCallback.IssuerSerialNumRequest - Class in javax.security.auth.message.callback

Request type for private keys that are identified using an issuer/serial number.

PrivateKeyCallback.Request - Interface in javax.security.auth.message.callback

Marker interface for private key request types.

PrivateKeyCallback.SubjectKeyIDRequest - Class in javax.security.auth.message.callback

Request type for private keys that are identified using a SubjectKeyID

PROVIDER_REGISTRATION_PERMISSION_NAME - Static variable in class javax.security.auth.message.config.AuthConfigFactory

The name of the SecurityPermission to be used to authorize access to the update methods of the factory implementation class.

providerRegistrationSecurityPermission - Static variable in class javax.security.auth.message.config.AuthConfigFactory

An instance of the SecurityPermission (with name AuthConfigFactory.PROVIDER_REGISTRATION_PERMISSION_NAME) for use in authorizing access to the update methods of the factory implementation class.

put(MessageInfo, Object) - Method in interface javax.security.auth.message.MessagePolicy.Target

Put the Object into the MessageInfo at the location identified by the target.

R

refresh() - Method in interface javax.security.auth.message.config.AuthConfig

Causes a dynamic authentication context configuration object to update the internal state that it uses to process calls to its getAuthContext method.

refresh() - Method in class javax.security.auth.message.config.AuthConfigFactory

Cause the factory to reprocess its persistent declarative representation of provider registrations.

refresh() - Method in interface javax.security.auth.message.config.AuthConfigProvider

Causes a dynamic configuration provider to update its internal state such that any resulting change to its state is reflected in the corresponding authentication context configuration objects previously created by the provider within the current process context.

registerConfigProvider(String, Map, String, String, String) - Method in class javax.security.auth.message.config.AuthConfigFactory

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.

registerConfigProvider(AuthConfigProvider, String, String, String) - Method in class javax.security.auth.message.config.AuthConfigFactory

Registers within the (in-memory) factory, a provider of ServerAuthConfig and/or ClientAuthConfig objects for a message layer and application context identifier.

RegistrationListener - Interface in javax.security.auth.message.config

An implementation of this interface may be associated with an AuthConfigProvider registration at an AuthConfigFactory at the time the AuthConfigProvider is obtained for use from the factory.

remove(MessageInfo) - Method in interface javax.security.auth.message.MessagePolicy.Target

Remove the Object identified by the Target from the MessageInfo.

removeRegistration(String) - Method in class javax.security.auth.message.config.AuthConfigFactory

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.

S

SecretKeyCallback - Class in javax.security.auth.message.callback

Callback for acquiring a shared secret from a key repository.

SecretKeyCallback(SecretKeyCallback.Request) - Constructor for class javax.security.auth.message.callback.SecretKeyCallback

Constructs this SecretKeyCallback with a secret key Request object.

SecretKeyCallback.AliasRequest - Class in javax.security.auth.message.callback

Request type for secret keys that are identified using an alias.

SecretKeyCallback.Request - Interface in javax.security.auth.message.callback

Marker interface for secret key request types.

secureRequest(MessageInfo, Subject) - Method in interface javax.security.auth.message.ClientAuth

Secure a service request message before sending it to the service.

secureResponse(MessageInfo, Subject) - Method in interface javax.security.auth.message.ServerAuth

Secure a service response before sending it to the client.

SEND_CONTINUE - Static variable in class javax.security.auth.message.AuthStatus

Indicates the message processing by the authentication module is NOT complete, that the module replaced the application message with a security message, and that the runtime is to proceed by sending the security message.

SEND_FAILURE - Static variable in class javax.security.auth.message.AuthStatus

Indicates that the message processing by the authentication module was NOT successful, that the module replaced the application message with an error message, and that the runtime is to proceed by sending the error message.

SEND_SUCCESS - Static variable in class javax.security.auth.message.AuthStatus

Indicates that the message processing by the authentication module was successful and that the runtime is to proceed by sending a message returned by the authentication module.

ServerAuth - Interface in javax.security.auth.message

An implementation of this interface is used to validate received service request messages, and to secure service response messages.

ServerAuthConfig - Interface in javax.security.auth.message.config

This interface describes a configuration of ServerAuthConfiguration objects for a message layer and application context (for example, the messaging context of a specific application, or set of applications).

ServerAuthContext - Interface in javax.security.auth.message.config

This ServerAuthContext class encapsulates ServerAuthModules that are used to validate service requests received from clients, and to secure any response returned for those requests.

ServerAuthModule - Interface in javax.security.auth.message.module

A ServerAuthModule validates client requests and secures responses to the client.

SET_FACTORY_PERMISSION_NAME - Static variable in class javax.security.auth.message.config.AuthConfigFactory

The name of the SecurityPermission required to call setFactory

setCertStore(CertStore) - Method in class javax.security.auth.message.callback.CertStoreCallback

Used by the CallbackHandler to set the CertStore within the Callback.

setFactory(AuthConfigFactory) - Static method in class javax.security.auth.message.config.AuthConfigFactory

Set the system-wide AuthConfigFactory implementation.

setFactorySecurityPermission - Static variable in class javax.security.auth.message.config.AuthConfigFactory

The SecurityPermission, with name AuthConfigFactory.SET_FACTORY_PERMISSION_NAME, that is used to authorize access to the setFactory method.

setKey(PrivateKey, Certificate[]) - Method in class javax.security.auth.message.callback.PrivateKeyCallback

Used by the CallbackHandler to set the requested private key and the corresponding certificate chain within the Callback.

setKey(SecretKey) - Method in class javax.security.auth.message.callback.SecretKeyCallback

Used by the CallbackHandler to set the requested secret key within the Callback.

setRequestMessage(Object) - Method in interface javax.security.auth.message.MessageInfo

Set the request message object in this MessageInfo.

setResponseMessage(Object) - Method in interface javax.security.auth.message.MessageInfo

Set the response message object in this MessageInfo.

setResult(boolean) - Method in class javax.security.auth.message.callback.PasswordValidationCallback

Set the authentication result.

setTrustStore(KeyStore) - Method in class javax.security.auth.message.callback.TrustStoreCallback

Used by the CallbackHandler to set the trusted certificate keystore within the Callback.

SubjectKeyIDRequest(byte[]) - Constructor for class javax.security.auth.message.callback.PrivateKeyCallback.SubjectKeyIDRequest

Construct a SubjectKeyIDRequest with an subjectKeyID.

SUCCESS - Static variable in class javax.security.auth.message.AuthStatus

Indicates that the message processing by the authentication module was successful and that the runtime is to proceed with its normal processing of the resulting message.

T

TargetPolicy(MessagePolicy.Target[], MessagePolicy.ProtectionPolicy) - Constructor for class javax.security.auth.message.MessagePolicy.TargetPolicy

Create a TargetPolicy instance with an array of Targets and with a ProtectionPolicy.

toString() - Method in class javax.security.auth.message.AuthStatus

TrustStoreCallback - Class in javax.security.auth.message.callback

Callback for trusted certificate KeyStore.

TrustStoreCallback() - Constructor for class javax.security.auth.message.callback.TrustStoreCallback

V

validateRequest(MessageInfo, Subject, Subject) - Method in interface javax.security.auth.message.ServerAuth

Authenticate a received service request.

validateResponse(MessageInfo, Subject, Subject) - Method in interface javax.security.auth.message.ClientAuth

Validate a received service response.

A C D F G I J M N P R S T V