com.ibm.commerce.rest.marketing.handler

Class EventHandler

java.lang.Object

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

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

com.ibm.commerce.foundation.rest.resourcehandler.AbstractClassicResourceHandler

com.ibm.commerce.rest.marketing.handler.EventHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/event")
 @Encoded
public class EventHandler
extends com.ibm.commerce.foundation.rest.resourcehandler.AbstractClassicResourceHandler
implements IResourceHandler

This handler triggers Marketing code based on certain type of events, like CategoryDisplay, ProductDisplay etc.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	EMARKETING_SPOT_ID The Constant EMARKETING_SPOT_ID
static java.lang.String	FORMAT_GROUP_NAME The constant FORMAT_GROUP_NAME.
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
EventHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	evaluateTriggers(java.lang.String storeId, java.lang.String responseFormat) Evaluate triggers sent from remote server, and then record or send valid triggers.
javax.ws.rs.core.Response	getBehaviorRules(java.lang.String storeId, java.lang.String astrResponseFormat) Retrieve all the user behavior rules
java.lang.String	getFormattingGroupName() Returns the formatting group name for resolving the struts action of the formatting JSP.
java.lang.String	getResourceName() This method returns the name of the resource used primarily to determine the representation of the resource.
javax.ws.rs.core.Response	handleClickInfo(java.lang.String storeId, java.lang.String responseFormat)
javax.ws.rs.core.Response	triggerMarketing(java.lang.String storeId, java.lang.String responseFormat) Trigger marketing based on certain events.

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, getExternalResourceName, 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

Methods inherited from interface com.ibm.commerce.foundation.rest.resourcehandler.IResourceHandler

generateResponseFromHttpStatusCodeAndRespData, postProcess, preProcess

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

The constant FORMAT_GROUP_NAME.

See Also:

Constant Field Values

EMARKETING_SPOT_ID

public static final java.lang.String EMARKETING_SPOT_ID

The Constant EMARKETING_SPOT_ID

See Also:

Constant Field Values

Constructor Detail

EventHandler

public EventHandler()

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.

Specified by:

getResourceName in interface IResourceHandler

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.

triggerMarketing

@POST
public javax.ws.rs.core.Response triggerMarketing(@PathParam(value="storeId")
                                                        java.lang.String storeId,
                                                        @QueryParam(value="responseFormat")
                                                        java.lang.String responseFormat)

Trigger marketing based on certain events. The shopper must log in before invoking this method.

Parameters:

storeId - the store id

responseFormat - the response format shortcut(e.g, json, xml)

Returns:

the response

getBehaviorRules

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

Retrieve all the user behavior rules

Parameters:

astrResponseFormat - the response format shortcut(e.g, json, xml)

Returns:

the formatted user behavior rules

evaluateTriggers

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

Evaluate triggers sent from remote server, and then record or send valid triggers.

Parameters:

storeId - the store id

responseFormat - the response format shortcut(e.g, json, xml)

Returns:

the response

handleClickInfo

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