com.cafesoft.cams.auth
Interface AuthRequest

All Known Subinterfaces:

InternalAuthRequest

public interface AuthRequest

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

Method Summary

void	addCallbackValue(String name, String value) Add a Callback value to the AuthRequest
void	addSessionId(SessionId id) Add a SessionId to the AuthRequest.
void	clearSessionIds() Clear all SessionId's from the AuthRequest.
Iterator	getSessionIds() Get all SessionId's added to the AccessControlRequest.
boolean	hasSessionIds() Determine if the AuthRequest contains any SessionId's.
void	log(Logger logger) Logs the data contained in this request to the specified logger.
void	setLoginConfigEntryName(String name) Set the LoginContext name within the LoginConfiguration against which to authenticate.
void	setRemoteAddr(String address) Set the Internet Protocol (IP) address of the client that sent the request.
void	setRemoteHost(String host) Set the fully qualified name of the client that sent the request.
void	setSecurityDomainName(String securityDomainName) Set the SecurityDomain name to which the AuthRequest applies.

Method Detail

setRemoteAddr

void setRemoteAddr(String address)

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

Parameters:

address - The new IP address expressed as a String

setRemoteHost

void setRemoteHost(String host)

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

Parameters:

host - the host name as a String

setSecurityDomainName

void setSecurityDomainName(String securityDomainName)

Set the SecurityDomain name to which the AuthRequest applies.

Parameters:

securityDomainName - KRJ

setLoginConfigEntryName

void setLoginConfigEntryName(String name)

Set the LoginContext name within the LoginConfiguration against which to authenticate.

Parameters:

name - the name of the LoginConfigEntry.

addSessionId

void addSessionId(SessionId id)

Add a SessionId to the AuthRequest. The SessionId object being added is a SessionId that the current client has already authenticated with. Therefore, this id object could be from a different security domain, it won't be from a different Cams Policy Server however.

hasSessionIds

boolean hasSessionIds()

Determine if the AuthRequest contains any SessionId's.

Returns:

true if the AuthRequest contains any SessionId's, false otherwise.

getSessionIds

Iterator getSessionIds()

Get all SessionId's added to the AccessControlRequest.

Returns:

an interator of SessionId objects.

clearSessionIds

void clearSessionIds()

Clear all SessionId's from the AuthRequest.

addCallbackValue

void addCallbackValue(String name,
                      String value)

Add a Callback value to the AuthRequest

Parameters:

name - the name of the Callback value to be added

value - the value to be added

log

void log(Logger logger)

Logs the data contained in this request to the specified logger.

Parameters:

logger - logs data