com.ibm.commerce.browseradapter

Class SSOTokenProcessor

java.lang.Object

com.ibm.commerce.browseradapter.SSOTokenProcessor

public class SSOTokenProcessor
extends java.lang.Object

This class provides a set of utility methods that wrap the activity token to form an SSO token. The SSO token is an encrypted activity token that contains a time stamp when the token is generated.

• The SSO token will be generated only if the value of the ActivityToken/ActivityTokenBasedAuthentication flag is set to 'true' in the instance configuration file.
• The SSO token will expire depending on the value set for ActivityToken/expiryTime in the instance configuration file.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Constructor Summary

Constructors

Constructor and Description
SSOTokenProcessor()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildSSOToken(ActivityToken token) Generates a token for single sign-on.
static java.lang.String	retrieveLogonId(java.lang.String ssoToken) Retrieves the logonId of the user for whom the ssoToken was created.
static ActivityToken	validateSSOToken(java.lang.String ssoToken) Verifies if the single sign-on token is valid.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

SSOTokenProcessor

public SSOTokenProcessor()

Method Detail

buildSSOToken

public static java.lang.String buildSSOToken(ActivityToken token)
                                      throws ServiceException

Generates a token for single sign-on. This token contains a time stamp + the ActivityToken in a string format.

Parameters:

token - using which the SSO token will be built

Returns:

The single sign-on token.

Throws:

ServiceException - if the ActivityToken is not valid

validateSSOToken

public static ActivityToken validateSSOToken(java.lang.String ssoToken)
                                      throws ECSystemException,
                                             BusinessContextServiceException

Verifies if the single sign-on token is valid. If it is valid, then returns the corresponding activity token, otherwise returns null.

Parameters:

ssoToken - single sign-on token

Returns:

ActivityToken if the ssoToken is valid, otherwise null.

Throws:

ECSystemException - if the ssoToken is not valid.

BusinessContextServiceException - if the signature is corrupted

retrieveLogonId

public static java.lang.String retrieveLogonId(java.lang.String ssoToken)
                                        throws BusinessContextServiceException,
                                               ECSystemException

Retrieves the logonId of the user for whom the ssoToken was created. This method also checks if the SSOToken is valid.

Parameters:

ssoToken -

Returns:

The logonId of the user if the ssoToken is valid, otherwise null.

Throws:

BusinessContextServiceException

ECSystemException