Top Description Methods
jakarta.security.auth.message.config

public Interface AuthConfig

Known Direct Subinterfaces
jakarta.security.auth.message.config.ClientAuthConfig, jakarta.security.auth.message.config.ServerAuthConfig
Imports
jakarta.security.auth.message.MessageInfo
This interface defines the common functionality implemented by Authentication context configuration objects.
See Also
ClientAuthContext, ServerAuthContext

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The String identifying the application context of this configuration object, or null if the configuration object pertains to an unspecified application context.
getAppContext()

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

public String

Returns:

The authentication context identifier corresponding to the encapsulated request and response objects, or null.
getAuthContextID(MessageInfo
A contextual Object that encapsulates the client request and server response objects.
messageInfo)

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

public String

Returns:

The message layer name of this configuration object, or null if the configuration object pertains to an unspecified message layer.
getMessageLayer()

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

public boolean

Returns:

True if the configuration object encapsulates at least one protected authentication context. Otherwise, this method returns false.
isProtected()

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

public void
refresh()

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

Method Detail

getAppContextback to summary
public String getAppContext()

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

Returns:String

The String identifying the application context of this configuration object, or null if the configuration object pertains to an unspecified application context.

getAuthContextIDback to summary
public String getAuthContextID(MessageInfo messageInfo)

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

Parameters
messageInfo:MessageInfo

A contextual Object that encapsulates the client request and server response objects.

Returns:String

The authentication context identifier corresponding to the encapsulated request and response objects, or null.

Exceptions
IllegalArgumentException:
If the type of the message objects incorporated in messageInfo are not compatible with the message types supported by this authentication context configuration object.
getMessageLayerback to summary
public String getMessageLayer()

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

Returns:String

The message layer name of this configuration object, or null if the configuration object pertains to an unspecified message layer.

isProtectedback to summary
public boolean isProtected()

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

Returns:boolean

True if the configuration object encapsulates at least one protected authentication context. Otherwise, this method returns false.

refreshback to summary
public void refresh()

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

Exceptions
SecurityException:
If the caller does not have permission to refresh the configuration object, or if an error occurred during the update.