atg.userprofiling.restresources

Class CurrentUserAddressRestSubresource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.userprofiling.restresources.AddressRestSubresource

atg.userprofiling.restresources.CurrentUserAddressRestSubresource

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, UpdateableRestResource, java.util.EventListener

@RestResource(id="atg.userprofiling.restresources.currentUserAddressRestSubresource")
public class CurrentUserAddressRestSubresource
extends AddressRestSubresource
implements UpdateableRestResource

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	INVALID_QUERY_PARAMS
static java.lang.String	RESOURCE_NAME
protected static java.util.ResourceBundle	sResourceBundle The resource bundle.

Fields inherited from class atg.userprofiling.restresources.AddressRestSubresource

EMPTY, mProfileTools, 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
CurrentUserAddressRestSubresource()

Method Summary

Modifier and Type	Method and Description
RepresentationModel	addAddress(org.json.JSONObject pInputJson) It adds the address.
protected Address	createAddress(RepositoryItem pItem, java.util.Map<java.lang.String,java.lang.String> pAddressMap) It creates the address object which includes existing address information along with update address information supplied in inputs.
Response	deleteAddress(java.lang.String pAddressId) Removes a specific address from the user's address book.
Response	deleteAddresses(java.lang.String pTypesAndNames) Delete addresses (using type and nickname) from the current user.
protected java.lang.String	getAddressNickname(java.util.Map pAddressUpdates, Address pAddress) This method attempts to retrieve a 'nickname' property from the pAddressUpdates parameter.
protected java.util.Map<java.lang.String,java.lang.String>	getTypesAndNames(java.lang.String pTypeAndName) Gets the types and names from the comma separated input.
java.net.URI	update(atg.service.jaxrs.ResourceUpdateInfo pRestResourceUpdateInfo) This method handles updates contained with pRestResourceUpdateInfo.
RepresentationModel	updateAddress(java.lang.String pAddressId, org.json.JSONObject pInputJson) Updates an address associated with the current user profile.
RepresentationModel	updateAddresses(org.json.JSONObject pInputJson) Using the PATCH Merge protocol add/remove/update addresses belonging to the CurrentUser.

Methods inherited from class atg.userprofiling.restresources.AddressRestSubresource

buildMemberLinks, getAddress, getAddress, getAddresses, getProfile, getProfileTools, getRepresentationModelBuilder, getRepresentationModelBuilder, getSelfLink, getTypeAndName, getTypeAndName, 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

Methods inherited from interface atg.service.jaxrs.restresources.UpdateableRestResource

updateEmbeddedResources

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

See Also:

Constant Field Values

INVALID_QUERY_PARAMS

public static final java.lang.String INVALID_QUERY_PARAMS

See Also:

Constant Field Values

sResourceBundle

protected static java.util.ResourceBundle sResourceBundle

The resource bundle.

Constructor Detail

CurrentUserAddressRestSubresource

public CurrentUserAddressRestSubresource()

Method Detail

deleteAddress

@Endpoint(id="/addresses/{addressId}#DELETE",
          isSingular=true)
public Response deleteAddress(java.lang.String pAddressId)
                                                                                                throws RestException,
                                                                                                       RepositoryException

Removes a specific address from the user's address book. If the (unique) address is used for multiple address types, both addresses will be removed from the user's address book.

Parameters:

pAddressId - the unique id of the address

Returns:

the response indicating success/fail of delete

Throws:

RestException - if an error occurs deleting the address

RepositoryException - if an error occurs deleting the address

deleteAddresses

@Endpoint(id="/addresses/typesAndNames#DELETE")
public Response deleteAddresses(java.lang.String pTypesAndNames)
                                                                         throws RestException,
                                                                                RepositoryException

Delete addresses (using type and nickname) from the current user.

Parameters:

pTypesAndNames - the 'types and names' should be passed together as comma separated values i.e. homeAddress.My Home Address etc.

Returns:

response indicating success/fail of delete

Throws:

RestException - if an error occurs deleting the addresses

RepositoryException - if an error occurs deleting the addresses

addAddress

@Endpoint(id="/addresses/#POST",
          validatorId="addresses.id-Full",
          filterId="addresses.id-Default",
          disableChangeTracking=true)
