atg.commerce.profile.restresources

Class CreditCardRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.profile.restresources.CreditCardRestSubresource

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

Direct Known Subclasses:

CurrentUserCreditCardRestSubresource

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

This class implements the credit card rest resources which will be used to expose the credit card related services.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
CommerceProfileTools	mProfileTools
static java.lang.String	MSG_ERR_MATCHING_CREDIT_CARD
static java.lang.String	MSG_NO_CREDIT_CARD_FOUND
static java.lang.String	RESOURCE_NAME
static java.util.ResourceBundle	sResourceBundle Resource bundle
static java.lang.String	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
CreditCardRestSubresource()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String[]	buildMemberUris(java.util.Collection<RepositoryItem> pMembers, <any> pQueryParams) Build the members URIs for the given list of items of type RepositoryItem.
RepresentationModel	getCreditCard(java.lang.String pCreditCardId, java.lang.String pNickname) Returns the singular credit card resource for the current profile and for a given credit card id.
RepresentationModel	getCreditCards() Returns all the credit cards associated to the given user profile.
protected RepositoryItem	getProfile() Retrieves the current profile and makes sure there is one.
CommerceProfileTools	getProfileTools() Returns the profileTools component
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.util.Collection<RepositoryItem> pMembers) Gets the RepresentationModel.Builder with the given collection of RepositoryItems being used to build member URIs.
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.lang.Object pState) Gets the RepresentationModel.Builder with the given object acting as the state.
void	setProfileTools(CommerceProfileTools pProfileTools) Sets the profileTools component

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

SUBRESOURCE_CONTEXT_MISSING

public static final java.lang.String SUBRESOURCE_CONTEXT_MISSING

See Also:

Constant Field Values

MSG_NO_CREDIT_CARD_FOUND

public static final java.lang.String MSG_NO_CREDIT_CARD_FOUND

See Also:

Constant Field Values

MSG_ERR_MATCHING_CREDIT_CARD

public static final java.lang.String MSG_ERR_MATCHING_CREDIT_CARD

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

mProfileTools

public CommerceProfileTools mProfileTools

Constructor Detail

CreditCardRestSubresource

public CreditCardRestSubresource()

Method Detail

setProfileTools

public void setProfileTools(CommerceProfileTools pProfileTools)

Sets the profileTools component

Parameters:

pProfileTools - The profileTools component

getProfileTools

public CommerceProfileTools getProfileTools()

Returns the profileTools component

Returns:

the profileTools component

getCreditCard

@Endpoint(id="/creditCards/{creditCardId}#GET",
          isSingular=true,
          filterId="creditCards.id-Default")
public RepresentationModel getCreditCard(java.lang.String pCreditCardId,
                                                                                                                                                                 java.lang.String pNickname)
                                                                                                                                                          throws RestException,
                                                                                                                                                                 RepositoryException

Returns the singular credit card resource for the current profile and for a given credit card id.

Parameters:

pCreditCardId - the id of the credit card for which the resource has to be retrieved

pNickname - the nickname of the credit card for which the resource has to be retrieved This is an optional input query parameter.

Returns:

the credit card resource representation model

Throws:

RestException - if an internal server error occurs

RepositoryException

getCreditCards

@Endpoint(id="/creditCards/#GET",
          isSingular=false,
          filterId="creditCards-Default")
public RepresentationModel getCreditCards()
                                                                                                                                           throws RestException

Returns all the credit cards associated to the given user profile.

Returns:

the representation model corresponding to the credit cards

Throws:

RestException - if an internal server error occurs

getProfile

protected RepositoryItem getProfile()
                             throws RestException

Retrieves the current profile and makes sure there is one.

Returns:

the profile for the current request

Throws:

RestException - if there is a problem obtaining the profile

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.lang.Object pState)

Gets the RepresentationModel.Builder with the given object acting as the state.

Parameters:

pState - the state that will be added to the representation model

Returns:

RepresentationModel.Builder containing the state

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.util.Collection<RepositoryItem> pMembers)
                                                             throws RestException

Gets the RepresentationModel.Builder with the given collection of RepositoryItems being used to build member URIs.

Parameters:

pMembers - the members that will be added to the representation model

Returns:

RepresentationModel.Builder containing the member uris

Throws:

RestException - if the member URIs could not be built

buildMemberUris

protected java.lang.String[] buildMemberUris(java.util.Collection<RepositoryItem> pMembers,
                                             <any> pQueryParams)
                                      throws RestException

Build the members URIs for the given list of items of type RepositoryItem.

Parameters:

pMembers - the list of repository items from which to build the member URIs

pQueryParams - optional map of query param key/value pairs to be added to any built uris, null if none

Returns:

an array of URI's where each element represents a GET URI

Throws:

RestException - if a problem occurred whilst building the member URIs