FileDocCategorySizeDatePackage
AuthConfig.javaAPI DocGlassfish v2 API4477Fri May 04 22:36:12 BST 2007javax.security.auth.message.config

AuthConfig

public interface AuthConfig
This interface defines the common functionality implemented by Authentication context configuration objects.
version
%I%, %G%
see
ClientAuthContext
see
ServerAuthContext

Fields Summary
Constructors Summary
Methods Summary
public java.lang.StringgetAppContext()
Get the application context identifier of this authentication context configuration object.

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

public java.lang.StringgetAuthContextID(MessageInfo messageInfo)
Get the authentication context identifier corresponding to the request and response objects encapsulated in messageInfo.

param
messageInfo A contextual Object that encapsulates the client request and server response objects.
return
The authentication context identifier corresponding to the encapsulated request and response objects, or null.
throws
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.

public java.lang.StringgetMessageLayer()
Get the message layer name of this authentication context configuration object.

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

public booleanisProtected()
Used to determine whether the authentication context configuration object encapsulates any protected authentication contexts.

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

public voidrefresh()
Causes a dynamic anthentication context configuration object to update the internal state that it uses to process calls to its getAuthContext method.

exception
AuthException If an error occured during the update.
exception
SecurityException If the caller does not have permission to refresh the configuration object.