com.ibm.commerce.rest.member.handler

Class UserContextHandler

java.lang.Object

com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

com.ibm.commerce.foundation.rest.resourcehandler.AbstractResourceHandler

com.ibm.commerce.rest.member.handler.UserContextHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/usercontext")
public class UserContextHandler
extends AbstractResourceHandler

This class provides REST API to get the user context of a shopper.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_SPLIT_TOKEN
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	FORMAT_GROUP_NAME Deprecated. Replaced by UserContextHandler.
static java.lang.String	GLOBALIZATION_CONTEXT
static java.lang.String	RESOURCE_NAME The Constant RESOURCE_NAME.

Fields inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

APPLICATION_ATOM_XML, APPLICATION_JSON, APPLICATION_XHTML_XML, APPLICATION_XML, CHANGE_VERB, PARAMETER_ACTION, PARAMETER_ACTION_DESCRIPTION, PARAMETER_CATALOG_ID, PARAMETER_CATALOG_ID_DESCRIPTION, PARAMETER_CURRENCY, PARAMETER_CURRENCY_DESCRIPTION, PARAMETER_FOR_USER, PARAMETER_FOR_USER_DESCRIPTION, PARAMETER_FOR_USER_ID, PARAMETER_FOR_USER_ID_DESCRIPTION, PARAMETER_LANG_ID, PARAMETER_LANG_ID_DESCRIPTION, PARAMETER_LOCALE, PARAMETER_LOCALE_DESCRIPTION, PARAMETER_MODE, PARAMETER_MODE_DESCRIPTION, PARAMETER_PAGE_NUMBER, PARAMETER_PAGE_NUMBER_DESCRIPTION, PARAMETER_PAGE_SIZE, PARAMETER_PAGE_SIZE_DESCRIPTION, PARAMETER_PROFILE_NAME, PARAMETER_PROFILE_NAME_DESCRIPTION, PARAMETER_QUERY, PARAMETER_QUERY_DESCRIPTION, PARAMETER_RESET_PASSWORD_DESCRIPTION, PARAMETER_RESPONSE_FORMAT, PARAMETER_RESPONSE_FORMAT_DESCRIPTION, PARAMETER_STORE_ID, PARAMETER_STORE_ID_DESCRIPTION, PARAMETER_WORKSPACE_IDENTIFIER, PARAMETER_WORKSPACE_IDENTIFIER_DESCRIPTION, PARAMETER_WORKSPACE_NAME, PARAMETER_WORKSPACE_NAME_DESCRIPTION, PARAMETER_WORKSPACE_TASK, PARAMETER_WORKSPACE_TASK_DESCRIPTION, PARAMETER_WORKSPACE_TASKGROUP, PARAMETER_WORKSPACE_TASKGROUP_DESCRIPTION, PROCESS_VERB, RESPONSE_200_DESCRIPTION, RESPONSE_201_DESCRIPTION, RESPONSE_204_DESCRIPTION, RESPONSE_400_DESCRIPTION, RESPONSE_401_DESCRIPTION, RESPONSE_403_DESCRIPTION, RESPONSE_404_DESCRIPTION, RESPONSE_500_DESCRIPTION

Constructor Summary

Constructors

Constructor and Description
UserContextHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getContextData(java.lang.String storeId, java.lang.String responseFormat) This method returns the context data for a user from the tokens and cookies sent with the request.
java.util.Map	getContextDataMap(java.lang.String storeId, java.lang.Long userId) Gets the context data from the tokens and cookies for this request.
java.lang.String	getExternalResourceName() Get the resource name to show externally.
java.lang.String	getFormattingGroupName() Returns the formatting group name for resolving the struts action of the formatting JSP.
javax.ws.rs.core.Response	getPersonalizationID(java.lang.String storeId, java.lang.String responseFormat) This method returns personalization id.
java.lang.String	getResourceName() This method returns the name of the resource used primarily to determine the representation of the resource.

Methods inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractResourceHandler

createMapForProvider, createMapForProvider, generateResponseForEntireDataObject, getMapFromRequest, getStoreId, getUserId, isRequestInPreviewMode, mergeMapsForProvider, prepareAndValidate

Methods inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

