com.netegrity.policyserver.smapi
Class SmAuthenticationResult

java.lang.Object
  com.netegrity.policyserver.smapi.SmAuthenticationResult

public class SmAuthenticationResult
extends java.lang.Object

Contains reason codes and status codes returned from the method authenticate() in the custom authentication scheme class.

The status codes indicate the result of a user disambiguation or user authentication operation. The reason codes indicate the cause of the problem with disambiguation or authentication, or REASON_NONE if no problem occurred.

The status codes are contained in an instance of the SmAuthStatus class, which may be passed to the SmAuthenticationResult constructor.

Since:

SDK 6.0

Field Summary

static int	REASON_ACCOUNT_INACTIVITY
static int	REASON_ANONYMOUS
static int	REASON_AUTH_LEVEL_TOO_LOW
static int	REASON_BAD_PW_CHANGE
static int	REASON_BUFFER_OVERFLOW
static int	REASON_CERT_ON_HOLD
static int	REASON_CERT_REVOKED_AFFILIATION_CHANGE
static int	REASON_CERT_REVOKED_KEY_COMPROMISED
static int	REASON_CERTIFICATE_REVOKED
static int	REASON_CRL_OUT_OF_DATE
static int	REASON_ERROR_MESSAGE_IS_REDIRECT
static int	REASON_EXCESSIVE_FAILED_LOGIN_ATTEMPTS
static int	REASON_EXPIRED_SESSION
static int	REASON_FEDERATION_INVALID_MESSAGE
static int	REASON_FEDERATION_NO_LOGIN_ID
static int	REASON_FEDERATION_UNACCEPTED_MESSAGE
static int	REASON_FEDERATION_USER_NOT_IN_DIR
static int	REASON_GUEST
static int	REASON_IDLE_SESSION
static int	REASON_IMMED_PW_CHANGE_REQUIRED
static int	REASON_IMPERSONATED_USER_NOT_IN_DIR
static int	REASON_INVALID_SESSION
static int	REASON_INVALID_SESSION_ID
static int	REASON_INVALID_SESSION_IP
static int	REASON_MAX_DEFINED
static int	REASON_MISCONFIGURED
static int	REASON_NEW_PIN_ACCEPTED
static int	REASON_NEW_PIN_SELECT
static int	REASON_NEW_PIN_SYS_TOKENCODE
static int	REASON_NEW_USER_PIN_TOKENCODE
static int	REASON_NEXT_TOKEN_CODE
static int	REASON_NO_REDIRECT_CONFIGURED
static int	REASON_NONE
static int	REASON_POLICY_SERVER_ENFORCED_IDLE
static int	REASON_POLICY_SERVER_ENFORCED_TIMEOUT
static int	REASON_PW_CHANGE_ACCEPTED
static int	REASON_PW_CHANGE_FAILED
static int	REASON_PW_EXPIRED
static int	REASON_PW_MUST_CHANGE
static int	REASON_PW_SELF_CHANGE
static int	REASON_PW_WILL_EXPIRE
static int	REASON_REVOKED_SESSION
static int	REASON_SERVER_EXCEPTION
static int	REASON_SET_PERSISTENT_SESSION_FAILED
static int	REASON_TOKEN_CARD_CHALLENGE
static int	REASON_UNKNOWN_SCHEME
static int	REASON_UNKNOWN_USER
static int	REASON_UNSUPPORTED_SCHEME
static int	REASON_USER_DISABLED
static int	REASON_USER_LOGOUT

Constructor Summary

SmAuthenticationResult()
This constructor is equivalent to SmAuthenticationResult(SMAUTH_SUCCESS, 0).

SmAuthenticationResult(SmAuthStatus status, int reason)
Constructs an authentication result with the specified status and reason codes.

Method Summary

int	getReason() Retrieves the reason portion of this authentication result.
SmAuthStatus	getStatus() Retrieves the status portion of this authentication result.
void	setReason(int reason) Sets the reason portion of this authentication result.
void	setStatus(SmAuthStatus status) Sets the status portion of this authentication result.
java.lang.String	toString() Returns a string representation of the currently applicable status and reason codes.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REASON_NONE

public static final int REASON_NONE

See Also:

Constant Field Values

REASON_PW_MUST_CHANGE

public static final int REASON_PW_MUST_CHANGE

