com.tivoli.am.fim.trustserver.sts.utilities
Class USCContextAttributesHelper

java.lang.Object
  com.tivoli.am.fim.trustserver.sts.utilities.USCContextAttributesHelper

All Implemented Interfaces:

com.tivoli.am.fim.constants.USCCAConstants

public class USCContextAttributesHelper
extends java.lang.Object
implements com.tivoli.am.fim.constants.USCCAConstants

Utility class that provides accessor methods for context attributes used by User Self Care. These methods provide typing and XML encoding of the attributes and should be used instead of directly accessing the context attributes.

Public methods indicate the type used in the method description for convenience.
Types are listed in USCCAConstants.java

All public getter methods can return null
All public setter methods are null safe

See Also:

USCCAConstants

Field Summary

static java.lang.String	USCContextAttributesHelper_java_copyright
static java.lang.String	USCContextAttributesHelper_java_sourceCodeID

Fields inherited from interface com.tivoli.am.fim.constants.USCCAConstants

ENTITY_AUDIT_ATTR_TYPE, ENTITY_FAILURE_REASON_ATTR, ENTITY_GROUP_NAMES_ATTR, ENTITY_LOOKUP_ATTRIBUTE_ATTR, ENTITY_LOOKUP_FIELD_ATTR, ENTITY_OPERATION_ATTR, ENTITY_PROFILE_ATTRIBUTES_ATTR, ENTITY_REGISTRY_ID_ATTR, ENTITY_REGISTRY_SUFFIX_ATTR, ENTITY_REGISTRY_TYPE_ATTR, ENTITY_USER_ID_ATTR, ENTITY_USER_LOOKUP_RESULT_ATTR, USC_CAPTCHA_WITH_ERROR_MESSAGE_FLAG, USC_CONFIRM_SUFFIX, USC_FORM_CAPTCHA, USC_FORM_CUSTOM_PREFIX, USC_FORM_EMAIL_ADDRESS, USC_FORM_EMAIL_ADDRESS_CONFIRM, USC_FORM_NONCE, USC_FORM_PASSWORD, USC_FORM_PASSWORD_EXPIRED_FLAG, USC_FORM_PASSWORD_NEW, USC_FORM_PASSWORD_NEW_CONFIRM, USC_FORM_PREFIX, USC_FORM_REDIRECT_URL, USC_FORM_SECRET_QUESTION, USC_FORM_SECRET_QUESTION_ANSWER, USC_FORM_USERID, USC_FORM_USERID_AVAILABLE, USC_FORM_USERID_SEARCH, USC_REQUEST_CONTEXT_AUTH_GROUPS, USC_REQUEST_CONTEXT_AUTH_USERID, USC_REQUEST_CONTEXT_OPERATION_ID, USC_REQUEST_CONTEXT_TYPE, USC_SPS_OUTPUT_TYPE, USC_STS_CAPTCHA_HTML_STRING, USC_STS_INTERNAL_ENTITY_TYPE, USC_STS_INTERNAL_PREFIX, USC_STS_INTERNAL_REGISTRY_INPUT_TYPE, USC_STS_INTERNAL_REGISTRY_OUTPUT_TYPE, USC_STS_INTERNAL_SECRET_QUESTION_ATTR, USC_STS_INTERNAL_SECRET_QUESTION_OUTCOME, USC_STS_INTERNAL_SECRET_QUESTIONS, USC_STS_INTERNAL_SECRET_QUESTIONS_ANSWER, USC_STS_INTERNAL_SKIP_PASSWORD_CHECK, USC_STS_INTERNAL_TYPE, USC_STS_INTERNAL_VALIDATOR, USC_STS_OUTPUT_TYPE, USC_STS_RESPONSE_PAGEID, USC_STS_RESPONSE_REDIRECT_URL, USC_STS_RESPONSE_TERMINATE_SESSION, USC_USER_INPUT_TYPE, USC_USER_RECOVERABLE_ERROR, USC_USER_RECOVERABLE_ERROR_ATTRS, USC_USERAGENT_CHARENCODING, USC_USERAGENT_COOKIE_TYPE, USC_USERAGENT_HOSTNAME, USC_USERAGENT_HTTPHEADER_TYPE, USC_USERAGENT_IPADDR, USC_USERAGENT_LOCALES, USC_USERAGENT_METHOD, USC_USERAGENT_QUERY, USC_USERAGENT_TRANSPORT, USC_USERAGENT_TYPE, USC_USERAGENT_URI, USC_VALIDATION_URL

Constructor Summary

USCContextAttributesHelper(ContextAttributes ca)
This class will throw a NullPointerException if created with null input.

Method Summary

