javax.security.auth.message.config

Interface AuthConfig

All Known Subinterfaces:

ClientAuthConfig, ServerAuthConfig

All Known Implementing Classes:

JBossClientAuthConfig, JBossServerAuthConfig

public interface AuthConfig

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

Since:

May 12, 2006

Version:

$Revision$

Author:

Anil Saldhana, Charlie Lai, Ron Monzillo (Javadoc for JSR-196)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAppContext() Get the application context identifier of this authentication context configuration object.
String	getAuthContextID(MessageInfo messageInfo)
String	getMessageLayer() Get the message layer name of this authentication context configuration object.
boolean	isProtected()
void	refresh() Causes a dynamic anthentication context configuration object to update its internal state and such that any change to its state is recognized by any authentication context objects that were previously obtained from the config object.

Method Detail

getAppContext

String getAppContext()

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

Returns:

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

getAuthContextID

String getAuthContextID(MessageInfo messageInfo)

getMessageLayer

String getMessageLayer()

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

Returns:

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

isProtected

boolean isProtected()

refresh

void refresh()

Causes a dynamic anthentication context configuration object to update its internal state and such that any change to its state is recognized by any authentication context objects that were previously obtained from the config object.

Throws:

AuthException - if an error occured during the update.

SecurityException - if the caller does not have permission to refresh the configuration object.