com.netegrity.policyserver.smapi
Class SmAuthStatus

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

public class SmAuthStatus
extends java.lang.Object

Contains Authentication API status codes such as SMAUTH_ACCEPT and SMAUTH_REJECT.

The custom authentication scheme can pass back this object to SiteMinder in SmAuthenticationResult. The object is also the return value type for the following authentication scheme methods:

• init()
• query()
• release()

Since:

SDK 6.0

Field Summary

static SmAuthStatus	SMAUTH_ACCEPT Indicates that the user is authenticated.
static SmAuthStatus	SMAUTH_ATTEMPT Indicates that the user could not be found in the user directory during a disambiguation attempt.
static SmAuthStatus	SMAUTH_CHALLENGE Indicates that the user is challenged.
static SmAuthStatus	SMAUTH_FAILURE Indicates that the custom authentication scheme operation failed.
static SmAuthStatus	SMAUTH_NO_USER_CONTEXT Indicates that SiteMinder should disambiguate the user.
static SmAuthStatus	SMAUTH_REJECT Indicates that the user is not authenticated.
static SmAuthStatus	SMAUTH_SUCCESS Indicates a successful custom authentication scheme operation.
static SmAuthStatus	SMAUTH_SUCCESS_USER_DN Indicates that the authentication scheme will disambiguate the user.

Method Summary

java.lang.String	toString() Returns a string representation of the current status value.
SmAuthStatus	valueOf(int anInt) Retrieves the status constant associated with the integer parameter, or null if the integer is out of range.

Methods inherited from class java.lang.Object

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

Field Detail

SMAUTH_SUCCESS

public static final SmAuthStatus SMAUTH_SUCCESS

Indicates a successful custom authentication scheme operation.

This constant's meaning depends upon the context in which it is used:

• When returned during the disambiguation phase, indicates that SiteMinder should disambiguate the user. When passing this status code to SiteMinder, the authentication scheme should also pass the user's login ID through setUserText().
• When returned from init(), query(), or release(), indicates that the method was successful.

SMAUTH_FAILURE

public static final SmAuthStatus SMAUTH_FAILURE

Indicates that the custom authentication scheme operation failed. Error text can be passed back to the user in setUserText()

.

SMAUTH_ACCEPT

public static final SmAuthStatus SMAUTH_ACCEPT

Indicates that the user is authenticated.

SMAUTH_REJECT

public static final SmAuthStatus SMAUTH_REJECT

Indicates that the user is not authenticated.

SMAUTH_CHALLENGE

public static final SmAuthStatus SMAUTH_CHALLENGE

Indicates that the user is challenged.

The authentication scheme passes the challenge message to SiteMinder through the setUserText() method. Also, a reason code indicating the reason for the challenge must be supplied in the SmAmAuthenticationResult object returned by authenticate().

SMAUTH_ATTEMPT

public static final SmAuthStatus SMAUTH_ATTEMPT

Indicates that the user could not be found in the user directory during a disambiguation attempt.

SMAUTH_NO_USER_CONTEXT

public static final SmAuthStatus SMAUTH_NO_USER_CONTEXT

Indicates that SiteMinder should disambiguate the user.

When passing this status code to SiteMinder, the authentication scheme should also pass an empty string through setUserText().

SMAUTH_SUCCESS_USER_DN

public static final SmAuthStatus SMAUTH_SUCCESS_USER_DN

Indicates that the authentication scheme will disambiguate the user.

After finding the user in the user store, the authentication scheme passes the user's complete DN or ODBC database ID to SiteMinder in setUserText(). Only one DN or database ID can be passed at one time.

Method Detail

valueOf

public SmAuthStatus valueOf(int anInt)

Retrieves the status constant associated with the integer parameter, or null if the integer is out of range.

Parameters:

anInt - The integer assigned to the constant to retrieve, as follows:

• 0. SMAUTH_SUCCESS.
• 1. SMAUTH_FAILURE.
• 2. SMAUTH_ACCEPT.
• 3. SMAUTH_REJECT.
• 4. SMAUTH_CHALLENGE.
• 5. SMAUTH_ATTEMPT.
• 6. SMAUTH_NO_USER_CONTEXT.
• 7. SMAUTH_SUCCESS_USER_DN.

Returns:

The status constant associated with the supplied integer, or null if the integer is out of range.

toString

public java.lang.String toString()

Returns a string representation of the current status value.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the status value.