com.netegrity.policyserver.smapi
Class SmAuthQueryResponse

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

public class SmAuthQueryResponse
extends java.lang.Object

Contains constants that specify the kind of credentials, if any, that are required for authentication. This class also allows a text message to be returned to SiteMinder for display to the user.

The constants are bit flags, and one or more may apply. The authentication scheme must OR together all the appropriate values to form its response code for a SMAUTH_QUERY_CREDENTIALS_REQ query.

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.

The set... methods in this class pass information directly to SiteMinder.

Since:

SDK 6.0

Field Summary

static int	SMAUTH_API_VERSION_V3 Authentication scheme versions.
static int	SMAUTH_API_VERSION_V6
static int	SMAUTH_CRED_ALLOW_ANONYMOUS Internal use only.
static int	SMAUTH_CRED_ALLOW_SAVE_CREDS Specifies whether the credentials can be saved for 30 days by the user.
static int	SMAUTH_CRED_BASIC User name and password are required.
static int	SMAUTH_CRED_CERT_OR_BASIC Either a certificate is required or a user name and password are required.
static int	SMAUTH_CRED_CERT_OR_FORM Either a certificate is required or a form-based user name and password are required.
static int	SMAUTH_CRED_DIGEST The required user name and password are exchanged using the digest protocol.
static int	SMAUTH_CRED_DO_NOT_CHALLENGE Do not challenge for credentials.
static int	SMAUTH_CRED_ETSSOCOOKIE Internal use only.
static int	SMAUTH_CRED_ETSSOCOOKIE_OR_BASIC Internal use only.
static int	SMAUTH_CRED_ETSSOCOOKIE_OR_FORM Internal use only.
static int	SMAUTH_CRED_FORM_REQUIRED A form-based user name and password are required.
static int	SMAUTH_CRED_METADATA_REQUIRED Internal use only.
static int	SMAUTH_CRED_NONE No credentials are required.
static int	SMAUTH_CRED_NT_CHALLENGE_RESPONSE The required user name and password are exchanged using the NT Challenge Response protocol.
static int	SMAUTH_CRED_PASSPORT Internal use only.
static int	SMAUTH_CRED_PRESERVE_SESSION_ID The session ID should be preserved if the current session is still valid.
static int	SMAUTH_CRED_SAML Internal use only.
static int	SMAUTH_CRED_SSL_REQUIRED An SSL connection is required.
static int	SMAUTH_CRED_X509CERT A full X.509 Client Certificate is required.
static int	SMAUTH_CRED_X509CERT_ISSUER_DN An issuer DN from an X.509 Client Certificate is required.
static int	SMAUTH_CRED_X509CERT_USER_DN A user DN from an X.509 Client Certificate is required.
static int	SMAUTH_CRED_XML_DOCUMENT_MAPPED Internal use only.
static int	SMAUTH_CRED_XML_DSIG Internal use only.
static int	SMAUTH_CRED_XML_DSIG_XKMS Internal use only.

Method Summary

int	getMaxResponseSize() Retrieves the maximum number of bytes that can be passed in setResponseBuffer().
void	setResponseBuffer(java.lang.String response) Sets the response text for this authentication request.
void	setResponseCode(int code) Sets the response code to pass to the Policy Server.

Methods inherited from class java.lang.Object

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

Field Detail

SMAUTH_API_VERSION_V3

public static final int SMAUTH_API_VERSION_V3

Authentication scheme versions.

See Also:

Constant Field Values

SMAUTH_API_VERSION_V6

public static final int SMAUTH_API_VERSION_V6

See Also:

Constant Field Values

SMAUTH_CRED_NONE

public static final int SMAUTH_CRED_NONE

No credentials are required.

See Also:

Constant Field Values

SMAUTH_CRED_BASIC

public static final int SMAUTH_CRED_BASIC

User name and password are required.

See Also:

Constant Field Values

SMAUTH_CRED_DIGEST

public static final int SMAUTH_CRED_DIGEST

The required user name and password are exchanged using the digest protocol.

See Also:

Constant Field Values

SMAUTH_CRED_X509CERT

public static final int SMAUTH_CRED_X509CERT

A full X.509 Client Certificate is required. SMAUTH_CRED_SSL_REQUIRED must be specified.

See Also:

Constant Field Values

SMAUTH_CRED_X509CERT_USER_DN

public static final int SMAUTH_CRED_X509CERT_USER_DN

A user DN from an X.509 Client Certificate is required. SMAUTH_CRED_SSL_REQUIRED must be specified.

See Also:

Constant Field Values

SMAUTH_CRED_X509CERT_ISSUER_DN

public static final int SMAUTH_CRED_X509CERT_ISSUER_DN

An issuer DN from an X.509 Client Certificate is required. SMAUTH_CRED_SSL_REQUIRED must be specified.

See Also:

Constant Field Values

SMAUTH_CRED_CERT_OR_BASIC

public static final int SMAUTH_CRED_CERT_OR_BASIC

Either a certificate is required or a user name and password are required.

See Also:

Constant Field Values

SMAUTH_CRED_NT_CHALLENGE_RESPONSE

