com.netegrity.policyserver.smapi
Class SmAuthQueryCode

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

public class SmAuthQueryCode
extends java.lang.Object

Contains the type of request that SiteMinder is making of the authentication scheme (version number and description, or information about the credentials that SiteMinder must collect).

SiteMinder passes this object to the custom authentication scheme in query()). The authentication scheme passes back the requested information in the query() response output parameter.

Since:

SDK 6.0

Field Summary

static SmAuthQueryCode	SMAUTH_QUERY_CREDENTIALS_REQ Siteminder passes this value to request the type of credentials that SiteMinder should collect from the user.
static SmAuthQueryCode	SMAUTH_QUERY_DESCRIPTION SiteMinder passes this value to request the authentication scheme's description (set through setResponseBuffer()) and version (set through setResponseCode()).

Method Summary

java.lang.String	toString() Returns a string representation of the current query code value.
static SmAuthQueryCode	valueOf(int anInt) Retrieves the query code 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_QUERY_DESCRIPTION

public static final SmAuthQueryCode SMAUTH_QUERY_DESCRIPTION

SiteMinder passes this value to request the authentication scheme's description (set through setResponseBuffer()) and version (set through setResponseCode()). The description appears in the Policy Server log when the authentication scheme is loaded and unloaded.

SMAUTH_QUERY_CREDENTIALS_REQ

public static final SmAuthQueryCode SMAUTH_QUERY_CREDENTIALS_REQ

Siteminder passes this value to request the type of credentials that SiteMinder should collect from the user. You specify the credentials through the setResponseCode() method.

With some credential types (such as SMAUTH_CRED_FORM_REQUIRED), the authentication scheme must provide a URL where the credentials are to be collected. In those cases, the authentication scheme calls setResponseBuffer() to specify the URL.

Method Detail

valueOf

public static SmAuthQueryCode valueOf(int anInt)

Retrieves the query code 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_QUERY_DESCRIPTION.
• 1. SMAUTH_QUERY_CREDENTIALS_REQ.

Returns:

The query code 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 query code value.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the query code.