| ID |
Return |
Method/Field |
Description |
Required |
Deprecated |
Testable |
| JASPIC:JAVADOC:1 |
AuthException |
jakarta.security.auth.message.AuthException.AuthException
|
Constructs an AuthException with no detail
message. A detail message is a String that describes this particular exception. |
true |
|
true |
| JASPIC:JAVADOC:2 |
AuthException |
jakarta.security.auth.message.AuthException.AuthException
( String )
|
Constructs an AuthException with the
specified detail message. A detail message is a String that describes this particular exception. |
true |
|
true |
| JASPIC:JAVADOC:3 |
void |
jakarta.security.auth.message.ClientAuth.cleanSubject
( MessageInfo ,
Subject )
|
Remove implementation specific principals and
credentials from the subject. |
true |
|
true |
| JASPIC:JAVADOC:4 |
void |
jakarta.security.auth.message.ClientAuth.cleanSubject
( MessageInfo ,
Subject )
throws AuthException
|
If an error occurs during the Subject
processing. |
true |
|
true |
| JASPIC:JAVADOC:5 |
AuthStatus |
jakarta.security.auth.message.ClientAuth.secureRequest
( MessageInfo ,
Subject )
|
Secure a service request message before
sending it to the service. This method is called to transform the request message acquired by
calling getRequestMessage (on messageInfo) into the mechanism-specific form to be sent by the
runtime. This method conveys the outcome of its message processing either by returning an AuthStatus
value or by throwing an AuthException. |
true |
|
true |
| JASPIC:JAVADOC:6 |
AuthStatus |
jakarta.security.auth.message.ClientAuth.secureRequest
( MessageInfo ,
Subject )
throws AuthException
|
When the message processing failed without
establishing a failure response message (in messageInfo). |
true |
|
true |
| JASPIC:JAVADOC:7 |
AuthStatus |
jakarta.security.auth.message.ClientAuth.validateResponse
( MessageInfo ,
Subject ,
Subject )
|
Validate a received service response. This
method is called to transform the mechanism-specific response message acquired by calling
getResponseMessage (on messageInfo) into the validated application message to be returned to the
message processing runtime. If the response message is a (mechanism-specific) meta-message, the
method implementation must attempt to transform the meta-message into the next mechanism-specific
request message to be sent by the runtime. This method conveys the outcome of its message processing
either by returning an AuthStatus value or by throwing an AuthException. |
true |
|
true |
| JASPIC:JAVADOC:8 |
AuthStatus |
jakarta.security.auth.message.ClientAuth.validateResponse
( MessageInfo ,
Subject ,
Subject )
throws AuthException
|
When the message processing failed without
establishing a failure response message (in messageInfo). |
true |
|
true |
| JASPIC:JAVADOC:9 |
Map |
jakarta.security.auth.message.MessageInfo.getMap
|
Get (a reference to) the Map object of this
MessageInfo. Operations performed on the acquired Map must effect the Map within the MessageInfo. |
true |
|
true |
| JASPIC:JAVADOC:10 |
Object |
jakarta.security.auth.message.MessageInfo.getRequestMessage
|
Get the request message object from this
MessageInfo. |
true |
|
true |
| JASPIC:JAVADOC:11 |
Object |
jakarta.security.auth.message.MessageInfo.getResponseMessage
|
Get the response message object from this
MessageInfo. |
true |
|
true |
| JASPIC:JAVADOC:12 |
void |
jakarta.security.auth.message.MessageInfo.setRequestMessage
( Object )
|
Set the request message object in this
MessageInfo. |
true |
|
true |
| JASPIC:JAVADOC:13 |
void |
jakarta.security.auth.message.MessageInfo.setResponseMessage
( Object )
|
Set the response message object in this
MessageInfo. |
true |
|
true |
| JASPIC:JAVADOC:14 |
TargetPolicy[] |
jakarta.security.auth.message.MessagePolicy.getTargetPolicies
|
Get the target policies that comprise the
authentication policy. |
true |
|
true |
| JASPIC:JAVADOC:15 |
boolean |
jakarta.security.auth.message.MessagePolicy.isMandatory
|
Get the MessagePolicy modifier. |
true |
|
true |
| JASPIC:JAVADOC:16 |
MessagePolicy |
jakarta.security.auth.message.MessagePolicy.MessagePolicy
( TargetPolicy[] ,
boolean )
|
Create a MessagePolicy instance with an array
of target policies. |
true |
|
true |
| JASPIC:JAVADOC:17 |
String |
jakarta.security.auth.message.MessagePolicy.ProtectionPolicy.getID
|
Get the ProtectionPolicy identifier. An
identifier may represent a conceptual protection policy (as is the case with the static identifiers
defined within this interface) or it may identify a procedural policy expression or plan that may be
more difficult to categorize in terms of a conceptual identifier. |
true |
|
true |
| JASPIC:JAVADOC:18 |
Object |
jakarta.security.auth.message.MessagePolicy.Target.get
( MessageInfo )
|
Get the Object identified by the Target from
the MessageInfo. |
true |
|
true |
| JASPIC:JAVADOC:19 |
void |
jakarta.security.auth.message.MessagePolicy.Target.put
( MessageInfo ,
Object )
|
Put the Object into the MessageInfo at the
location identified by the target. |
true |
|
true |
| JASPIC:JAVADOC:20 |
void |
jakarta.security.auth.message.MessagePolicy.Target.remove
( MessageInfo )
|
Remove the Object identified by the Target
from the MessageInfo. |
true |
|
true |
| JASPIC:JAVADOC:21 |
ProtectionPolicy |
jakarta.security.auth.message.MessagePolicy.TargetPolicy.getProtectionPolicy
|
Get the ProtectionPolicy that applies to the
targets. |
true |
|
true |
| JASPIC:JAVADOC:22 |
Target[] |
jakarta.security.auth.message.MessagePolicy.TargetPolicy.getTargets
|
Get the array of layer-specific target
descriptors that identify the one or more message parts to which the specified message protection
policy applies. |
true |
|
true |
| JASPIC:JAVADOC:23 |
TargetPolicy |
jakarta.security.auth.message.MessagePolicy.TargetPolicy.MessagePolicy.TargetPolicy
( Target[] ,
ProtectionPolicy )
|
Create a TargetPolicy instance with an array
of Targets and with a ProtectionPolicy. |
true |
|
true |
| JASPIC:JAVADOC:24 |
void |
jakarta.security.auth.message.ServerAuth.cleanSubject
( MessageInfo ,
Subject )
|
Remove method specific principals and
credentials from the subject. |
true |
|
true |
| JASPIC:JAVADOC:25 |
void |
jakarta.security.auth.message.ServerAuth.cleanSubject
( MessageInfo ,
Subject )
throws AuthException
|
If an error occurs during the Subject
processing. |
true |
|
true |
| JASPIC:JAVADOC:26 |
AuthStatus |
jakarta.security.auth.message.ServerAuth.secureResponse
( MessageInfo ,
Subject )
|
Secure a service response before sending it
to the client. This method is called to transform the response message acquired by calling
getResponseMessage (on messageInfo) into the mechanism-specific form to be sent by the runtime. This
method conveys the outcome of its message processing either by returning an AuthStatus value or by
throwing an AuthException. |
true |
|
true |
| JASPIC:JAVADOC:27 |
AuthStatus |
jakarta.security.auth.message.ServerAuth.secureResponse
( MessageInfo ,
Subject )
throws AuthException
|
When the message processing failed without
establishing a failure response message (in messageInfo). |
true |
|
true |
| JASPIC:JAVADOC:28 |
AuthStatus |
jakarta.security.auth.message.ServerAuth.validateRequest
( MessageInfo ,
Subject ,
Subject )
|
Authenticate a received service request. This
method is called to transform the mechanism-specific request message acquired by calling
getRequestMessage (on messageInfo) into the validated application message to be returned to the
message processing runtime. If the received message is a (mechanism-specific) meta-message, the
method implementation must attempt to transform the meta-message into a corresponding
mechanism-specific response message, or to the validated application request message. The runtime
will bind a validated application message into the the corresponding service invocation. This method
conveys the outcome of its message processing either by returning an AuthStatus value or by throwing
an AuthException. |
true |
|
true |
| JASPIC:JAVADOC:29 |
AuthStatus |
jakarta.security.auth.message.ServerAuth.validateRequest
( MessageInfo ,
Subject ,
Subject )
throws AuthException
|
When the message processing failed without
establishing a failure response message (in messageInfo). |
true |
|
true |
| JASPIC:JAVADOC:30 |
CallerPrincipalCallback |
jakarta.security.auth.message.callback.CallerPrincipalCallback.CallerPrincipalCallback
( Subject ,
Principal )
|
Create a CallerPrincipalCallback to set the
container's representation of the caller principal |
true |
|
true |
| JASPIC:JAVADOC:31 |
CallerPrincipalCallback |
jakarta.security.auth.message.callback.CallerPrincipalCallback.CallerPrincipalCallback
( Subject ,
String )
|
Create a CallerPrincipalCallback to set the
container's representation of the caller principal. |
true |
|
true |
| JASPIC:JAVADOC:32 |
String |
jakarta.security.auth.message.callback.CallerPrincipalCallback.getName
|
Get the caller principal name. |
true |
|
true |
| JASPIC:JAVADOC:33 |
Principal |
jakarta.security.auth.message.callback.CallerPrincipalCallback.getPrincipal
|
Get the caller principal. |
true |
|
true |
| JASPIC:JAVADOC:34 |
Subject |
jakarta.security.auth.message.callback.CallerPrincipalCallback.getSubject
|
Get the Subject in which the handler will
distinguish the caller principal |
true |
|
true |
| JASPIC:JAVADOC:35 |
CertStoreCallback |
jakarta.security.auth.message.callback.CertStoreCallback.CertStoreCallback
|
Create a CertStoreCallback. |
true |
|
true |
| JASPIC:JAVADOC:36 |
CertStore |
jakarta.security.auth.message.callback.CertStoreCallback.getCertStore
|
Used by the CertStore user to obtain the
CertStore set within the Callback. |
true |
|
true |
| JASPIC:JAVADOC:37 |
void |
jakarta.security.auth.message.callback.CertStoreCallback.setCertStore
( CertStore )
|
Used by the CallbackHandler to set the
CertStore within the Callback. |
true |
|
true |
| JASPIC:JAVADOC:38 |
String[] |
jakarta.security.auth.message.callback.GroupPrincipalCallback.getGroups
|
Get the array of group names. |
true |
|
true |
| JASPIC:JAVADOC:39 |
Subject |
jakarta.security.auth.message.callback.GroupPrincipalCallback.getSubject
|
Get the Subject in which the handler will
establish the group principals. |
true |
|
true |
| JASPIC:JAVADOC:40 |
GroupPrincipalCallback |
jakarta.security.auth.message.callback.GroupPrincipalCallback.GroupPrincipalCallback
( Subject ,
String[] )
|
Create a GroupPrincipalCallback to establish
the container's representation of the corresponding group principals within the Subject. |
true |
|
true |
| JASPIC:JAVADOC:41 |
void |
jakarta.security.auth.message.callback.PasswordValidationCallback.clearPassword
|
Clear the password. |
true |
|
true |
| JASPIC:JAVADOC:42 |
char[] |
jakarta.security.auth.message.callback.PasswordValidationCallback.getPassword
|
Get the password. Note that this method
returns a reference to the password. If a clone of the array is created it is the caller's
responsibility to zero out the password information after it is no longer needed. |
true |
|
true |
| JASPIC:JAVADOC:43 |
boolean |
jakarta.security.auth.message.callback.PasswordValidationCallback.getResult
|
Get the authentication result. |
true |
|
true |
| JASPIC:JAVADOC:44 |
Subject |
jakarta.security.auth.message.callback.PasswordValidationCallback.getSubject
|
Get the subject. |
true |
|
true |
| JASPIC:JAVADOC:45 |
String |
jakarta.security.auth.message.callback.PasswordValidationCallback.getUsername
|
Get the username. |
true |
|
true |
| JASPIC:JAVADOC:46 |
PasswordValidationCallback |
jakarta.security.auth.message.callback.PasswordValidationCallback.PasswordValidationCallback
( Subject ,
String ,
char[] )
|
Create a PasswordValidationCallback. |
true |
|
true |
| JASPIC:JAVADOC:47 |
void |
jakarta.security.auth.message.callback.PasswordValidationCallback.setResult
( boolean )
|
Set the authentication result. |
true |
|
true |
| JASPIC:JAVADOC:48 |
Certificate[] |
jakarta.security.auth.message.callback.PrivateKeyCallback.getChain
|
Used to obtain the certicicate chain set
within the Callback. |
true |
|
true |
| JASPIC:JAVADOC:49 |
PrivateKey |
jakarta.security.auth.message.callback.PrivateKeyCallback.getKey
|
Used to obtain the private key set within the
Callback. |
true |
|
true |
| JASPIC:JAVADOC:50 |
Request |
jakarta.security.auth.message.callback.PrivateKeyCallback.getRequest
|
Used by the CallbackHandler to get the
Request object that identifies the private key to be returned. |
true |
|
true |
| JASPIC:JAVADOC:51 |
PrivateKeyCallback |
jakarta.security.auth.message.callback.PrivateKeyCallback.PrivateKeyCallback
( Request )
|
Constructs this PrivateKeyCallback with a
private key Request object. The request object identifies the private key to be returned. The
corresponding certificate chain for the private key is also returned. If the request object is null,
the handler of the callback relies on its own default. |
true |
|
true |
| JASPIC:JAVADOC:52 |
void |
jakarta.security.auth.message.callback.PrivateKeyCallback.setKey
( PrivateKey ,
Certificate[] )
|
Used by the CallbackHandler to set the
requested private key and the corresponding certificate chain within the Callback. If the requested
private key or chain could not be found, then both values must be set to null. |
true |
|
true |
| JASPIC:JAVADOC:53 |
String |
jakarta.security.auth.message.callback.PrivateKeyCallback.AliasRequest.getAlias
|
Get the alias. |
true |
|
true |
| JASPIC:JAVADOC:54 |
AliasRequest |
jakarta.security.auth.message.callback.PrivateKeyCallback.AliasRequest.PrivateKeyCallback.AliasRequest
( String )
|
Construct an AliasRequest with an alias. The
alias is used to directly identify the private key to be returned. The corresponding certificate
chain for the private key is also returned. If the alias is null, the handler of the callback relies
on its own default. |
true |
|
true |
| JASPIC:JAVADOC:55 |
String |
jakarta.security.auth.message.callback.PrivateKeyCallback.DigestRequest.getAlgorithm
|
Get the algorithm identifier. |
true |
|
true |
| JASPIC:JAVADOC:56 |
byte[] |
jakarta.security.auth.message.callback.PrivateKeyCallback.DigestRequest.getDigest
|
Get the digest value. |
true |
|
true |
| JASPIC:JAVADOC:57 |
DigestRequest |
jakarta.security.auth.message.callback.PrivateKeyCallback.DigestRequest.PrivateKeyCallback.DigestRequest
( byte[] ,
String )
|
Constructs a DigestRequest with a digest
value and algorithm identifier. The digest of the certificate whose private key is returned must
match the provided digest. The certificate digest is computed by applying the specified algorithm to
the bytes of the certificate. For example:
MessageDigest.getInstance(algorithm).digest(cert.getEncoded()) . The corresponding certificate chain
for the private key is also returned. If the digest or algorithm parameters are null, the handler of
the callback relies on its own defaults. |
true |
|
true |
| JASPIC:JAVADOC:58 |
X500Principal |
jakarta.security.auth.message.callback.PrivateKeyCallback.IssuerSerialNumRequest.getIssuer
|
Get the issuer. |
true |
|
true |
| JASPIC:JAVADOC:59 |
BigInteger |
jakarta.security.auth.message.callback.PrivateKeyCallback.IssuerSerialNumRequest.getSerialNum
|
Get the serial number. |
true |
|
true |
| JASPIC:JAVADOC:60 |
IssuerSerialNumRequest |
jakarta.security.auth.message.callback.PrivateKeyCallback.IssuerSerialNumRequest.PrivateKeyCallback.IssuerSerialNumRequest
( X500Principal ,
BigInteger )
|
Constructs a IssuerSerialNumRequest with an
issuer/serial number. The issuer/serial number is used to identify a public key certificate. The
corresponding private key is returned in the callback. The corresponding certificate chain for the
private key is also returned. If the issuer/serialNumber parameters are null, the handler of the
callback relies on its own defaults. |
true |
|
true |
| JASPIC:JAVADOC:61 |
byte[] |
jakarta.security.auth.message.callback.PrivateKeyCallback.SubjectKeyIDRequest.getSubjectKeyID
|
Get the subjectKeyID. |
true |
|
true |
| JASPIC:JAVADOC:62 |
SubjectKeyIDRequest |
jakarta.security.auth.message.callback.PrivateKeyCallback.SubjectKeyIDRequest.PrivateKeyCallback.SubjectKeyIDRequest
( byte[] )
|
Construct a SubjectKeyIDRequest with an
subjectKeyID. The subjectKeyID is used to directly identify the private key to be returned. The
corresponding certificate chain for the private key is also returned. If the subjectKeyID is null,
the handler of the callback relies on its own default. |
true |
|
true |
| JASPIC:JAVADOC:63 |
SecretKey |
jakarta.security.auth.message.callback.SecretKeyCallback.getKey
|
Used to obtain the secret key set within the
Callback. |
true |
|
true |
| JASPIC:JAVADOC:64 |
Request |
jakarta.security.auth.message.callback.SecretKeyCallback.getRequest
|
Used by the CallbackHandler to get the
Request object which identifies the secret key to be returned. |
true |
|
true |
| JASPIC:JAVADOC:65 |
SecretKeyCallback |
jakarta.security.auth.message.callback.SecretKeyCallback.SecretKeyCallback
( Request )
|
Constructs this SecretKeyCallback with a
secret key Request object. The request object identifies the secret key to be returned. If the alias
is null, the handler of the callback relies on its own default. |
true |
|
true |
| JASPIC:JAVADOC:66 |
void |
jakarta.security.auth.message.callback.SecretKeyCallback.setKey
( SecretKey )
|
Used by the CallbackHandler to set the
requested secret key within the Callback. |
true |
|
true |
| JASPIC:JAVADOC:67 |
String |
jakarta.security.auth.message.callback.SecretKeyCallback.AliasRequest.getAlias
|
Get the alias. |
true |
|
true |
| JASPIC:JAVADOC:68 |
AliasRequest |
jakarta.security.auth.message.callback.SecretKeyCallback.AliasRequest.SecretKeyCallback.AliasRequest
( String )
|
Construct an AliasRequest with an alias. The
alias is used to directly identify the secret key to be returned. If the alias is null, the handler
of the callback relies on its own default. |
true |
|
true |
| JASPIC:JAVADOC:69 |
KeyStore |
jakarta.security.auth.message.callback.TrustStoreCallback.getTrustStore
|
Used by the TrustStore user to obtain the
TrustStore set within the Callback. |
true |
|
true |
| JASPIC:JAVADOC:70 |
void |
jakarta.security.auth.message.callback.TrustStoreCallback.setTrustStore
( KeyStore )
|
Used by the CallbackHandler to set the
trusted certificate keystore within the Callback. |
true |
|
true |
| JASPIC:JAVADOC:71 |
TrustStoreCallback |
jakarta.security.auth.message.callback.TrustStoreCallback.TrustStoreCallback
|
Create a TrustStoreCallback. |
true |
|
true |
| JASPIC:JAVADOC:72 |
String |
jakarta.security.auth.message.config.AuthConfig.getAppContext
|
Get the application context identifier of
this authentication context configuration object. |
true |
|
true |
| JASPIC:JAVADOC:73 |
String |
jakarta.security.auth.message.config.AuthConfig.getAuthContextID
( MessageInfo )
|
Get the authentication context identifier
corresponding to the request and response objects encapsulated in messageInfo. |
true |
|
true |
| JASPIC:JAVADOC:74 |
String |
jakarta.security.auth.message.config.AuthConfig.getMessageLayer
|
Get the message layer name of this
authentication context configuration object. |
true |
|
true |
| JASPIC:JAVADOC:75 |
boolean |
jakarta.security.auth.message.config.AuthConfig.isProtected
|
Used to determine whether the authentication
context configuration object encapsulates any protected authentication contexts. |
true |
|
true |
| JASPIC:JAVADOC:76 |
void |
jakarta.security.auth.message.config.AuthConfig.refresh
|
Causes a dynamic anthentication context
configuration object to update the internal state that it uses to process calls to its
getAuthContext method. |
true |
|
true |
| JASPIC:JAVADOC:77 |
AuthConfigFactory |
jakarta.security.auth.message.config.AuthConfigFactory.AuthConfigFactory
|
|
true |
|
true |
| JASPIC:JAVADOC:78 |
String[] |
jakarta.security.auth.message.config.AuthConfigFactory.detachListener
( RegistrationListener ,
String ,
String )
|
Disassociate the listener from all the
provider registrations whose layer and appContext values are matched by the corresponding arguments
to this method. Factories should periodically notify Listeners to effectively detach listeners that
are no longer in use. |
true |
|
true |
| JASPIC:JAVADOC:79 |
AuthConfigProvider |
jakarta.security.auth.message.config.AuthConfigFactory.getConfigProvider
( String ,
String ,
RegistrationListener )
|
Get a registered AuthConfigProvider from the
factory. Get the provider of ServerAuthConfig and ClientAuthConfig objects registered for the
identified message layer and application context. All factories shall employ the following
precedence rules to select the registered AuthConfigProvider that matches the layer and appContext
arguments: The provider specifically registered for the values passed as the layer and appContext
arguments shall be selected. If no provider is selected according to the preceding rule, the
provider specifically registered for the value passed as the appContext argument and for all (that
is, null) layers shall be selected. If no provider is selected according to the preceding rules, the
provider specifically registered for the value passed as the layer argument and for all (that is,
null) appContexts shall be selected. If no provider is selected according to the preceding rules,
the provider registered for all (that is, null) layers and for all (that is, null) appContexts shall
be selected. If no provider is selected according to the preceding rules, the factory shall
terminate its search for a registered provider. The above precedence rules apply equivalently to
registrations created with a null or non-null className argument. |
true |
|
true |
| JASPIC:JAVADOC:80 |
AuthConfigFactory |
jakarta.security.auth.message.config.AuthConfigFactory.getFactory
|
Get the system-wide AuthConfigFactory
implementation. If a non-null system-wide factory instance is defined at the time of the call, for
example, with setFactory, it will be returned. Otherwise, an attempt will be made to construct an
instance of the default AuthConfigFactory implementation class. The fully qualified class name of
the default factory implementation class is obtained from the value of the
authconfigprovider.factory security property. When an instance of the default factory implementation
class is successfully constructed by this method, this method will set it as the system-wide factory
instance. The absolute pathname of the Java security properties file is
JAVA_HOME/lib/security/java.security, where JAVA_HOME refers to the directory where the JDK was
installed. |
true |
|
true |
| JASPIC:JAVADOC:81 |
RegistrationContext |
jakarta.security.auth.message.config.AuthConfigFactory.getRegistrationContext
( String )
|
Get the the registration context for the
identified registration. |
true |
|
true |
| JASPIC:JAVADOC:82 |
String[] |
jakarta.security.auth.message.config.AuthConfigFactory.getRegistrationIDs
( AuthConfigProvider )
|
Get the registration identifiers for all
registrations of the provider instance at the factory. |
true |
|
true |
| JASPIC:JAVADOC:83 |
void |
jakarta.security.auth.message.config.AuthConfigFactory.refresh
|
Cause the factory to reprocess its persisent
declarative representation of provider registrations. A factory should only replace an existing
registration when a change of provider implementation class or initialization properties has
occurred. |
true |
|
true |
| JASPIC:JAVADOC:84 |
String |
jakarta.security.auth.message.config.AuthConfigFactory.registerConfigProvider
( String ,
Map ,
String ,
String ,
String )
|
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. This method typically constructs an instance of the provider before registering it with
the factory. Factories may extend or modify the persisted registrations of existing provider
instances, if those instances were registered with ClassName and properties arguments equivalent to
those passed in the current call. This method employs the two argument constructor required to be
supported by every implementation of the AuthConfigProvider interface, and this method must pass a
null value for the factory argument of the constructor. AuthConfigProviderImpl
AuthConfigProviderImpl(Map properties, AuthConfigFactory factory). 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 by using this method must update (according to the replacement
rules described above) the persistent declarative representation of provider registrations employed
by the factory constructor. |
true |
|
true |
| JASPIC:JAVADOC:85 |
String |
jakarta.security.auth.message.config.AuthConfigFactory.registerConfigProvider
( AuthConfigProvider ,
String ,
String ,
String )
|
Registers within the (in-memory) factory, a
provider of ServerAuthConfig and/or ClientAuthConfig objects for a message layer and application
context identifier. This method does NOT effect the factory's persistent declarative representation
of provider registrations, and is intended to be used by providers to perform self-Registration. 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. |
true |
|
true |
| JASPIC:JAVADOC:86 |
boolean |
jakarta.security.auth.message.config.AuthConfigFactory.removeRegistration
( String )
|
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. |
true |
|
true |
| JASPIC:JAVADOC:87 |
void |
jakarta.security.auth.message.config.AuthConfigFactory.setFactory
( AuthConfigFactory )
|
Set the system-wide AuthConfigFactory
implementation. If an implementation was set previously, it will be replaced. Listeners are not
notified of a change to the registered factory. |
true |
|
true |
| JASPIC:JAVADOC:88 |
String |
jakarta.security.auth.message.config.AuthConfigFactory.RegistrationContext.getAppContext
|
Get the application context identifier from
the registration context |
true |
|
true |
| JASPIC:JAVADOC:89 |
String |
jakarta.security.auth.message.config.AuthConfigFactory.RegistrationContext.getDescription
|
Get the description from the registration
context |
true |
|
true |
| JASPIC:JAVADOC:90 |
String |
jakarta.security.auth.message.config.AuthConfigFactory.RegistrationContext.getMessageLayer
|
Get the layer name from the registration
context |
true |
|
true |
| JASPIC:JAVADOC:91 |
boolean |
jakarta.security.auth.message.config.AuthConfigFactory.RegistrationContext.isPersistent
|
Get the persisted status from the
registration context. |
true |
|
true |
| JASPIC:JAVADOC:92 |
ClientAuthConfig |
jakarta.security.auth.message.config.AuthConfigProvider.getClientAuthConfig
( String ,
String ,
CallbackHandler )
|
Get an instance of ClientAuthConfig from this
provider. The implementation of this method returns a ClientAuthConfig instance that describes the
configuration of ClientAuthModules at a given message layer, and for use in an identified
application context. |
true |
|
true |
| JASPIC:JAVADOC:93 |
ClientAuthConfig |
jakarta.security.auth.message.config.AuthConfigProvider.getClientAuthConfig
( String ,
String ,
CallbackHandler )
throws AuthException
|
If this provider does not support the
assignment of a default CallbackHandler to the returned ClientAuthConfig. |
true |
|
true |
| JASPIC:JAVADOC:94 |
ServerAuthConfig |
jakarta.security.auth.message.config.AuthConfigProvider.getServerAuthConfig
( String ,
String ,
CallbackHandler )
|
Get an instance of ServerAuthConfig from this
provider. The implementation of this method returns a ServerAuthConfig instance that describes the
configuration of ServerAuthModules at a given message layer, and for a particular application
context. |
true |
|
true |
| JASPIC:JAVADOC:95 |
ServerAuthConfig |
jakarta.security.auth.message.config.AuthConfigProvider.getServerAuthConfig
( String ,
String ,
CallbackHandler )
throws AuthException
|
If this provider does not support the
assignment of a default CallbackHandler to the returned ServerAuthConfig. |
true |
|
true |
| JASPIC:JAVADOC:96 |
void |
jakarta.security.auth.message.config.AuthConfigProvider.refresh
|
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. |
true |
|
true |
| JASPIC:JAVADOC:97 |
ClientAuthContext |
jakarta.security.auth.message.config.ClientAuthConfig.getAuthContext
( String ,
Subject ,
Map )
|
Get a ClientAuthContext instance from this
ClientAuthConfig. The implementation of this method returns a ClientAuthContext instance that
encapsulates the ClientAuthModules used to secure and validate requests/responses associated with
the given authContextID. Specifically, this method accesses this ClientAuthConfig object with the
argument authContextID to determine the ClientAuthModules that are to be encapsulated in the
returned ClientAuthContext instance. The ClientAuthConfig object establishes the request and
response MessagePolicy objects that are passed to the encapsulated modules when they are initialized
by the returned ClientAuthContext instance. It is the modules' responsibility to enforce these
policies when invoked. |
true |
|
true |
| JASPIC:JAVADOC:98 |
ClientAuthContext |
jakarta.security.auth.message.config.ClientAuthConfig.getAuthContext
( String ,
Subject ,
Map )
throws AuthException
|
If this method fails. |
true |
|
true |
| JASPIC:JAVADOC:99 |
void |
jakarta.security.auth.message.config.RegistrationListener.notify
( String ,
String )
|
Notify the listener that a registration with
which it was associated was replaced or unregistered. When a RegistrationListener is associated with
a provider registration within the factory, the factory must call its notify method when the
corresponding registration is unregistered or replaced. |
true |
|
true |
| JASPIC:JAVADOC:100 |
ServerAuthContext |
jakarta.security.auth.message.config.ServerAuthConfig.getAuthContext
( String ,
Subject ,
Map )
|
Get a ServerAuthContext instance from this
ServerAuthConfig. The implementation of this method returns a ServerAuthContext instance that
encapsulates the ServerAuthModules used to validate requests and secure responses associated with
the given authContextID. Specifically, this method accesses this ServerAuthConfig object with the
argument authContextID to determine the ServerAuthModules that are to be encapsulated in the
returned ServerAuthContext instance. The ServerAuthConfig object establishes the request and
response MessagePolicy objects that are passed to the encapsulated modules when they are initialized
by the returned ServerAuthContext instance. It is the modules' responsibility to enforce these
policies when invoked. |
true |
|
true |
| JASPIC:JAVADOC:101 |
ServerAuthContext |
jakarta.security.auth.message.config.ServerAuthConfig.getAuthContext
( String ,
Subject ,
Map )
throws AuthException
|
If this method fails. |
true |
|
true |
| JASPIC:JAVADOC:102 |
Class[] |
jakarta.security.auth.message.module.ClientAuthModule.getSupportedMessageTypes
|
Get the one or more Class objects
representing the message types supported by the module. |
true |
|
true |
| JASPIC:JAVADOC:103 |
void |
jakarta.security.auth.message.module.ClientAuthModule.initialize
( MessagePolicy ,
MessagePolicy ,
CallbackHandler ,
Map )
|
Initialize this module with request and
response message policies to enforce, a CallbackHandler, and any module-specific configuration
properties. The request policy and the response policy must not both be null. |
true |
|
true |
| JASPIC:JAVADOC:104 |
void |
jakarta.security.auth.message.module.ClientAuthModule.initialize
( MessagePolicy ,
MessagePolicy ,
CallbackHandler ,
Map )
throws
AuthException
|
If module initialization fails, including for
the case where the options argument contains elements that are not supported by the module. |
true |
|
true |
| JASPIC:JAVADOC:105 |
Class[] |
jakarta.security.auth.message.module.ServerAuthModule.getSupportedMessageTypes
|
Get the one or more Class objects
representing the message types supported by the module. |
true |
|
true |
| JASPIC:JAVADOC:106 |
void |
jakarta.security.auth.message.module.ServerAuthModule.initialize
( MessagePolicy ,
MessagePolicy ,
CallbackHandler ,
Map )
|
Initialize this module with request and
response message policies to enforce, a CallbackHandler, and any module-specific configuration
properties. The request policy and the response policy must not both be null. |
true |
|
true |
| JASPIC:JAVADOC:107 |
void |
jakarta.security.auth.message.module.ServerAuthModule.initialize
( MessagePolicy ,
MessagePolicy ,
CallbackHandler ,
Map )
throws
AuthException
|
If module initialization fails, including for
the case where the options argument contains elements that are not supported by the module. |
true |
|
true |