boolean	expectExpiredPassword() Returns TRUE if the incoming HTTP request included a form field indicating that the user's password is known to be expired This is for use with a point of contact server such as WebSEAL that delegates password change to USC.
java.util.Map	getAllCookies() Returns a Map consisting of String, String[] of all cookie names and values contained in the incoming HTTP request Attribute type: USC_USERAGENT_COOKIE_TYPE
java.util.Map	getAllHTTPHeaders() Returns a Map consisting of String, String[] of all HTTP names and values contained in the incoming request.
java.lang.String[]	getAuthenticatedGroups() Returns any groups associated with the identity authenticated by the point of contact.
java.lang.String	getAuthenticatedUserID() Returns the identity authenticated by the point of contact.
boolean	getCAPTCHAErrorMessageFlag() Consumed by the demonstration Captcha module.
ContextAttributes	getContextAttributes() Returns the underlying ContextAttributes object.
java.lang.String[]	getCookieValuesByName(java.lang.String name) Returns a specific cookie value contained in the incoming HTTP request Returns null if not found Attribute type: USC_USERAGENT_COOKIE_TYPE
java.lang.String	getEmailAddress() Returns the email address supplied by the end user Attribute type: USC_USER_INPUT_TYPE
java.lang.String	getEmailAddressConfirm() Returns the email address confirmation supplied by the end user Attribute type: USC_USER_INPUT_TYPE
java.lang.String[]	getHTTPHeaderValuesByName(java.lang.String name) Returns a specific header value contained in the incoming HTTP request Returns null if not found Attribute type: USC_USERAGENT_HTTPHEADER_TYPE
java.lang.String	getNewPassword() Returns the new password supplied by the end user Attribute type: USC_USER_INPUT_TYPE
java.lang.String	getNewPasswordConfirm() Returns the new password confirmation supplied by the end user in a form field.
java.lang.String	getNonce() Returns the nonce supplied by the end user Attribute type: USC_USER_INPUT_TYPE
java.lang.String	getOperationID() Returns the USC operation id being performed.
java.lang.String	getPassword() Returns the current password supplied by the end user Attribute type: USC_USER_INPUT_TYPE
java.util.Map	getRegistryInputAttributesMap() Returns a Map consisting of String, String[] of all input CAs containing attributes to be added to the registry.
java.lang.String[]	getRequestContextAttributeValues(java.lang.String name) Returns the array of values for attributes with the type: USC_REQUEST_CONTEXT_TYPE These are attributes provided the point of contact server or TFIM such as the authenticated user id.
java.lang.String[]	getSPSOutputAttributeValues(java.lang.String name) Returns the array of values for attributes with the type: USC_SPS_OUTPUT_TYPE These are attributes provided by the SPS for consumption by the STS.
java.lang.String[]	getSTSInternalAttributeValues(java.lang.String name) Returns the array of values for attributes with the type: USC_STS_INTERNAL_TYPE These attributes are provided by STS modules for consumption only by other STS modules.
java.lang.String[]	getSTSInternalEntityAttributeValues(java.lang.String name) Returns the array of values for attributes with the type: USC_INTERNAL_ENTITY_TYPE These attributes are used only between STS modules to communicate information about entity management operations.
java.lang.String[]	getSTSInternalRegistryInputAttributeValues(java.lang.String name) Returns the array of values for attributes with the type: USC_STS_INTERNAL_REGISTRY_INPUT_TYPE These are attributes to be added to the registry.
java.lang.String[]	getSTSInternalRegistryOutputAttributeValues(java.lang.String name) Returns the array of values for attributes with the type: USC_STS_INTERNAL_REGISTRY_OUTPUT_TYPE These are attributes to be retrieved from the registry.
java.lang.String	getSTSInternalSecretQuestionAttr() Returns a string representing the registry attribute name to use for secret question lookups.
boolean	getSTSInternalSecretQuestionOutcome() Returns the outcome of a secret question validation operation.
boolean	getSTSInternalSkipPasswordCheckFlag() Indicates to downstream STS modules to not perform password checking when performing certain operations, such as password update.
java.lang.String	getSTSInternalValidator() Returns a string representing the type of validation being performed to the messaging STS.
java.lang.String[]	getSTSOutputAttributeValues(java.lang.String name) Returns the array of values for attributes with the type: USC_STS_OUTPUT_TYPE These are attributes provided by STS modules for consumption by the SPS.
java.lang.String	getSTSOutputPageID() Returns the page that should be returned to the client.
java.lang.String	getSTSOutputRedirectURL() Returns a URL to which the client should be redirected.
boolean	getSTSOutputTerminateSession() Attribute type: USC_STS_OUTPUT_TYPE
java.lang.String[]	getUserAgentAttributeValues(java.lang.String name) Returns the array of values for attributes with the type: USC_USERAGENT_TYPE These are attributes provided indirectly by the end user in the incoming HTTP request such as IP address and URI.
java.lang.String	getUseragentCharEncoding() Returns the char-encoding http header value of the incoming HTTP request Attribute type: USC_USERAGENT_TYPE
java.lang.String	getUseragentHost() Returns the hostname of the client making the request Attribute type: USC_USERAGENT_TYPE
java.lang.String	getUseragentIPAddress() Returns the ip address of the client making the request Attribute type: USC_USERAGENT_TYPE
java.lang.String	getUseragentMethod() Returns the http method of the client making the request Attribute type: USC_USERAGENT_TYPE
java.lang.String	getUseragentQuery() Returns the query string component of the URI requested by the client Attribute type: USC_USERAGENT_TYPE
java.lang.String	getUseragentTransport() Returns the http transport of the client making the request Attribute type: USC_USERAGENT_TYPE
java.lang.String	getUseragentURI() Returns the URI requested by the client Attribute type: USC_USERAGENT_TYPE
java.lang.String	getUserID() Returns the user id supplied by the end user Attribute type: USC_USER_INPUT_TYPE
java.util.Map	getUserInputAttributesMap() Returns a Map consisting of String, String[] of all CAs containing user input.
java.lang.String[]	getUserInputAttributeValues(java.lang.String name) Returns the array of values for attributes with the type: USC_USER_INPUT_TYPE These are attributes provided directly by the end user.
java.util.Locale	getUserLocale() Return the client's preferred locale, if defined, or the default locale if not.
java.util.Locale[]	getUserLocales() Returns the array of Locales provided by the servletRequest.
boolean	getUserRecoverableError() Indicates if the STS has determined that a user recoverable error has occurred.
java.lang.String[]	getUserRecoverableErrorAttributes() Returns the set of attributes involved in a user-recoverable error Attribute type: USC_STS_OUTPUT_TYPE
java.lang.String	getUserRecoverableErrorMessage() Returns the error message for a user-recoverable error Attribute type: USC_STS_OUTPUT_TYPE
java.lang.String	getValidationURL() The URL that will be used to perform the validation operation.
void	removeContextAttribute(java.lang.String name, java.lang.String type) Removes a context attribute.
void	setAuthenticatedGroups(java.lang.String[] groups) This is intended for use by the SPS.
void	setAuthenticatedUserID(java.lang.String authuserid) This is intended for use by the SPS.
void	setCAPTCHAErrorMessageFlag(boolean errorMessageFlag) This must be only used by the SPS.
void	setCookie(java.lang.String name, java.lang.String value) This is intended for use by the SPS.
void	setEmailAddress(java.lang.String email) This is intended for use by the SPS.
void	setEmailAddressConfirm(java.lang.String email) This is intended for use by the SPS.
void	setHTTPHeader(java.lang.String name, java.lang.String[] values) This is intended for use by the SPS.
void	setLocales(java.util.Locale[] locales) This is intended for use by the SPS.
void	setMultiValuedContextAttribute(java.lang.String name, java.lang.String type, java.lang.String[] values) Add a new arbitrary context attribute.
void	setNewPassword(java.lang.String pwd) This is intended for use by the SPS.
void	setNewPasswordConfirm(java.lang.String pwd) This is intended for use by the SPS.
void	setNonce(java.lang.String nonce) This is intended for use by the SPS.
void	setOperationID(java.lang.String operationID) This is intended for use by the SPS.
void	setPassword(java.lang.String pwd) This is intended for use by the SPS.
void	setRequestContextAttribute(java.lang.String name, java.lang.String value) Sets an attribute with the type: USC_REQUEST_CONTEXT_TYPE This is intended for use by the SPS.
void	setRequestContextAttribute(java.lang.String name, java.lang.String[] values) Sets an attribute with the type: USC_REQUEST_CONTEXT_TYPE This is intended for use by the SPS.
void	setSPSOutputAttribute(java.lang.String name, java.lang.String value) Sets an attribute with the type: USC_SPS_OUTPUT_TYPE This must be only used by the SPS.
void	setSPSOutputAttribute(java.lang.String name, java.lang.String[] values) Sets an attribute with the type: USC_SPS_OUTPUT_TYPE This must be only used by the SPS.
void	setSTSInternalAttribute(java.lang.String attrName, java.lang.String value) Sets an attribute with the type: USC_STS_INTERNAL_TYPE This must be only used by the STS.
void	setSTSInternalAttribute(java.lang.String attrName, java.lang.String[] values) Sets an attribute with the type: USC_STS_INTERNAL_TYPE This must be only used by the STS.
void	setSTSInternalEntityAttribute(java.lang.String attrName, java.lang.String value) Sets an attribute with the type: USC_STS_INTERNAL_ENTITY_TYPE This must be only used by the STS.
void	setSTSInternalEntityAttribute(java.lang.String attrName, java.lang.String[] values) Sets an attribute with the type: USC_STS_INTERNAL_ENTITY_TYPE This must be only used by the STS.
void	setSTSInternalRegistryInputAttribute(java.lang.String attrName, java.lang.String value) Sets an attribute with the type: USC_STS_INTERNAL_REGISTRY_INPUT_TYPE This must be only used by the STS.
void	setSTSInternalRegistryInputAttribute(java.lang.String attrName, java.lang.String[] values) Sets an attribute with the type: USC_STS_INTERNAL_REGISTRY_INPUT_TYPE This must be only used by the STS.
void	setSTSInternalRegistryOutputAttribute(java.lang.String attrName, java.lang.String value) Sets an attribute with the type: USC_STS_INTERNAL_REGISTRY_OUTPUT_TYPE This must be only used by the STS.
void	setSTSInternalRegistryOutputAttribute(java.lang.String attrName, java.lang.String[] attrValues) Sets an attribute with the type: USC_STS_INTERNAL_REGISTRY_OUTPUT_TYPE This must be only used by the STS.
void	setSTSInternalSecretQuestionAttr(java.lang.String attr) This must be only used by the STS.
void	setSTSInternalSecretQuestionOutcome(boolean success) This must be only used by the STS.
void	setSTSInternalSkipPasswordCheck(boolean skip) This must be only used by the STS.
void	setSTSInternalValidator(java.lang.String vType) This must be only used by the STS.
void	setSTSOutputAttribute(java.lang.String name, java.lang.String value) Sets an attribute with the type: USC_STS_OUTPUT_TYPE This must be only used by the STS.
void	setSTSOutputAttribute(java.lang.String name, java.lang.String[] values) Sets an attribute with the type: USC_STS_OUTPUT_TYPE This must be only used by the STS.
void	setSTSOutputPageID(java.lang.String pageID) This must be only used by the STS.
void	setSTSOutputRedirectURL(java.lang.String url) This must be only used by the STS.
void	setSTSOutputTerminateSession() This must be only used by the STS.
void	setUserAgentAttribute(java.lang.String name, java.lang.String value) Sets an attribute with the type: USC_USERAGENT_TYPE This is intended for use by the SPS.
void	setUserAgentAttribute(java.lang.String name, java.lang.String[] values) Sets an attribute with the type: USC_USERAGENT_TYPE This is intended for use by the SPS.
void	setUseragentCharEncoding(java.lang.String charEncoding) This is intended for use by the SPS.
void	setUseragentHost(java.lang.String host) This is intended for use by the SPS.
void	setUseragentIPAddress(java.lang.String ipaddr) This is intended for use by the SPS.
void	setUseragentMethod(java.lang.String method) This is intended for use by the SPS.
void	setUseragentQuery(java.lang.String query) This is intended for use by the SPS.
void	setUseragentTransport(java.lang.String transport) This is intended for use by the SPS.
void	setUseragentURI(java.lang.String uri) This is intended for use by the SPS.
void	setUserID(java.lang.String userid) This is intended for use by the SPS.
void	setUserInputAttribute(java.lang.String name, java.lang.String value) Sets an attribute with the type: USC_USER_INPUT_TYPE This is intended for use by the SPS.
void	setUserInputAttribute(java.lang.String name, java.lang.String[] values) Sets an attribute with the type: USC_USER_INPUT_TYPE This is intended for use by the SPS.
void	setUserRecoverableError(java.lang.String error, java.util.Collection attrs) This must be only used by the STS.
void	setUserRecoverableError(java.lang.String error, java.lang.String[] attrs) This must be only used by the STS.
void	setValidationURL(java.lang.String validationURL) This must be only used by the SPS.