See Also:

Constant Field Values

REASON_INVALID_SESSION

public static final int REASON_INVALID_SESSION

See Also:

Constant Field Values

REASON_REVOKED_SESSION

public static final int REASON_REVOKED_SESSION

See Also:

Constant Field Values

REASON_EXPIRED_SESSION

public static final int REASON_EXPIRED_SESSION

See Also:

Constant Field Values

REASON_AUTH_LEVEL_TOO_LOW

public static final int REASON_AUTH_LEVEL_TOO_LOW

See Also:

Constant Field Values

REASON_UNKNOWN_USER

public static final int REASON_UNKNOWN_USER

See Also:

Constant Field Values

REASON_USER_DISABLED

public static final int REASON_USER_DISABLED

See Also:

Constant Field Values

REASON_INVALID_SESSION_ID

public static final int REASON_INVALID_SESSION_ID

See Also:

Constant Field Values

REASON_INVALID_SESSION_IP

public static final int REASON_INVALID_SESSION_IP

See Also:

Constant Field Values

REASON_CERTIFICATE_REVOKED

public static final int REASON_CERTIFICATE_REVOKED

See Also:

Constant Field Values

REASON_CRL_OUT_OF_DATE

public static final int REASON_CRL_OUT_OF_DATE

See Also:

Constant Field Values

REASON_CERT_REVOKED_KEY_COMPROMISED

public static final int REASON_CERT_REVOKED_KEY_COMPROMISED

See Also:

Constant Field Values

REASON_CERT_REVOKED_AFFILIATION_CHANGE

public static final int REASON_CERT_REVOKED_AFFILIATION_CHANGE

See Also:

Constant Field Values

REASON_CERT_ON_HOLD

public static final int REASON_CERT_ON_HOLD

See Also:

Constant Field Values

REASON_TOKEN_CARD_CHALLENGE

public static final int REASON_TOKEN_CARD_CHALLENGE

See Also:

Constant Field Values

REASON_IMPERSONATED_USER_NOT_IN_DIR

public static final int REASON_IMPERSONATED_USER_NOT_IN_DIR

See Also:

Constant Field Values

REASON_ANONYMOUS

public static final int REASON_ANONYMOUS

See Also:

Constant Field Values

REASON_PW_WILL_EXPIRE

public static final int REASON_PW_WILL_EXPIRE

See Also:

Constant Field Values

REASON_PW_EXPIRED

public static final int REASON_PW_EXPIRED

See Also:

Constant Field Values

REASON_IMMED_PW_CHANGE_REQUIRED

public static final int REASON_IMMED_PW_CHANGE_REQUIRED

See Also:

Constant Field Values

REASON_PW_CHANGE_FAILED

public static final int REASON_PW_CHANGE_FAILED

See Also:

Constant Field Values

REASON_BAD_PW_CHANGE

public static final int REASON_BAD_PW_CHANGE

See Also:

Constant Field Values

REASON_PW_CHANGE_ACCEPTED

public static final int REASON_PW_CHANGE_ACCEPTED

See Also:

Constant Field Values

REASON_EXCESSIVE_FAILED_LOGIN_ATTEMPTS

public static final int REASON_EXCESSIVE_FAILED_LOGIN_ATTEMPTS

See Also:

Constant Field Values

REASON_ACCOUNT_INACTIVITY

public static final int REASON_ACCOUNT_INACTIVITY

See Also:

Constant Field Values

REASON_NO_REDIRECT_CONFIGURED

public static final int REASON_NO_REDIRECT_CONFIGURED

See Also:

Constant Field Values

REASON_ERROR_MESSAGE_IS_REDIRECT

public static final int REASON_ERROR_MESSAGE_IS_REDIRECT

See Also:

Constant Field Values

REASON_NEXT_TOKEN_CODE

public static final int REASON_NEXT_TOKEN_CODE

See Also:

Constant Field Values

REASON_NEW_PIN_SELECT

public static final int REASON_NEW_PIN_SELECT

See Also:

Constant Field Values

REASON_NEW_PIN_SYS_TOKENCODE

public static final int REASON_NEW_PIN_SYS_TOKENCODE

See Also:

Constant Field Values

REASON_NEW_USER_PIN_TOKENCODE

public static final int REASON_NEW_USER_PIN_TOKENCODE

