atg.commerce.profile.restresources

Class CurrentUserCreditCardRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.profile.restresources.CreditCardRestSubresource

atg.commerce.profile.restresources.CurrentUserCreditCardRestSubresource

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

@RestResource(id="atg.commerce.profile.restresources.CurrentUserCreditCardRestSubresource")
public class CurrentUserCreditCardRestSubresource
extends CreditCardRestSubresource

This class extends the credit card rest sub resource api to provide support for the add, delete and update operations on a credit card for the current user. It also allows to access all the credit cards for a current user.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADDRESS_NICK_NAME
static java.lang.String	BILLING_ADDRESS_CLASSNAME
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	MSG_ADDRESS_WITH_NICK_NAME_NOT_FOUND
static java.lang.String	MSG_CREDIT_CARD_NICKNAME_EXISTS
static java.lang.String	RESOURCE_NAME
static java.lang.String	SET_AS_DEFAULT
static java.util.ResourceBundle	sResourceBundle Resource Bundle
static java.lang.String	USE_EXISTING_ADDRESS

Fields inherited from class atg.commerce.profile.restresources.CreditCardRestSubresource

mProfileTools, MSG_ERR_MATCHING_CREDIT_CARD, MSG_NO_CREDIT_CARD_FOUND, SUBRESOURCE_CONTEXT_MISSING

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
CurrentUserCreditCardRestSubresource()

Method Summary

Modifier and Type	Method and Description
RepresentationModel	addCreditCard(org.json.JSONObject pInputJson) Creates a credit card with the given properties and adds it to the given user profile.
protected java.lang.String	addCreditCardToProfile(RepositoryItem pProfile, java.util.Map pUpdatesMap, CommercePropertyManager pCommercePropertyManager) Create credit card item based on updatesMap and add it to the profile.
Response	deleteCreditCard(java.lang.String pCreditCardId) Removes a credit card associated to a given profile for a given credit card id.
protected java.net.URI	getCreatedItemURI(java.lang.String pCreditCardNickname) Build a URI to the newly added/created credit card.
protected Link	getSelfLink(RepositoryItem pProfile, RepositoryItem pCreditCard) Build a self link to the credit card.
protected void	removeCreditCardFromProfile(RepositoryItem pProfile, RepositoryItem pCreditCard) Method to remove a credit card from the given profile based on the nickname.
protected java.lang.Object	retrieveBillingAddress(java.util.Map pInputJSONMap, RepositoryItem pProfile, CommercePropertyManager pCommercePropertyManager) Get the billingAddress from the input json.
RepresentationModel	updateCreditCard(java.lang.String pCreditCardId, org.json.JSONObject pInputJson) Updates a credit card associated with the current user profile.
RepresentationModel	updateCreditCards(org.json.JSONObject pInputJson) Updates one or more credit cards associated with the given user profile.
protected void	updateProfileCreditCard(RepositoryItem pProfile, RepositoryItem pCardToUpdate, java.util.Map pUpdatesMap, CommercePropertyManager pCommercePropertyManager) This method updates a credit card associated with the given user profile.

Methods inherited from class atg.commerce.profile.restresources.CreditCardRestSubresource

buildMemberUris, getCreditCard, getCreditCards, getProfile, getProfileTools, getRepresentationModelBuilder, getRepresentationModelBuilder, setProfileTools

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

MSG_CREDIT_CARD_NICKNAME_EXISTS

public static final java.lang.String MSG_CREDIT_CARD_NICKNAME_EXISTS

See Also:

Constant Field Values

MSG_ADDRESS_WITH_NICK_NAME_NOT_FOUND

public static final java.lang.String MSG_ADDRESS_WITH_NICK_NAME_NOT_FOUND

See Also:

Constant Field Values

USE_EXISTING_ADDRESS

public static final java.lang.String USE_EXISTING_ADDRESS

See Also:

Constant Field Values

SET_AS_DEFAULT

public static final java.lang.String SET_AS_DEFAULT

See Also:

Constant Field Values