Methods inherited from class java.lang.Object

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

Field Detail

USCContextAttributesHelper_java_sourceCodeID

public static final java.lang.String USCContextAttributesHelper_java_sourceCodeID

See Also:

Constant Field Values

USCContextAttributesHelper_java_copyright

public static final java.lang.String USCContextAttributesHelper_java_copyright

See Also:

Constant Field Values

Constructor Detail

USCContextAttributesHelper

public USCContextAttributesHelper(ContextAttributes ca)

This class will throw a NullPointerException if created with null input.

Method Detail

getContextAttributes

public ContextAttributes getContextAttributes()

Returns the underlying ContextAttributes object.

Returns:

ContextAttributes

getUserAgentAttributeValues

public java.lang.String[] getUserAgentAttributeValues(java.lang.String name)

Returns the array of values for attributes with the type:
USC_USERAGENT_TYPE
These are attributes provided indirectly by the end user in the incoming HTTP request such as IP address and URI.
Returns null if any null input provided

There are direct accessor methods for most common useragent attributes. Use those in preference to this method.

Note that HTTP headers and Cookies have their own types.

Parameters:

name - name of attribute to retrieve

Returns:

array of values

getRequestContextAttributeValues

public java.lang.String[] getRequestContextAttributeValues(java.lang.String name)

