com.ibm.commerce.rest.member.handler

Class PersonContactHandler

java.lang.Object

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

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

com.ibm.commerce.rest.member.handler.PersonContactHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/person/@self/contact")
 @Encoded
public class PersonContactHandler
extends AbstractResourceHandler

This class provides RESTful services to get Contact details, register a person as a member and update a member.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTACT_MAPPING_KEY Resource mapping key for contact
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	FORMAT_GROUP_NAME The constant FORMAT_GROUP_NAME
static java.lang.String	PARAMETER_ADDRESS_ID Parameter constant for address ID
static java.lang.String	PARAMETER_ADDRESS_ID_DESCRIPTION Parameter description constants for address ID
static java.lang.String	PARAMETER_ADDRESS_TYPE Parameter constant for address type
static java.lang.String	PARAMETER_ADDRESS_TYPE_DESCRIPTION Parameter description constants for address type
static java.lang.String	PARAMETER_NICKNAME Parameter constant for nickname
static java.lang.String	PARAMETER_NICKNAME_DESCRIPTION Parameter description constants for nickname
static java.lang.String	RESOURCE_NAME Resource name for person
static java.lang.String	SINGLE_CONTACT_MAPPING_KEY The constant SINGLE_CONTACT_MAPPING_KEY

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
PersonContactHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addPersonContact(java.lang.String storeId, java.lang.String responseFormat) This method performs a AddPersonContact to he shopper's addressBook.
javax.ws.rs.core.Response	deletePersonContact(java.lang.String storeId, java.lang.String nickName, java.lang.String responseFormat) Delete a Contact for a registered shopper.
javax.ws.rs.core.Response	findPersonContactById(java.lang.String storeId, java.lang.String addressId, java.lang.String responseFormat) This method retrieve a person contact by address id.
javax.ws.rs.core.Response	findPersonContactByNickName(java.lang.String storeId, java.lang.String nickName, java.lang.String responseFormat) This method retrieve a person contact by nick name.
javax.ws.rs.core.Response	getAllPersonContact(java.lang.String storeId, java.lang.String addressType, java.lang.String responseFormat) Get contacts in a person's address book.
java.lang.String	getExternalResourceName() Get the resource name to show externally.
java.lang.String	getFormattingGroupName() This method returns the format group name to locate JSP template.
PersonHelper	getHelper() This method returns the BOD helper used to get product data
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	updatePersonContact(java.lang.String storeId, java.lang.String nickName, java.lang.String responseFormat) Update person contact data for a shopper.

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

Resource name for person

See Also:

Constant Field Values

CONTACT_MAPPING_KEY

public static final java.lang.String CONTACT_MAPPING_KEY

Resource mapping key for contact

See Also:

Constant Field Values

SINGLE_CONTACT_MAPPING_KEY

public static final java.lang.String SINGLE_CONTACT_MAPPING_KEY

The constant SINGLE_CONTACT_MAPPING_KEY

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

PARAMETER_ADDRESS_TYPE

public static final java.lang.String PARAMETER_ADDRESS_TYPE

Parameter constant for address type

See Also:

Constant Field Values

PARAMETER_ADDRESS_TYPE_DESCRIPTION

public static final java.lang.String PARAMETER_ADDRESS_TYPE_DESCRIPTION

Parameter description constants for address type

See Also:

Constant Field Values

PARAMETER_ADDRESS_ID

public static final java.lang.String PARAMETER_ADDRESS_ID

Parameter constant for address ID

See Also:

Constant Field Values

PARAMETER_ADDRESS_ID_DESCRIPTION

public static final java.lang.String PARAMETER_ADDRESS_ID_DESCRIPTION

Parameter description constants for address ID

See Also:

Constant Field Values

PARAMETER_NICKNAME

public static final java.lang.String PARAMETER_NICKNAME

Parameter constant for nickname

See Also:

Constant Field Values

PARAMETER_NICKNAME_DESCRIPTION

public static final java.lang.String PARAMETER_NICKNAME_DESCRIPTION

Parameter description constants for nickname

See Also:

Constant Field Values

Constructor Detail

PersonContactHandler

public PersonContactHandler()

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()

This method returns the format group name to locate JSP template.

Specified by:

getFormattingGroupName in interface IResourceHandler

Overrides:

getFormattingGroupName in class AbstractBaseResourceHandler

Returns:

formatting group name

getHelper

public PersonHelper getHelper()

This method returns the BOD helper used to get product data

Returns:

PersonHelper

getAllPersonContact

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

Get contacts in a person's address book. If optional query parameter addressType is passed in, the returned contacts will be filtered by addressType.

Parameters:

storeId - store ID

addressType - address type.

responseFormat - response format.

Returns:

Response

findPersonContactById

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

This method retrieve a person contact by address id.

Parameters:

storeId - store ID

addressId - address id.

responseFormat - response format.

Returns:

The Contact in the specified format.

findPersonContactByNickName

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

This method retrieve a person contact by nick name.

Parameters:

storeId - the store Id.

nickName - the contact name saved in addressBook by registered shopper.

responseFormat - the response format (xml, json, or atom).

Returns:

The Contact in the specified format.

addPersonContact

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

This method performs a AddPersonContact to he shopper's addressBook.

Parameters:

storeId - the store Id.

responseFormat - the response format (xml, json, or atom).

Returns:

A map of String [] that contains the following response parameters: resourceId, resourceType, userId, addressId

updatePersonContact

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

Update person contact data for a shopper. Because this method will change person's addressId, we use nickName to identify the person contact.

Parameters:

storeId - store id

nickName - nick name

responseFormat - response format

Returns:

Response the Response

deletePersonContact

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

Delete a Contact for a registered shopper. The shopper must log in before invoking this method.

Parameters:

storeId - the store id

nickName - the nick name

responseFormat - the response format

Returns:

the response

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.