com.cafesoft.core.message
Class AccessStatus

java.lang.Object
  |
  +--com.cafesoft.core.message.AccessStatus

public class AccessStatus

extends Object

The AccessStatus object is the response object returned from the AccessController object when an access to a connection is attempted.

Since:

7/9/02

Field Summary

static int	RC_ACCESS_CONTROLLER_ERROR Reason Code: General Server Error, probably due to a misconfiguration.
static int	RC_ACCESS_DENIED_AUTHENTICATION_REQUIRED Reason Code: Access was denied because authentication is required.
static int	RC_ACCESS_DENIED_CONFIDENTIALITY_REQUIRED Reason Code: Access was denied because confidentiality is required.
static int	RC_ACCESS_DENIED_UNCONDITIONALLY Reason Code: Access was unconditionally denied based on a rule.
static int	RC_GENERAL_SERVER_ERROR Reason Code: General Server Error, probably due to a misconfiguration.
static int	RC_INVALID_REMOTE_HOST_NAME Reason Code: The remote host name is not valid.
static int	RC_INVALID_REMOTE_IP_ADDRESS Reason Code: The remote host IP address is not valid.
static int	RC_NOT_APPLICABLE Reason Code: Not Applicable (because access is granted)
static int	SC_ACCESS_FAILURE Status Code indicating that access failed.
static int	SC_ACCESS_PENDING Status Code indicating that access is in progress.
static int	SC_ACCESS_SUCCESS Status Code indicating that access succeeded.

Constructor Summary

AccessStatus()
Create a default AccessStatus object

AccessStatus(int status, int reason, String message)
Create a new AccessStatus object with the given status code, reason code, and message

Method Summary

String	getMessage() Get the Message
int	getReason() Get the Reason Code
int	getStatus() Get the Status Code
void	setMessage(String message) Set the Message
void	setReason(int reason) Set the Reason Code
void	setStatus(int status) Set the Status Code

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SC_ACCESS_PENDING

public static final int SC_ACCESS_PENDING

Status Code indicating that access is in progress.

See Also:

Constant Field Values

SC_ACCESS_SUCCESS

public static final int SC_ACCESS_SUCCESS

Status Code indicating that access succeeded.

See Also:

Constant Field Values

SC_ACCESS_FAILURE

public static final int SC_ACCESS_FAILURE

Status Code indicating that access failed.

See Also:

Constant Field Values

RC_NOT_APPLICABLE

public static final int RC_NOT_APPLICABLE

Reason Code: Not Applicable (because access 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_INVALID_REMOTE_IP_ADDRESS

public static final int RC_INVALID_REMOTE_IP_ADDRESS

Reason Code: The remote host IP address is not valid.

See Also:

Constant Field Values

RC_INVALID_REMOTE_HOST_NAME

public static final int RC_INVALID_REMOTE_HOST_NAME

Reason Code: The remote host name is not valid.

See Also:

Constant Field Values

RC_ACCESS_DENIED_UNCONDITIONALLY

public static final int RC_ACCESS_DENIED_UNCONDITIONALLY

Reason Code: Access was unconditionally denied based on a rule.

See Also:

Constant Field Values

RC_ACCESS_DENIED_AUTHENTICATION_REQUIRED

public static final int RC_ACCESS_DENIED_AUTHENTICATION_REQUIRED

Reason Code: Access was denied because authentication is required.

See Also:

Constant Field Values

RC_ACCESS_DENIED_CONFIDENTIALITY_REQUIRED

public static final int RC_ACCESS_DENIED_CONFIDENTIALITY_REQUIRED

Reason Code: Access was denied because confidentiality is required.

See Also:

Constant Field Values

RC_ACCESS_CONTROLLER_ERROR

public static final int RC_ACCESS_CONTROLLER_ERROR

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

See Also:

Constant Field Values

Constructor Detail

AccessStatus

public AccessStatus()

Create a default AccessStatus object

AccessStatus

public AccessStatus(int status,
                    int reason,
                    String message)

Create a new AccessStatus object with the given status code, reason code, and message

Parameters:

status - the status code

reason - the reason code

message - the message

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:

the message

setStatus

public void setStatus(int status)

Set the Status Code

Parameters:

status - the new Status code

setReason

public void setReason(int reason)

Set the Reason Code

Parameters:

reason - the new Reason code

setMessage

public void setMessage(String message)

Set the Message

Parameters:

message - the new message