Returns the array of values for attributes with the type:
USC_REQUEST_CONTEXT_TYPE
These are attributes provided the point of contact server or TFIM such as the authenticated user id.

There are direct accessor methods for the common request context attributes. Use those in preference to this method.

Returns null if any null input provided

Parameters:

name - name of attribute to retrieve

Returns:

array of values

getUserInputAttributeValues

public java.lang.String[] getUserInputAttributeValues(java.lang.String name)

Returns the array of values for attributes with the type:
USC_USER_INPUT_TYPE
These are attributes provided directly by the end user.

Returns null if any null input provided

Parameters:

name - name of attribute to retrieve

Returns:

array of values

getSPSOutputAttributeValues

public java.lang.String[] getSPSOutputAttributeValues(java.lang.String name)

Returns the array of values for attributes with the type:
USC_SPS_OUTPUT_TYPE
These are attributes provided by the SPS for consumption by the STS.

Parameters:

name - name of attribute to retrieve

Returns:

array of values

getSTSOutputAttributeValues

public java.lang.String[] getSTSOutputAttributeValues(java.lang.String name)

Returns the array of values for attributes with the type:
USC_STS_OUTPUT_TYPE
These are attributes provided by STS modules for consumption by the SPS.

Parameters:

name - name of attribute to retrieve

Returns:

array of values

getSTSInternalAttributeValues

public java.lang.String[] getSTSInternalAttributeValues(java.lang.String name)

Returns the array of values for attributes with the type:
USC_STS_INTERNAL_TYPE
These attributes are provided by STS modules for consumption only by other STS modules.

Parameters:

name - name of attribute to retrieve

Returns:

array of values

getSTSInternalRegistryInputAttributeValues

public java.lang.String[] getSTSInternalRegistryInputAttributeValues(java.lang.String name)

Returns the array of values for attributes with the type:
USC_STS_INTERNAL_REGISTRY_INPUT_TYPE
These are attributes to be added to the registry. They are only used between STS modules. They are translated to other attributes by the mapping module before being returned to the SPS.

Parameters:

name - name of attribute to retrieve

Returns:

array of values

getSTSInternalRegistryOutputAttributeValues