public RepresentationModel addAddress(org.json.JSONObject pInputJson)
                                                                                                                                                                                            throws RestException,
                                                                                                                                                                                                   RepositoryException,
                                                                                                                                                                                                   java.lang.InstantiationException,
                                                                                                                                                                                                   java.lang.IllegalAccessException,
                                                                                                                                                                                                   java.lang.ClassNotFoundException,
                                                                                                                                                                                                   java.beans.IntrospectionException

It adds the address. It checks whether an address already exist or not using the type and nickname. if it does not exist then it adds the new address otherwise it throws an error message.

Parameters:

pInputJson - JSON representation of the address to be added

Returns:

representation of the address that was added

Throws:

RestException - if an error occurs adding the address

RepositoryException - if an error occurs adding the address

java.lang.InstantiationException - if an error occurs adding the address

java.lang.IllegalAccessException - if an error occurs adding the address

java.lang.ClassNotFoundException - if an error occurs adding the address

java.beans.IntrospectionException - if an error occurs adding the address

updateAddress

@PATCH
 @Endpoint(id="/addresses/{addressId}#PATCH",
          isSingular=true,
          validatorId="addresses.id-Full",
          filterId="addresses.id-Full",
          updateTarget=true)
public RepresentationModel updateAddress(java.lang.String pAddressId,
                                                                                                                                                                                                                                         org.json.JSONObject pInputJson)
                                                                                                                                                                                                                                  throws RestException

Updates an address associated with the current user profile.

Parameters:

pAddressId - id of the address to update

pInputJson - representation of address updates to apply

Returns:

the representation model containing the updated address

Throws:

RestException - if something went wrong updating the address

updateAddresses

@PATCH
 @Endpoint(id="/addresses/#PATCH",
          validatorId="addresses-Full",
          filterId="addresses-Default")
public RepresentationModel updateAddresses(org.json.JSONObject pInputJson)
                                                                                                                                                              throws RestException

Using the PATCH Merge protocol add/remove/update addresses belonging to the CurrentUser. The protocol states:

• If an item is not in the input data, then it is removed from the addresses collection.
• If the item id is in the input data, with no other properties, then it remains in the addresses collection untouched.
• If the item id is in the input data, alongside other properties, it is an update to the item within the addresses collection.
• If the item has no id property, and other properties exist, then the item is an add to the addresses collection.

Parameters:

pInputJson - JSON representation of the updated addresses to be updated

Returns:

the representation model containing the updated addresses

Throws:

RestException - if something went wrong updating the addresses

getTypesAndNames

protected java.util.Map<java.lang.String,java.lang.String> getTypesAndNames(java.lang.String pTypeAndName)

Gets the types and names from the comma separated input.

Parameters:

pTypeAndName - the type and name

Returns:

the type and name

createAddress

protected Address createAddress(RepositoryItem pItem,
                                java.util.Map<java.lang.String,java.lang.String> pAddressMap)
                         throws java.lang.InstantiationException,
                                java.lang.IllegalAccessException,
                                java.lang.ClassNotFoundException,
                                java.beans.IntrospectionException

It creates the address object which includes existing address information along with update address information supplied in inputs.

Parameters:

pItem - the item

pAddressMap - the address map

Returns:

the update address

Throws:

java.lang.InstantiationException - the instantiation exception

java.lang.IllegalAccessException - the illegal access exception

java.lang.ClassNotFoundException - the class not found exception

java.beans.IntrospectionException - the introspection exception

update

public java.net.URI update(atg.service.jaxrs.ResourceUpdateInfo pRestResourceUpdateInfo)
                    throws RestException

This method handles updates contained with pRestResourceUpdateInfo. It will inspect its memberUpdateInfos for updates to the collection (addresses). Based on the update type (added/changed/removed), the members of the collection (addresses) and as a result, the whole collection will be modified.

Specified by:

update in interface UpdateableRestResource

Parameters:

pRestResourceUpdateInfo - - addresses collection update object, containing update data (request inputs and any existing repository data) to be applied to the collection's members.

Returns:

URI - self link to any newly created item, or null if none created

Throws:

RestException - - if an issue occurs performing the update.

getAddressNickname

protected java.lang.String getAddressNickname(java.util.Map pAddressUpdates,
                                              Address pAddress)

This method attempts to retrieve a 'nickname' property from the pAddressUpdates parameter.

Parameters:

pAddressUpdates - Map of address properties, including nickname

pAddress - Address object of address being created/updated.

Returns:

String unique nickname for current user's addresses