ADDRESS_NICK_NAME

public static final java.lang.String ADDRESS_NICK_NAME

See Also:

Constant Field Values

BILLING_ADDRESS_CLASSNAME

public static final java.lang.String BILLING_ADDRESS_CLASSNAME

See Also:

Constant Field Values

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

See Also:

Constant Field Values

sResourceBundle

public static java.util.ResourceBundle sResourceBundle

Resource Bundle

Constructor Detail

CurrentUserCreditCardRestSubresource

public CurrentUserCreditCardRestSubresource()

Method Detail

deleteCreditCard

@Endpoint(id="/creditCards/{creditCardId}#DELETE",
          isSingular=true)
public Response deleteCreditCard(java.lang.String pCreditCardId)
                                                                                                        throws RestException,
                                                                                                               RepositoryException

Removes a credit card associated to a given profile for a given credit card id.

Parameters:

pCreditCardId - the id of the credit card which has to be removed from the profile

Returns:

response with no content if the credit card is successfully removed from the profile

Throws:

RestException - if an error occurs deleting the credit card

RepositoryException - if an error occurs deleting the credit card

addCreditCard

@Endpoint(id="/creditCards#POST",
          validatorId="creditCards.id-Full",
          filterId="creditCards.id-Default",
          disableChangeTracking=true)
public RepresentationModel addCreditCard(org.json.JSONObject pInputJson)
                                                                                                                                                                                                    throws RestException,
                                                                                                                                                                                                           RepositoryException,
                                                                                                                                                                                                           java.beans.IntrospectionException,
                                                                                                                                                                                                           PropertyNotFoundException

Creates a credit card with the given properties and adds it to the given user profile.

Parameters:

pInputJson - JSON representation of the credit card to be added

Returns:

the representation model corresponding to the newly added credit card

Throws:

RestException - if an error occurs adding the credit card

RepositoryException - if an error occurs adding the credit card

java.beans.IntrospectionException - if an error occurs adding the credit card

PropertyNotFoundException - if an error occurs adding the credit card

updateCreditCard

@PATCH
 @Endpoint(id="/creditCards/{creditCardId}#PATCH",
          isSingular=true,
          validatorId="creditCards.id-Full",
          updateTarget=true)
public RepresentationModel updateCreditCard(java.lang.String pCreditCardId,
                                                                                                                                                                                                           org.json.JSONObject pInputJson)
                                                                                                                                                                                                    throws RestException,
                                                                                                                                                                                                           RepositoryException

Updates a credit card associated with the current user profile.

Parameters:

pCreditCardId - id of credit card to update

pInputJson - representation of credit card updates to apply

Returns:

the representation model containing the updated credit card

Throws:

RestException - if an error occurs updating the credit card

RepositoryException - if an error occurs updating the credit card

updateCreditCards

@PATCH
 @Endpoint(id="/creditCards#PATCH",
          filterId="creditCards-Default",
          validatorId="creditCards-Full",
          isSingular=false)
public RepresentationModel updateCreditCards(org.json.JSONObject pInputJson)
                                                                                                                                                                                                 throws RestException,
                                                                                                                                                                                                        java.beans.IntrospectionException,
                                                                                                                                                                                                        RepositoryException,
                                                                                                                                                                                                        java.lang.InstantiationException,
                                                                                                                                                                                                        java.lang.IllegalAccessException,
                                                                                                                                                                                                        java.lang.ClassNotFoundException,
                                                                                                                                                                                                        PropertyNotFoundException

Updates one or more credit cards associated with the given user profile. This endpoint can remove, update or create a credit card as part of the (patch collection) update. Items in the collection containing the id property along with the some other properties are considered for update. Items containing all the required properties except the id are considered for create and all other the items are removed from the collection.

Parameters:

pInputJson - JSON representation of the credit cards to be updated

Returns:

the representation model containing the updated list of credit cards

Throws:

RestException - if an error occurs updating/adding/deleting a credit card

java.beans.IntrospectionException - if an error occurs updating/adding/deleting a credit card