public java.lang.String[] getSTSInternalRegistryOutputAttributeValues(java.lang.String name)

Returns the array of values for attributes with the type:
USC_STS_INTERNAL_REGISTRY_OUTPUT_TYPE
These are attributes to be retrieved from the registry. They are only used between STS modules. They are translated to other attributes by the mapping module before being returned to the SPS

Parameters:

name - name of attribute to retrieve

Returns:

array of values

getSTSInternalEntityAttributeValues

public java.lang.String[] getSTSInternalEntityAttributeValues(java.lang.String name)

Returns the array of values for attributes with the type:
USC_INTERNAL_ENTITY_TYPE
These attributes are used only between STS modules to communicate information about entity management operations.

Parameters:

name - name of attribute to retrieve

Returns:

array of values

getUseragentIPAddress

public java.lang.String getUseragentIPAddress()

Returns the ip address of the client making the request

Attribute type: USC_USERAGENT_TYPE

getUseragentHost

public java.lang.String getUseragentHost()

Returns the hostname of the client making the request

Attribute type: USC_USERAGENT_TYPE

getUseragentTransport

public java.lang.String getUseragentTransport()

Returns the http transport of the client making the request

Attribute type: USC_USERAGENT_TYPE

getUseragentMethod

public java.lang.String getUseragentMethod()

Returns the http method of the client making the request

Attribute type: USC_USERAGENT_TYPE

getUseragentURI

public java.lang.String getUseragentURI()

Returns the URI requested by the client

Attribute type: USC_USERAGENT_TYPE

getUseragentQuery

public java.lang.String getUseragentQuery()

Returns the query string component of the URI requested by the client

Attribute type: USC_USERAGENT_TYPE

getUseragentCharEncoding

public java.lang.String getUseragentCharEncoding()

Returns the char-encoding http header value of the incoming HTTP request

Attribute type: USC_USERAGENT_TYPE

getUserLocales

public java.util.Locale[] getUserLocales()

Returns the array of Locales provided by the servletRequest. These are in order of user preference, with the most preferred first in the array.

If no locales were specified, returns the default locale as the first (and only) element in the array.

Attribute type: USC_USERAGENT_TYPE

getUserLocale

public java.util.Locale getUserLocale()

Return the client's preferred locale, if defined, or the default locale if not.

Attribute type: USC_USERAGENT_TYPE

getAllCookies

public java.util.Map getAllCookies()

Returns a Map consisting of String, String[] of all cookie names and values contained in the incoming HTTP request

Attribute type: USC_USERAGENT_COOKIE_TYPE

getCookieValuesByName

public java.lang.String[] getCookieValuesByName(java.lang.String name)

Returns a specific cookie value contained in the incoming HTTP request Returns null if not found

Attribute type: USC_USERAGENT_COOKIE_TYPE

getAllHTTPHeaders

public java.util.Map getAllHTTPHeaders()

Returns a Map consisting of String, String[] of all HTTP names and values contained in the incoming request.

Attribute type: USC_USERAGENT_HTTPHEADER_TYPE

getHTTPHeaderValuesByName

public java.lang.String[] getHTTPHeaderValuesByName(java.lang.String name)

Returns a specific header value contained in the incoming HTTP request Returns null if not found

Attribute type: USC_USERAGENT_HTTPHEADER_TYPE

getAuthenticatedUserID

public java.lang.String getAuthenticatedUserID()

Returns the identity authenticated by the point of contact.

Attribute type: USC_REQUEST_CONTEXT_TYPE

getAuthenticatedGroups

public java.lang.String[] getAuthenticatedGroups()

Returns any groups associated with the identity authenticated by the point of contact.

Attribute type: USC_REQUEST_CONTEXT_TYPE

getOperationID

public java.lang.String getOperationID()

Returns the USC operation id being performed. This is set by the SPS when evaluating the incoming request.

Attribute type: USC_REQUEST_CONTEXT_TYPE

getUserID

public java.lang.String getUserID()

Returns the user id supplied by the end user

Attribute type: USC_USER_INPUT_TYPE

getEmailAddress

public java.lang.String getEmailAddress()

Returns the email address supplied by the end user

Attribute type: USC_USER_INPUT_TYPE

getEmailAddressConfirm

public java.lang.String getEmailAddressConfirm()

Returns the email address confirmation supplied by the end user

Attribute type: USC_USER_INPUT_TYPE

getPassword

public java.lang.String getPassword()

Returns the current password supplied by the end user

Attribute type: USC_USER_INPUT_TYPE

getNewPassword

public java.lang.String getNewPassword()

Returns the new password supplied by the end user

Attribute type: USC_USER_INPUT_TYPE

getNewPasswordConfirm

public java.lang.String getNewPasswordConfirm()

Returns the new password confirmation supplied by the end user in a form field.

Attribute type: USC_USER_INPUT_TYPE

getNonce

public java.lang.String getNonce()

Returns the nonce supplied by the end user

Attribute type: USC_USER_INPUT_TYPE

expectExpiredPassword

public boolean expectExpiredPassword()

Returns TRUE if the incoming HTTP request included a form field indicating that the user's password is known to be expired

This is for use with a point of contact server such as WebSEAL that delegates password change to USC.

Attribute type: USC_USER_INPUT_TYPE

Returns:

true if the form included a field indicating that the user's password is known to have expired.

getUserInputAttributesMap

