com.cafesoft.cams.session.control
Interface SessionControlResponse

All Known Subinterfaces:

InternalSessionControlResponse

public interface SessionControlResponse

Defines the response to an a SessionControlRequest, which request information about a Cams authentication Session.

Since:

6/14/02

See Also:

SessionControlRequest

Field Summary

static int	RC_GENERAL_SERVER_ERROR Reason Code: General Server Error, probably due to a misconfiguration.
static int	RC_INVALID_SESSION_ID Reason Code: An invalid session identifier was specified.
static int	RC_NOT_APPLICABLE Reason Code: Not Applicable (because control is granted)
static int	RC_POISONED_SESSION Reason Code: The session has been poisoned.
static int	RC_SESSION_DOES_NOT_EXIST Reason Code: The Session Id does not exist in the SecurityDomain's SessionManagerService
static int	RC_UNKNOWN_SECURITY_DOMAIN Reason Code: An unknown security domain was referenced.
static int	SC_FAILED Status Code indicating that control is denied.
static int	SC_PENDING Status Code indicating that control check is in progress.
static int	SC_SUCCESS Status Code indicating that control is granted.

Method Summary

String	getMessage() Get the message.
int	getReason() Get the Reason code.
int	getStatus() Get the status code.
void	log(Logger logger) Logs the data contained in this response to the specified logger.

Field Detail

SC_PENDING

public static final int SC_PENDING

Status Code indicating that control check is in progress.

See Also:

Constant Field Values

SC_SUCCESS

public static final int SC_SUCCESS

Status Code indicating that control is granted.

See Also:

Constant Field Values

SC_FAILED

public static final int SC_FAILED

Status Code indicating that control is denied.

See Also:

Constant Field Values

RC_NOT_APPLICABLE

public static final int RC_NOT_APPLICABLE

Reason Code: Not Applicable (because control is granted)

See Also:

Constant Field Values

RC_GENERAL_SERVER_ERROR

public static final int RC_GENERAL_SERVER_ERROR

Reason Code: General Server Error, probably due to a misconfiguration.

See Also:

Constant Field Values

RC_UNKNOWN_SECURITY_DOMAIN

public static final int RC_UNKNOWN_SECURITY_DOMAIN

Reason Code: An unknown security domain was referenced.

See Also:

Constant Field Values

RC_INVALID_SESSION_ID

public static final int RC_INVALID_SESSION_ID

Reason Code: An invalid session identifier was specified. The session ID may have been tampered or the format may be unrecognized.

See Also:

Constant Field Values

RC_POISONED_SESSION

public static final int RC_POISONED_SESSION

Reason Code: The session has been poisoned.

See Also:

Constant Field Values

RC_SESSION_DOES_NOT_EXIST

public static final int RC_SESSION_DOES_NOT_EXIST

Reason Code: The Session Id does not exist in the SecurityDomain's SessionManagerService

See Also:

Constant Field Values

Method Detail

getStatus

public int getStatus()

Get the status code.

Returns:

the status code.

getReason

public int getReason()

Get the Reason code.

Returns:

the reason code.

getMessage

public String getMessage()

Get the message.

Returns:

a textual message, usually used to convey error information if session control failed, or null if no message is available.

log

public void log(Logger logger)

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

Parameters:

logger - logs data