atg.userprofiling.restresources

Class AddressRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.userprofiling.restresources.AddressRestSubresource

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:

CurrentUserAddressRestSubresource

@RestResource(id="atg.userprofiling.restresources.addressRestSubresource")
public class AddressRestSubresource
extends GenericService

This class is a sub-resource of the user resource and cannot exist on its own. It provides all the get operations for an address sub resource. It also allows to access all the addresses for a user.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected static java.lang.String	EMPTY
ProfileTools	mProfileTools The profile tools.
protected static java.lang.String	TYPE_AND_NAME

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

Method Summary

Modifier and Type	Method and Description
protected Link[]	buildMemberLinks(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> pMembers) Build the members URIs for the given list of addresses.
protected RepositoryItem	getAddress(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> pAddresses, java.lang.String pAddressId) Searches for and returns an address in the given map of address, based on the given id.
RepresentationModel	getAddress(java.lang.String pAddressId) Gets the address for a user.
RepresentationModel	getAddresses(java.lang.String pType) Returns all (or specified type) the addresses in the user's address book.
protected RepositoryItem	getProfile() Returns the profile, which is retrieved from the rest request data.
ProfileTools	getProfileTools() Returns the profileTools component.
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> pMembers) Gets the RepresentationModel.Builder with the given map of addresses 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.
protected Link	getSelfLink(java.lang.String pItemId, java.lang.String pParam, java.lang.String pValue) Build a self link for the item resource.
protected java.lang.String	getTypeAndName(java.util.Map<java.lang.String,java.lang.String> pMap) Gets the type and name as homeAddress.My Home Address etc.
protected java.lang.String	getTypeAndName(java.lang.String pType, java.lang.String pName) Builds a type and name string for an address, in the format: homeAddress.My Home Address
void	setProfileTools(ProfileTools 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

TYPE_AND_NAME

protected static final java.lang.String TYPE_AND_NAME

See Also:

Constant Field Values

EMPTY

protected static final java.lang.String EMPTY

See Also:

Constant Field Values

mProfileTools

public ProfileTools mProfileTools

The profile tools.

Constructor Detail

AddressRestSubresource

public AddressRestSubresource()

Method Detail

setProfileTools

public void setProfileTools(ProfileTools pProfileTools)

Sets the profileTools component.

Parameters:

pProfileTools - The profileTools component

getProfileTools

public ProfileTools getProfileTools()

Returns the profileTools component.

Returns:

the profileTools component

getAddresses

@Endpoint(id="/addresses#GET",
          isSingular=false,
          filterId="addresses-Default")
public RepresentationModel getAddresses(java.lang.String pType)
                                                                                                                                    throws RestException

Returns all (or specified type) the addresses in the user's address book.

Parameters:

pType - the address type (homeAddress). If pType not passed in then all the addresses are returned.

Returns:

collection of addresses

Throws:

RestException - if an error occurred retrieving the addresses

getAddress

@Endpoint(id="/addresses/{addressId}#GET",
          isSingular=true,
          filterId="addresses.id-Default")
public RepresentationModel getAddress(java.lang.String pAddressId)
                                                                                                                                                throws RestException

Gets the address for a user.

Parameters:

pAddressId - the unique id of the address

Returns:

the address

Throws:

RestException - if an error occurred whilst retrieving the address

getTypeAndName

protected java.lang.String getTypeAndName(java.lang.String pType,
                                          java.lang.String pName)

Builds a type and name string for an address, in the format: homeAddress.My Home Address

Parameters:

pType - the address type

pName - the address name

Returns:

a type and name string for an address

getTypeAndName

protected java.lang.String getTypeAndName(java.util.Map<java.lang.String,java.lang.String> pMap)

Gets the type and name as homeAddress.My Home Address etc.

Parameters:

pMap - the map

Returns:

the type and name

getProfile

protected RepositoryItem getProfile()
                             throws RestException

Returns the profile, which is retrieved from the rest request data.

Returns:

the profile

Throws:

RestException - if the profile is not found in the rest request data

getAddress

protected RepositoryItem getAddress(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> pAddresses,
                                    java.lang.String pAddressId)
                             throws RestException

Searches for and returns an address in the given map of address, based on the given id.

Parameters:

pAddresses - a map of addresses

pAddressId - the id of the address that we wish to find

Returns:

the address

Throws:

RestException - if the address could not be found

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.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> pMembers)
                                                             throws RestException

Gets the RepresentationModel.Builder with the given map of addresses 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

buildMemberLinks

protected Link[] buildMemberLinks(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> pMembers)
                           throws RestException

Build the members URIs for the given list of addresses.

Parameters:

pMembers - a map of address from which to build the member URIs

Returns:

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

Throws:

RestException - if a problem occurred whilst building the member URIs

getSelfLink

protected Link getSelfLink(java.lang.String pItemId,
                           java.lang.String pParam,
                           java.lang.String pValue)

Build a self link for the item resource. Optionally adds a parameter.

Parameters:

pItemId - item id from which to build the self link

pParam - name of parameter to be added to the link

pValue - value for the parameter

Returns:

self link for the given item