public java.util.Map getUserInputAttributesMap()

Returns a Map consisting of String, String[] of all CAs containing user input. This includes all query string and POST body inputs.

Attribute type: USC_USER_INPUT_TYPE

getValidationURL

public java.lang.String getValidationURL()

The URL that will be used to perform the validation operation. For example, this might be the URL sent to the user in an email that they will request to complete the enrollment.

Attribute type: USC_SPS_OUTPUT_TYPE

getCAPTCHAErrorMessageFlag

public boolean getCAPTCHAErrorMessageFlag()

Consumed by the demonstration Captcha module. Indicates that a previous captcha validation failed.

Attribute type: USC_SPS_OUTPUT_TYPE

getSTSInternalValidator

public java.lang.String getSTSInternalValidator()

Returns a string representing the type of validation being performed to the messaging STS. Valid values are defined in USCMessageConstants.java as *VALIDATION_MESSAGE

Attribute type: USC_STS_INTERNAL_TYPE

See Also:

com.tivoli.am.fim.trustserver.sts.modules.usc.message.USCMessageConstants

getSTSInternalSecretQuestionAttr

public java.lang.String getSTSInternalSecretQuestionAttr()

Returns a string representing the registry attribute name to use for secret question lookups.

Attribute type: USC_STS_INTERNAL_TYPE

getSTSInternalSecretQuestionOutcome

public boolean getSTSInternalSecretQuestionOutcome()

Returns the outcome of a secret question validation operation.

Attribute type: USC_STS_INTERNAL_TYPE

Returns:

True if the user successfully answered the secret question.

getSTSInternalSkipPasswordCheckFlag

public boolean getSTSInternalSkipPasswordCheckFlag()

Indicates to downstream STS modules to not perform password checking when performing certain operations, such as password update.

Attribute type: USC_STS_INTERNAL_TYPE

Returns:

True if the password checking operation should be skipped.

getSTSOutputRedirectURL

public java.lang.String getSTSOutputRedirectURL()

Returns a URL to which the client should be redirected.

Attribute type: USC_STS_OUTPUT_TYPE

getSTSOutputTerminateSession

public boolean getSTSOutputTerminateSession()

Attribute type: USC_STS_OUTPUT_TYPE

Returns:

True if the STS has determined that the user session should be terminated after the response is returned.

getSTSOutputPageID

public java.lang.String getSTSOutputPageID()

Returns the page that should be returned to the client. This is specified by the STS and consumed by the SPS.

Attribute type: USC_STS_OUTPUT_TYPE

getUserRecoverableError

public boolean getUserRecoverableError()

Indicates if the STS has determined that a user recoverable error has occurred.

Attribute type: USC_STS_OUTPUT_TYPE

Returns:

True if a user recoverable error has been flagged

getUserRecoverableErrorMessage

public java.lang.String getUserRecoverableErrorMessage()

Returns the error message for a user-recoverable error

Attribute type: USC_STS_OUTPUT_TYPE

getUserRecoverableErrorAttributes

public java.lang.String[] getUserRecoverableErrorAttributes()

Returns the set of attributes involved in a user-recoverable error

Attribute type: USC_STS_OUTPUT_TYPE

getRegistryInputAttributesMap

public java.util.Map getRegistryInputAttributesMap()

Returns a Map consisting of String, String[] of all input CAs containing attributes to be added to the registry.

Attribute type: USC_STS_INTERNAL_REGISTRY_INPUT_TYPE

setMultiValuedContextAttribute

public void setMultiValuedContextAttribute(java.lang.String name,
                                           java.lang.String type,
                                           java.lang.String[] values)

Add a new arbitrary context attribute.

USE THIS METHOD WITH CAUTION.
Use this only when the type is not known until runtime.
Otherwise, use an appropriate type-safe method.

Parameters:

name - if null, method does nothing

type - if null, method does nothing

value - if null, method does nothing

setUserAgentAttribute

public void setUserAgentAttribute(java.lang.String name,
                                  java.lang.String[] values)

Sets an attribute with the type:
USC_USERAGENT_TYPE


This is intended for use by the SPS.

Parameters:

name - name of attribute

values - array of values

See Also:

getUserAgentAttributeValues(String)

setUserAgentAttribute

public void setUserAgentAttribute(java.lang.String name,
                                  java.lang.String value)

Sets an attribute with the type:
USC_USERAGENT_TYPE


This is intended for use by the SPS.

Parameters:

name - name of attribute

value - single value

See Also:

getUserAgentAttributeValues(String)

setRequestContextAttribute

public void setRequestContextAttribute(java.lang.String name,
                                       java.lang.String[] values)

Sets an attribute with the type:
USC_REQUEST_CONTEXT_TYPE


This is intended for use by the SPS.

Parameters:

name - name of attribute

values - array of values

See Also:

getRequestContextAttributeValues(String)

setRequestContextAttribute

public void setRequestContextAttribute(java.lang.String name,
                                       java.lang.String value)

Sets an attribute with the type:
USC_REQUEST_CONTEXT_TYPE


This is intended for use by the SPS.

Parameters:

name - name of attribute

value - single value

See Also:

getRequestContextAttributeValues(String)

setUserInputAttribute

public void setUserInputAttribute(java.lang.String name,
                                  java.lang.String[] values)

Sets an attribute with the type:
USC_USER_INPUT_TYPE