addError, createMapForProviderWithResultData, documentApi, generateResponseFromHttpStatusCodeAndRespData, getActionRegistry, getBooleanParameterValue, getClassDescription, getDoubleParameterValue, getDoubleParameterValues, getEnumeratedParameterValue, getErrorCodeFromMessage, getFormattedMessage, getFormattedMessageWithLocale, getInstrumentor, getIntegerParameterValue, getIntegerParameterValues, getLongParameterValue, getLongParameterValues, getParameterValue, getParameterValue, getParameterValues, getQueryRegistry, getRequest, getResponse, getUriInfo, handleException, initializeActionRegistry, initializeQueryRegistry, performAction, postProcess, preProcess, registerOperationWithMethodSignature, runQuery, staticConvertStreamToString, throwInvalidQueryNameException, throwInvalidQueryNameException, throwRestException, throwRestExceptionIfErrorsAreDetected, validatePageNumberPageSize

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

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

The Constant RESOURCE_NAME.

See Also:

Constant Field Values

FORMAT_GROUP_NAME

public static final java.lang.String FORMAT_GROUP_NAME

Deprecated. Replaced by UserContextHandler.

The constant FORMAT_GROUP_NAME. Replaced by UserContextHandler.getFormattingGroupName()

See Also:

Constant Field Values

GLOBALIZATION_CONTEXT

public static final java.lang.String GLOBALIZATION_CONTEXT

See Also:

Constant Field Values

CONTENT_SPLIT_TOKEN

public static final java.lang.String CONTENT_SPLIT_TOKEN

See Also:

Constant Field Values

Constructor Detail

UserContextHandler

public UserContextHandler()

Method Detail

getResourceName

public java.lang.String getResourceName()

Description copied from interface: IResourceHandler

This method returns the name of the resource used primarily to determine the representation of the resource. This class can be overridden to change the name of the resource and therefore the representation, while keeping all the methods in this class.

Returns:

the resource name

getFormattingGroupName

public java.lang.String getFormattingGroupName()

Description copied from class: AbstractBaseResourceHandler

Returns the formatting group name for resolving the struts action of the formatting JSP. Overwrite this method in your resource handler class to return a formatting group name specific to your resource handler.

Specified by:

getFormattingGroupName in interface IResourceHandler

Overrides:

getFormattingGroupName in class AbstractBaseResourceHandler

Returns:

the formatting group name.

getPersonalizationID

@GET
 @Path(value="personalizationId")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response getPersonalizationID(@PathParam(value="storeId")
                                                                                                                                                                                                     java.lang.String storeId,
                                                                                                                                                                                                     @QueryParam(value="responseFormat")
                                                                                                                                                                                                     java.lang.String responseFormat)

This method returns personalization id. If WCToken is passed in HTTP header, it returns personalization ID based on WCToken. Otherwise, it returns a personalization ID for a generic user.

Parameters:

storeId - the store id

responseFormat - the response format

Returns:

the personalization id

getContextData

@GET
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
 @Path(value="@self/contextdata")
public javax.ws.rs.core.Response getContextData(@PathParam(value="storeId")
                                                                                                                                                                                               java.lang.String storeId,
                                                                                                                                                                                               @QueryParam(value="responseFormat")
                                                                                                                                                                                               java.lang.String responseFormat)

This method returns the context data for a user from the tokens and cookies sent with the request.

Parameters:

storeId - the store id

responseFormat - the response format

Returns:

the context data map for the current user

getContextDataMap

public java.util.Map getContextDataMap(java.lang.String storeId,
                                       java.lang.Long userId)
                                throws QueryServiceApplicationException,
                                       java.sql.SQLException,
                                       java.lang.NumberFormatException,
                                       BusinessContextServiceException,
                                       java.io.IOException,
                                       javax.security.auth.callback.UnsupportedCallbackException

Gets the context data from the tokens and cookies for this request.

Parameters:

storeId - The current store Id

userId - The user Id obtained from the cookies and tokens

Returns:

The context data map associated with the tokens and cookies for this request.

Throws:

QueryServiceApplicationException - If a query fails.

java.sql.SQLException - If a database query fails.

java.lang.NumberFormatException - If parsing fails.

BusinessContextServiceException - If the request fails.

java.io.IOException - If reading the activity token fails.

javax.security.auth.callback.UnsupportedCallbackException - If reading the activity token fails.

getExternalResourceName

public java.lang.String getExternalResourceName()

Description copied from class: AbstractBaseResourceHandler

Get the resource name to show externally. This defaults to the value returned by getResourceName if this method isn't overridden.

Overrides:

getExternalResourceName in class AbstractBaseResourceHandler

Returns:

The external resource name.