See Also:

Constant Field Values

REASON_NEW_PIN_ACCEPTED

public static final int REASON_NEW_PIN_ACCEPTED

See Also:

Constant Field Values

REASON_GUEST

public static final int REASON_GUEST

See Also:

Constant Field Values

REASON_PW_SELF_CHANGE

public static final int REASON_PW_SELF_CHANGE

See Also:

Constant Field Values

REASON_SERVER_EXCEPTION

public static final int REASON_SERVER_EXCEPTION

See Also:

Constant Field Values

REASON_UNKNOWN_SCHEME

public static final int REASON_UNKNOWN_SCHEME

See Also:

Constant Field Values

REASON_UNSUPPORTED_SCHEME

public static final int REASON_UNSUPPORTED_SCHEME

See Also:

Constant Field Values

REASON_MISCONFIGURED

public static final int REASON_MISCONFIGURED

See Also:

Constant Field Values

REASON_BUFFER_OVERFLOW

public static final int REASON_BUFFER_OVERFLOW

See Also:

Constant Field Values

REASON_SET_PERSISTENT_SESSION_FAILED

public static final int REASON_SET_PERSISTENT_SESSION_FAILED

See Also:

Constant Field Values

REASON_USER_LOGOUT

public static final int REASON_USER_LOGOUT

See Also:

Constant Field Values

REASON_IDLE_SESSION

public static final int REASON_IDLE_SESSION

See Also:

Constant Field Values

REASON_POLICY_SERVER_ENFORCED_TIMEOUT

public static final int REASON_POLICY_SERVER_ENFORCED_TIMEOUT

See Also:

Constant Field Values

REASON_POLICY_SERVER_ENFORCED_IDLE

public static final int REASON_POLICY_SERVER_ENFORCED_IDLE

See Also:

Constant Field Values

REASON_FEDERATION_NO_LOGIN_ID

public static final int REASON_FEDERATION_NO_LOGIN_ID

See Also:

Constant Field Values

REASON_FEDERATION_USER_NOT_IN_DIR

public static final int REASON_FEDERATION_USER_NOT_IN_DIR

See Also:

Constant Field Values

REASON_FEDERATION_INVALID_MESSAGE

public static final int REASON_FEDERATION_INVALID_MESSAGE

See Also:

Constant Field Values

REASON_FEDERATION_UNACCEPTED_MESSAGE

public static final int REASON_FEDERATION_UNACCEPTED_MESSAGE

See Also:

Constant Field Values

REASON_MAX_DEFINED

public static final int REASON_MAX_DEFINED

See Also:

Constant Field Values

Constructor Detail

SmAuthenticationResult

public SmAuthenticationResult()

This constructor is equivalent to SmAuthenticationResult(SMAUTH_SUCCESS, 0).

SmAuthenticationResult

public SmAuthenticationResult(SmAuthStatus status,
                              int reason)

Constructs an authentication result with the specified status and reason codes.

Parameters:

status - A status value indicating the result of a user disambiguation or user authentication operation.

reason - A non-negative integer reason code. Values range from 0 to 65535. Reason values 0 (REASON NONE) through 31999 are reserved for use by SiteMinder (the reason constants in this class are included in this range). Values 32000 through 32767 are available for user-defined reasons.

Method Detail

getStatus

public SmAuthStatus getStatus()

Retrieves the status portion of this authentication result.

Returns:

The status of the disambiguation or authentication operation.

setStatus

public void setStatus(SmAuthStatus status)

Sets the status portion of this authentication result.

Parameters:

status - A valid SmAuthStatus value.

getReason

public int getReason()

Retrieves the reason portion of this authentication result.

Returns:

The reason for the disambiguation or authentication problem, if any.

setReason

public void setReason(int reason)
               throws java.lang.IllegalArgumentException

Sets the reason portion of this authentication result.

Parameters:

reason - A non-negative integer reason code. Values range from 0 to 65535. Reason values 0 (REASON NONE) through 31999 are reserved for use by SiteMinder (the reason constants in this class are included in this range). Values 32000 through 32767 are available for user-defined reasons.

Throws:

java.lang.IllegalArgumentException

toString

public java.lang.String toString()

Returns a string representation of the currently applicable status and reason codes.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of the status and reason codes.