This is intended for use by the SPS.

Parameters:

name - name of attribute

values - array of values

See Also:

getUserInputAttributeValues(String)

setUserInputAttribute

public void setUserInputAttribute(java.lang.String name,
                                  java.lang.String value)

Sets an attribute with the type:
USC_USER_INPUT_TYPE


This is intended for use by the SPS.

Parameters:

name - name of attribute

value - single value

See Also:

getUserInputAttributeValues(String)

setSPSOutputAttribute

public void setSPSOutputAttribute(java.lang.String name,
                                  java.lang.String[] values)

Sets an attribute with the type:
USC_SPS_OUTPUT_TYPE
This must be only used by the SPS.

Parameters:

name - name of attribute

values - array of values

See Also:

getSPSOutputAttributeValues(String)

setSPSOutputAttribute

public void setSPSOutputAttribute(java.lang.String name,
                                  java.lang.String value)

Sets an attribute with the type:
USC_SPS_OUTPUT_TYPE
This must be only used by the SPS.

Parameters:

name - name of attribute

value - single value

See Also:

getSPSOutputAttributeValues(String)

setSTSOutputAttribute

public void setSTSOutputAttribute(java.lang.String name,
                                  java.lang.String[] values)

Sets an attribute with the type:
USC_STS_OUTPUT_TYPE
This must be only used by the STS.

Parameters:

name - name of attribute

values - array of values

See Also:

getSTSOutputAttributeValues(String)

setSTSOutputAttribute

public void setSTSOutputAttribute(java.lang.String name,
                                  java.lang.String value)

Sets an attribute with the type:
USC_STS_OUTPUT_TYPE
This must be only used by the STS.

Parameters:

name - name of attribute

value - single value

See Also:

getSTSOutputAttributeValues(String)

setSTSInternalAttribute

public void setSTSInternalAttribute(java.lang.String attrName,
                                    java.lang.String[] values)

Sets an attribute with the type:
USC_STS_INTERNAL_TYPE
This must be only used by the STS.

Parameters:

name - name of attribute

values - array of values

See Also:

getSTSInternalAttributeValues(String)

setSTSInternalAttribute

public void setSTSInternalAttribute(java.lang.String attrName,
                                    java.lang.String value)

Sets an attribute with the type:
USC_STS_INTERNAL_TYPE
This must be only used by the STS.

Parameters:

name - name of attribute

value - single value

See Also:

getSTSInternalAttributeValues(String)

setSTSInternalRegistryInputAttribute

public void setSTSInternalRegistryInputAttribute(java.lang.String attrName,
                                                 java.lang.String[] values)

Sets an attribute with the type:
USC_STS_INTERNAL_REGISTRY_INPUT_TYPE
This must be only used by the STS.

Parameters:

name - name of attribute

values - array of values

See Also:

getSTSInternalRegistryInputAttributeValues(String)

setSTSInternalRegistryInputAttribute

public void setSTSInternalRegistryInputAttribute(java.lang.String attrName,
                                                 java.lang.String value)

Sets an attribute with the type:
USC_STS_INTERNAL_REGISTRY_INPUT_TYPE
This must be only used by the STS.

Parameters:

name - name of attribute

value - single value

See Also:

getSTSInternalRegistryInputAttributeValues(String)

setSTSInternalRegistryOutputAttribute

public void setSTSInternalRegistryOutputAttribute(java.lang.String attrName,
                                                  java.lang.String[] attrValues)

Sets an attribute with the type:
USC_STS_INTERNAL_REGISTRY_OUTPUT_TYPE
This must be only used by the STS.

Parameters:

name - name of attribute

values - array of values

See Also:

getSTSInternalRegistryOutputAttributeValues(String)

setSTSInternalRegistryOutputAttribute

public void setSTSInternalRegistryOutputAttribute(java.lang.String attrName,
                                                  java.lang.String value)

Sets an attribute with the type:
USC_STS_INTERNAL_REGISTRY_OUTPUT_TYPE
This must be only used by the STS.

Parameters:

name - name of attribute

value - single value

See Also:

getSTSInternalRegistryOutputAttributeValues(String)

setSTSInternalEntityAttribute

public void setSTSInternalEntityAttribute(java.lang.String attrName,
                                          java.lang.String[] values)

Sets an attribute with the type:
USC_STS_INTERNAL_ENTITY_TYPE
This must be only used by the STS.

Parameters:

name - name of attribute

values - array of values

See Also:

getSTSInternalEntityAttributeValues(String)

setSTSInternalEntityAttribute

public void setSTSInternalEntityAttribute(java.lang.String attrName,
                                          java.lang.String value)

Sets an attribute with the type:
USC_STS_INTERNAL_ENTITY_TYPE
This must be only used by the STS.

Parameters:

name - name of attribute

value - single value

See Also:

getSTSInternalEntityAttributeValues(String)

setUseragentIPAddress

public void setUseragentIPAddress(java.lang.String ipaddr)

This is intended for use by the SPS.

See Also:

getUseragentIPAddress()

setUseragentHost

public void setUseragentHost(java.lang.String host)

This is intended for use by the SPS.

See Also:

getUseragentHost()

setUseragentTransport

public void setUseragentTransport(java.lang.String transport)

This is intended for use by the SPS.

See Also:

getUseragentTransport()

setUseragentMethod

public void setUseragentMethod(java.lang.String method)