public static final int SMAUTH_CRED_NT_CHALLENGE_RESPONSE

The required user name and password are exchanged using the NT Challenge Response protocol.

See Also:

Constant Field Values

SMAUTH_CRED_CERT_OR_FORM

public static final int SMAUTH_CRED_CERT_OR_FORM

Either a certificate is required or a form-based user name and password are required. If a form is required, a redirect to a URL containing a form must be specified. Use setResponseBuffer() to specify the URL.

See Also:

Constant Field Values

SMAUTH_CRED_XML_DOCUMENT_MAPPED

public static final int SMAUTH_CRED_XML_DOCUMENT_MAPPED

Internal use only.

See Also:

Constant Field Values

SMAUTH_CRED_XML_DSIG

public static final int SMAUTH_CRED_XML_DSIG

Internal use only.

See Also:

Constant Field Values

SMAUTH_CRED_XML_DSIG_XKMS

public static final int SMAUTH_CRED_XML_DSIG_XKMS

Internal use only.

See Also:

Constant Field Values

SMAUTH_CRED_SAML

public static final int SMAUTH_CRED_SAML

Internal use only.

See Also:

Constant Field Values

SMAUTH_CRED_PASSPORT

public static final int SMAUTH_CRED_PASSPORT

Internal use only.

See Also:

Constant Field Values

SMAUTH_CRED_ETSSOCOOKIE

public static final int SMAUTH_CRED_ETSSOCOOKIE

Internal use only. An eTrust SSO Cookie is required.

See Also:

Constant Field Values

SMAUTH_CRED_ETSSOCOOKIE_OR_BASIC

public static final int SMAUTH_CRED_ETSSOCOOKIE_OR_BASIC

Internal use only. Either an eTrust SSO Cookie is required or a user name and password are required.

See Also:

Constant Field Values

SMAUTH_CRED_ETSSOCOOKIE_OR_FORM

public static final int SMAUTH_CRED_ETSSOCOOKIE_OR_FORM

Internal use only. Either an eTrust SSO Cookie is required or a form-based user name and password are required. If a form is required, a redirect to a URL containing a form must be specified. Use setResponseBuffer() to specify the URL.

See Also:

Constant Field Values

SMAUTH_CRED_SSL_REQUIRED

public static final int SMAUTH_CRED_SSL_REQUIRED

An SSL connection is required. A redirect to an HTTPS URL must be specified. Use setResponseBuffer() to specify the URL.

See Also:

Constant Field Values

SMAUTH_CRED_FORM_REQUIRED

public static final int SMAUTH_CRED_FORM_REQUIRED

A form-based user name and password are required. A redirect to a URL containing a form must be specified. Use setResponseBuffer() to specify the URL.

See Also:

Constant Field Values

SMAUTH_CRED_ALLOW_SAVE_CREDS

public static final int SMAUTH_CRED_ALLOW_SAVE_CREDS

Specifies whether the credentials can be saved for 30 days by the user. Users who save their credentials do not need to enter their credentials each time they access the protected resource.

See Also:

Constant Field Values

SMAUTH_CRED_PRESERVE_SESSION_ID

public static final int SMAUTH_CRED_PRESERVE_SESSION_ID

The session ID should be preserved if the current session is still valid.

See Also:

Constant Field Values

SMAUTH_CRED_DO_NOT_CHALLENGE

public static final int SMAUTH_CRED_DO_NOT_CHALLENGE

Do not challenge for credentials.

See Also:

Constant Field Values

SMAUTH_CRED_METADATA_REQUIRED

public static final int SMAUTH_CRED_METADATA_REQUIRED

Internal use only.

See Also:

Constant Field Values

SMAUTH_CRED_ALLOW_ANONYMOUS

public static final int SMAUTH_CRED_ALLOW_ANONYMOUS

Internal use only.

See Also:

Constant Field Values

Method Detail

getMaxResponseSize

public int getMaxResponseSize()

Retrieves the maximum number of bytes that can be passed in setResponseBuffer().

Returns:

The maximum number of bytes for the response buffer.

setResponseBuffer

public void setResponseBuffer(java.lang.String response)

Sets the response text for this authentication request. SiteMinder displays the response text to the user.

The response text can also be used to specify a URL where credentials must be collected.

If the length of the response text exceeds the maximum returned by getMaxResponseSize(), the response text is truncated.

The response text you set with this method is passed directly to the Policy Server.

Parameters:

response - The response text to pass to the Policy Server.

setResponseCode

public void setResponseCode(int code)

Sets the response code to pass to the Policy Server.

The response code you set depends on the query code that SiteMinder passes to the query() method, as follows:

• SMAUTH_QUERY_DESCRIPTION. With this query code, specify one of the version constants (SM_API_VERSION_...) in APIContext.
• SMAUTH_QUERY_CREDENTIALS_REQ. With this query code, specify one or more of this class's credentials constants (SMAUTH_CRED_...). If multiple response code values apply to the query, OR them together.

The response code you set with this method is passed directly to the Policy Server.

Parameters:

code - - The response code to pass to the Policy Server.