com.cafesoft.cams.auth
Interface InternalAuthRequest

All Superinterfaces:

AuthRequest

public interface InternalAuthRequest
extends AuthRequest

AuthRequest defines the interface to an Authentication Request for a Cafesoft SecurityDomain's Authentication Engine.

Method Summary

CallbackHandler	getCallbackHandler() Get the CallbackHandler that is invoked by the LoginContext to interact with the client.
Iterator	getCallbackNames() Get an Iterator of all Callback Value Names
String	getCallbackValue(String name) Get a Callback value for the given Callback name
String	getLoginConfigEntryName() Get the LoginConfigEntry name within the LoginConfiguration against which to authenticate.
String	getRemoteAddr() Returns the Internet Protocol (IP) address of the client that sent the request.
String	getRemoteHost() Returns the fully qualified name of the client that sent the request.
String	getSecurityDomainName() Get the name of the SecurityDomain to which the AuthRequest is directed.
void	removeCallbackValue(String name) Remove a Callback value for the given Callback name.
void	setCallbackHandler(CallbackHandler callbackHandler) Set the CallbackHandler that is invoked by the LoginContext to interact with the client.

Methods inherited from interface com.cafesoft.cams.auth.AuthRequest

addCallbackValue, addSessionId, clearSessionIds, getSessionIds, hasSessionIds, log, setLoginConfigEntryName, setRemoteAddr, setRemoteHost, setSecurityDomainName

Method Detail

getRemoteAddr

String getRemoteAddr()

Returns the Internet Protocol (IP) address of the client that sent the request.

Returns:

a String containing the IP address of the client that sent the request

getRemoteHost

String getRemoteHost()

Returns the fully qualified name of the client that sent the request. If the hostname cannot be resolved, this method returns the dotted-string form of the IP address.

Returns:

a String containing the fully qualified name of the client

getSecurityDomainName

String getSecurityDomainName()

Get the name of the SecurityDomain to which the AuthRequest is directed.

Returns:

the SecurityDomain.

getLoginConfigEntryName

String getLoginConfigEntryName()

Get the LoginConfigEntry name within the LoginConfiguration against which to authenticate.

Returns:

the name of the LoginConfigEntry.

getCallbackHandler

CallbackHandler getCallbackHandler()

Get the CallbackHandler that is invoked by the LoginContext to interact with the client.

Returns:

the CallbackHandler

setCallbackHandler

void setCallbackHandler(CallbackHandler callbackHandler)

Set the CallbackHandler that is invoked by the LoginContext to interact with the client.

Parameters:

callbackHandler - the CallbackHandler

getCallbackValue

String getCallbackValue(String name)

Get a Callback value for the given Callback name

Parameters:

name - the name of the Callback Value

Returns:

a Callback value in the form of a String, or null if one does not exist

removeCallbackValue

void removeCallbackValue(String name)

Remove a Callback value for the given Callback name.

Parameters:

name - the name of the Callback value to remove.

Since:

1.1

getCallbackNames

Iterator getCallbackNames()

Get an Iterator of all Callback Value Names

Returns:

an Iterator of String objects that are Callback Value Names