This is intended for use by the SPS.

See Also:

getUseragentMethod()

setUseragentURI

public void setUseragentURI(java.lang.String uri)

This is intended for use by the SPS.

See Also:

getUseragentURI()

setUseragentQuery

public void setUseragentQuery(java.lang.String query)

This is intended for use by the SPS.

See Also:

getUseragentQuery()

setUseragentCharEncoding

public void setUseragentCharEncoding(java.lang.String charEncoding)

This is intended for use by the SPS.

See Also:

getUseragentCharEncoding()

setLocales

public void setLocales(java.util.Locale[] locales)

This is intended for use by the SPS.

Creates a multi-valued context attribute to contain the locales. These must be added in order of preference.

See Also:

getUserLocales()

setHTTPHeader

public void setHTTPHeader(java.lang.String name,
                          java.lang.String[] values)

This is intended for use by the SPS.

Sets a specific HTTP header from the incoming HTTP request. HTTP Headers can be multi-valued. See HttpServletRequest.getHeaders()

Attribute type: USC_USERAGENT_HTTPHEADER_TYPE

setCookie

public void setCookie(java.lang.String name,
                      java.lang.String value)

This is intended for use by the SPS.

Sets a specific cookie from the incoming HTTP request.

Attribute type: USC_USERAGENT_COOKIE_TYPE

setUserID

public void setUserID(java.lang.String userid)

This is intended for use by the SPS.

See Also:

getUserID()

setEmailAddress

public void setEmailAddress(java.lang.String email)

This is intended for use by the SPS.

See Also:

getEmailAddress()

setEmailAddressConfirm

public void setEmailAddressConfirm(java.lang.String email)

This is intended for use by the SPS.

See Also:

getEmailAddressConfirm()

setPassword

public void setPassword(java.lang.String pwd)

This is intended for use by the SPS.

See Also:

getPassword()

setNewPassword

public void setNewPassword(java.lang.String pwd)

This is intended for use by the SPS.

See Also:

getNewPassword()

setNewPasswordConfirm

public void setNewPasswordConfirm(java.lang.String pwd)

This is intended for use by the SPS.

See Also:

getNewPasswordConfirm()

setNonce

public void setNonce(java.lang.String nonce)

This is intended for use by the SPS.

See Also:

getNonce()

setAuthenticatedUserID

public void setAuthenticatedUserID(java.lang.String authuserid)

This is intended for use by the SPS.

See Also:

getAuthenticatedUserID()

setAuthenticatedGroups

public void setAuthenticatedGroups(java.lang.String[] groups)

This is intended for use by the SPS.

See Also:

getAuthenticatedGroups()

setOperationID

public void setOperationID(java.lang.String operationID)

This is intended for use by the SPS.

See Also:

getOperationID()

setValidationURL

public void setValidationURL(java.lang.String validationURL)

This must be only used by the SPS.

See Also:

getValidationURL()

setCAPTCHAErrorMessageFlag

public void setCAPTCHAErrorMessageFlag(boolean errorMessageFlag)

This must be only used by the SPS.

See Also:

getCAPTCHAErrorMessageFlag()

setSTSOutputRedirectURL

public void setSTSOutputRedirectURL(java.lang.String url)

This must be only used by the STS.

See Also:

getSTSOutputRedirectURL()

setSTSOutputTerminateSession

public void setSTSOutputTerminateSession()

This must be only used by the STS.

See Also:

getSTSOutputTerminateSession()

setSTSOutputPageID

public void setSTSOutputPageID(java.lang.String pageID)

This must be only used by the STS.

See Also:

getSTSOutputPageID()

setUserRecoverableError

public void setUserRecoverableError(java.lang.String error,
                                    java.lang.String[] attrs)

This must be only used by the STS. Sets the user-recoverable error and associated attributes

This must be only used by the STS.

Parameters:

error - Error message to display to the user

attrs - Set of attributes involved in the error

See Also:

getUserRecoverableError(), getUserRecoverableError(), getUserRecoverableErrorAttributes()

setUserRecoverableError

public void setUserRecoverableError(java.lang.String error,
                                    java.util.Collection attrs)

This must be only used by the STS. Sets the user-recoverable error and associated attributes

Parameters:

error - Error message to display to the user

attrs - Collection of attributes involved in the error

See Also:

getUserRecoverableError(), getUserRecoverableErrorAttributes()

setSTSInternalValidator

public void setSTSInternalValidator(java.lang.String vType)

This must be only used by the STS.

See Also:

getSTSInternalValidator()

setSTSInternalSecretQuestionAttr

public void setSTSInternalSecretQuestionAttr(java.lang.String attr)

This must be only used by the STS.

See Also:

getSTSInternalSecretQuestionAttr()

setSTSInternalSecretQuestionOutcome

public void setSTSInternalSecretQuestionOutcome(boolean success)

This must be only used by the STS.

See Also:

getSTSInternalSecretQuestionOutcome()

setSTSInternalSkipPasswordCheck

public void setSTSInternalSkipPasswordCheck(boolean skip)

This must be only used by the STS.

See Also:

getSTSInternalSkipPasswordCheckFlag()

removeContextAttribute

public void removeContextAttribute(java.lang.String name,
                                   java.lang.String type)

Removes a context attribute. The type MUST be specified. Specifying null for the type will not remove attributes that have a non-null type.