RepositoryException - if an error occurs updating/adding/deleting a credit card

java.lang.InstantiationException - if an error occurs updating/adding/deleting a credit card

java.lang.IllegalAccessException - if an error occurs updating/adding/deleting a credit card

java.lang.ClassNotFoundException - if an error occurs updating/adding/deleting a credit card

PropertyNotFoundException - if an error occurs updating/adding/deleting a credit card

updateProfileCreditCard

protected void updateProfileCreditCard(RepositoryItem pProfile,
                                       RepositoryItem pCardToUpdate,
                                       java.util.Map pUpdatesMap,
                                       CommercePropertyManager pCommercePropertyManager)
                                throws RestException,
                                       RepositoryException,
                                       java.lang.InstantiationException,
                                       java.lang.IllegalAccessException,
                                       java.lang.ClassNotFoundException,
                                       java.beans.IntrospectionException

This method updates a credit card associated with the given user profile.

Parameters:

pProfile - the profile to which credit card is mapped

pCardToUpdate - the credit card item to be updated

pUpdatesMap - the map containing the properties to be updated for the credit card

pCommercePropertyManager - the CommercePropertyManager component containing the property names

Throws:

RestException - if an error occurs updating a credit card

java.beans.IntrospectionException - if an error occurs updating a credit card

RepositoryException - if an error occurs updating a credit card

java.lang.InstantiationException - if an error occurs updating a credit card

java.lang.IllegalAccessException - if an error occurs updating a credit card

java.lang.ClassNotFoundException - if an error occurs updating a credit card

addCreditCardToProfile

protected java.lang.String addCreditCardToProfile(RepositoryItem pProfile,
                                                  java.util.Map pUpdatesMap,
                                                  CommercePropertyManager pCommercePropertyManager)
                                           throws RestException,
                                                  RepositoryException,
                                                  java.beans.IntrospectionException,
                                                  PropertyNotFoundException

Create credit card item based on updatesMap and add it to the profile. UpdatesMap contains all the required properties for creating the credit card item.

Parameters:

pProfile - the profile to which credit card will to be added

pUpdatesMap - the map containing the credit card properties

pCommercePropertyManager - the CommercePropertyManager component containing the property names

Returns:

Nickname of the credit card added to the profile

Throws:

RestException - if an error occurs adding the credit card to the user profile

RepositoryException - if an error occurs adding the credit card to the user profile

java.beans.IntrospectionException - if an error occurs adding the credit card to the user profile

PropertyNotFoundException - if an error occurs adding the credit card to the user profile

removeCreditCardFromProfile

protected void removeCreditCardFromProfile(RepositoryItem pProfile,
                                           RepositoryItem pCreditCard)
                                    throws RestException,
                                           RepositoryException

Method to remove a credit card from the given profile based on the nickname.

Parameters:

pProfile - the profile from which credit card is removed

pCreditCard - the credit card item to be removed from the profile

Throws:

RestException - if an error occurs removing a credit card from the user profile

RepositoryException - if an error occurs removing a credit card from the user profile

retrieveBillingAddress

protected java.lang.Object retrieveBillingAddress(java.util.Map pInputJSONMap,
                                                  RepositoryItem pProfile,
                                                  CommercePropertyManager pCommercePropertyManager)
                                           throws RestException

Get the billingAddress from the input json. If useExistingAddress is false then billingAddress property is available in the json,

Throws:

RestException - if billingAddress is not found with given nickname

getCreatedItemURI

protected java.net.URI getCreatedItemURI(java.lang.String pCreditCardNickname)

Build a URI to the newly added/created credit card.

Parameters:

pCreditCardNickname - Credit card nickname

Returns:

URI to newly created credit card else null to indicate no item was added/created

getSelfLink

protected Link getSelfLink(RepositoryItem pProfile,
                           RepositoryItem pCreditCard)

Build a self link to the credit card.

Parameters:

pProfile - - the profile to which the credit card is mapped.

pCreditCard - - the credit card item to build a self link to.

Returns:

self link to credit card.