atg.service.jaxrs

Class HypermediaJSONMessageBodyWriter

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.jaxrs.HypermediaJSONMessageBodyWriter

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, atg.servlet.StateMessageBodyWriter<org.json.JSONObject>, java.util.EventListener

public abstract class HypermediaJSONMessageBodyWriter
extends GenericService
implements atg.servlet.StateMessageBodyWriter<org.json.JSONObject>

This class provides a base message body writer implementation for hypermedia types. The default uses the oracle rest standards but classes can extend this class to create their own hypermedia types. Although there are no abstract methods this class is not intended to be instantiated since there are no jaxrs annotations, therefore it is marked as abstract.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HypermediaJSONMessageBodyWriter.EmbeddedResourceFilterConfig Utility inner class to help process embedded resource model filtering context.
static class	HypermediaJSONMessageBodyWriter.MediaKey Enum of possible Media field types

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected atg.service.jaxrs.JSONService	mJsonService property: mJsonService
protected RelationsRegistry	mRelationsRegistry property: mRelationsRegistry
protected atg.service.jaxrs.ResourceLookupService	mResourceLookupService Resource lookup service that allows us to invoke a member uri directly
protected atg.security.OPSSCipherSigningService	mSigningService The signing service used to create a signing key for state data.

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

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionalState(org.json.JSONObject pResponseJSON, RepresentationModel pModel, org.json.JSONObject pAdditionalStateJSON) Adds the given additional state JSON to the overall response JSON.
protected void	addEmbeddedResources(org.json.JSONObject pResponseJSON, RepresentationModel pModel, org.json.JSONObject pEmbeddedResourcesJSON) Adds the given embedded resources JSON object to the overall response JSON.
protected void	addEmbeddedSelfLinks(java.util.List<java.lang.String> pUris, org.json.JSONArray pEmbeddedArray) Adds self links for 'expand=false' members where only the self link is added to the response.
protected void	addLinks(org.json.JSONObject pResponseJSON, RepresentationModel pModel, org.json.JSONObject pLinksJSON) Add the given links JSON object to the overall response JSON.
protected void	addMembers(org.json.JSONObject pResponseJSON, RepresentationModel pModel, org.json.JSONObject pMembersJSON) Adds the given members JSON object to the overall response JSON object.
protected void	addProperties(org.json.JSONObject pResponseJSON, RepresentationModel pModel, org.json.JSONObject pPropertiesJSON) Adds the given properties JSON to the overall response JSON
protected void	addState(org.json.JSONObject pResponseJSON, RepresentationModel pModel, org.json.JSONObject pStateJSON) Adds the given state JSON to the overall response JSON.
protected org.json.JSONObject	convertModelToJson(RepresentationModel pModel, atg.service.payloadschema.filter.FilteringContext pFilteringContext) Method to convert a model to json.
protected org.json.JSONObject	convertToMediaType(RepresentationModel pModel, atg.service.payloadschema.filter.FilteringContext pFilteringContext) This method reads the Representation Model object and responsible for converting the object into the json response.
atg.service.payloadschema.filter.FilteringManager	getFilteringManager() Gets the filtering manager
atg.service.jaxrs.JSONService	getJSONService() Returns the JSONService
protected java.lang.String	getMediaKeyName(HypermediaJSONMessageBodyWriter.MediaKey pMediaKey) Gets the media specific field name to use for the given media field type key
atg.service.payloadschema.filter.OutputProducer	getOutputProducer() Returns a JSON output producer to be used to produce JSON representations of objects whose state is to be written in message body.
RelationsRegistry	getRelationsRegistry() Returns the RelationsRegistry
atg.service.jaxrs.ResourceLookupService	getResourceLookupService() Returns the resource lookup service that allows us to invoke a member uri directly
atg.security.OPSSCipherSigningService	getSigningService() Returns the signing service used to create a signing key for state data.
long	getSize(java.lang.Object pObject, java.lang.Class<?> pType, java.lang.reflect.Type pGenericType, java.lang.annotation.Annotation[] pAnnotations, MediaType pMediaType) get the size of the returned data
protected org.json.JSONArray	handleEmbeddedResourceModels(RepresentationModel pParentModel, java.lang.String pRel, java.util.List<RepresentationModel> pModels, atg.service.payloadschema.filter.FilteringContext pParentFilteringContext) Method to create a JSON array for the given embedded resource models and relation name.
protected org.json.JSONObject	handleEmbeddedResources(RepresentationModel pModel, atg.service.payloadschema.filter.FilteringContext pFilteringContext) Construct JSON output for the embedded resources in the representation model.
protected org.json.JSONArray	handleEmbeddedResourceUris(java.lang.String pRel, java.util.List<java.lang.String> pUris, atg.service.payloadschema.filter.FilteringContext pParentFilteringContext, boolean pCrossRegistryUris) Method to create a JSON array for the given embedded resource uris and relation name.
protected org.json.JSONObject	handleLinks(RepresentationModel pModel, atg.service.payloadschema.filter.FilteringContext pFilteringContext) Method to generate a JSON object for the links in the given representation model.
protected org.json.JSONObject	handleMembers(RepresentationModel pModel, atg.service.payloadschema.filter.FilteringContext pFilteringContext) Method to create a JSON object for the members of a collection resource by processing the given representation model.
protected RepresentationModel	handleResponseURIPath(RepresentationModel pModel, atg.service.payloadschema.filter.FilteringContext pFilteringContext) A response uri was set so we need to invoke a GET of that uri to get the model we want to build our response on.
protected org.json.JSONObject	handleState(RepresentationModel pModel, atg.service.payloadschema.filter.FilteringContext pFilteringContext) Method to generate a JSON object for the state within the given representation model.
boolean	isWriteable(java.lang.Class<?> pType, java.lang.reflect.Type pGenericType, java.lang.annotation.Annotation[] pAnnotations, MediaType pMediaType) Checks to see if this provider can write the given type.
void	setFilteringManager(atg.service.payloadschema.filter.FilteringManager pFilteringManager) Sets the filtering manager
void	setJSONService(atg.service.jaxrs.JSONService pJsonService) Sets the JSONService
void	setRelationsRegistry(RelationsRegistry pRelationsRegistry) Set the RelationsRegistry
void	setResourceLookupService(atg.service.jaxrs.ResourceLookupService pResourceLookupService) Set the resource lookup service that allows us to invoke a member uri directly
void	setSigningService(atg.security.OPSSCipherSigningService pSigningService) Sets the signing service used to create a signing key for state data.
void	writeState(java.util.Map<java.lang.String,org.json.JSONObject> pKeyToStateString)
void	writeTo(java.lang.Object pObject, java.lang.Class<?> pType, java.lang.reflect.Type pGenericType, java.lang.annotation.Annotation[] pAnnotations, MediaType pMediaType, <any> pHttpHeaders, java.io.OutputStream pEntityStream)

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

mJsonService

protected atg.service.jaxrs.JSONService mJsonService

property: mJsonService

mRelationsRegistry

protected RelationsRegistry mRelationsRegistry

property: mRelationsRegistry

mResourceLookupService

protected atg.service.jaxrs.ResourceLookupService mResourceLookupService

Resource lookup service that allows us to invoke a member uri directly

mSigningService

protected atg.security.OPSSCipherSigningService mSigningService

The signing service used to create a signing key for state data.

Constructor Detail

HypermediaJSONMessageBodyWriter

public HypermediaJSONMessageBodyWriter()

Method Detail

setJSONService

public void setJSONService(atg.service.jaxrs.JSONService pJsonService)

Sets the JSONService

Parameters:

pJsonService - the service to convert the object to json

getJSONService

public atg.service.jaxrs.JSONService getJSONService()

Returns the JSONService

Returns:

mJsonService the service to convert the object to json

getRelationsRegistry

public RelationsRegistry getRelationsRegistry()

Returns the RelationsRegistry

Returns:

the registry containing the relation name definitions

setRelationsRegistry

public void setRelationsRegistry(RelationsRegistry pRelationsRegistry)

Set the RelationsRegistry

Parameters:

pRelationsRegistry - the registry containing the relation name definition

getFilteringManager

public atg.service.payloadschema.filter.FilteringManager getFilteringManager()

Gets the filtering manager

Returns:

the filtering manager

setFilteringManager

public void setFilteringManager(atg.service.payloadschema.filter.FilteringManager pFilteringManager)

Sets the filtering manager

Parameters:

pFilteringManager - new filtering manager

getResourceLookupService

public atg.service.jaxrs.ResourceLookupService getResourceLookupService()

Returns the resource lookup service that allows us to invoke a member uri directly

Returns:

the resource lookup service

setResourceLookupService

public void setResourceLookupService(atg.service.jaxrs.ResourceLookupService pResourceLookupService)

Set the resource lookup service that allows us to invoke a member uri directly

Parameters:

pResourceLookupService - resource lookup service that allows us to invoke a member uri directly

getSigningService

public atg.security.OPSSCipherSigningService getSigningService()

Returns the signing service used to create a signing key for state data.

Returns:

the signing service.

setSigningService

public void setSigningService(atg.security.OPSSCipherSigningService pSigningService)

Sets the signing service used to create a signing key for state data.

Parameters:

pSigningService - the signing service.

getMediaKeyName

protected java.lang.String getMediaKeyName(HypermediaJSONMessageBodyWriter.MediaKey pMediaKey)

Gets the media specific field name to use for the given media field type key

Parameters:

pMediaKey - Media field type key

Returns:

Media type specific name to use

convertToMediaType

protected org.json.JSONObject convertToMediaType(RepresentationModel pModel,
                                                 atg.service.payloadschema.filter.FilteringContext pFilteringContext)
                                          throws org.json.JSONException

This method reads the Representation Model object and responsible for converting the object into the json response. In addition it generates the links and if there are any embedded properties it includes the embedded resource representations in the main response by using internal requests. Links are added to the main json response under the property _links and embedded resources are included under property _embedded.

Parameters:

pModel - the java object containing the response returned by endpoint.

pFilteringContext - context data for current filtering operation

Returns:

JSONObject representing the HAL supported json response

Throws:

org.json.JSONException - if some property is not able to inserted into the json response

handleState

protected org.json.JSONObject handleState(RepresentationModel pModel,
                                          atg.service.payloadschema.filter.FilteringContext pFilteringContext)
                                   throws org.json.JSONException

Method to generate a JSON object for the state within the given representation model.

Parameters:

pModel - Representation model with state to process

pFilteringContext - Filtering context to apply to the state

Returns:

JSON object for the state

Throws:

org.json.JSONException

handleLinks

protected org.json.JSONObject handleLinks(RepresentationModel pModel,
                                          atg.service.payloadschema.filter.FilteringContext pFilteringContext)
                                   throws org.json.JSONException

Method to generate a JSON object for the links in the given representation model.

Parameters:

pModel - Representation model with the links

pFilteringContext - Filtering context to use for filtering links in the response

Returns:

JSON object for the links

Throws:

org.json.JSONException

handleEmbeddedResources

protected org.json.JSONObject handleEmbeddedResources(RepresentationModel pModel,
                                                      atg.service.payloadschema.filter.FilteringContext pFilteringContext)
                                               throws org.json.JSONException

Construct JSON output for the embedded resources in the representation model. It will take care of omitting embedded resources that should be hidden and running any filtering on the embedded resources.

Parameters:

pModel - the representation model.

pFilteringContext - context data for current filtering operation

Returns:

the json object for the embedded resources.

Throws:

org.json.JSONException - should a error happen during processing.

handleEmbeddedResourceUris

protected org.json.JSONArray handleEmbeddedResourceUris(java.lang.String pRel,
                                                        java.util.List<java.lang.String> pUris,
                                                        atg.service.payloadschema.filter.FilteringContext pParentFilteringContext,
                                                        boolean pCrossRegistryUris)
                                                 throws org.json.JSONException

Method to create a JSON array for the given embedded resource uris and relation name.

Parameters:

pRel - Relation name for the embedded resources

pUris - List of String embedded resource uris to process

pParentFilteringContext - Filtering context of the parent resource

pCrossRegistryUris - true if pUris may include a uri for a registry not currently in context

Returns:

Embedded JSON array

Throws:

org.json.JSONException

handleEmbeddedResourceModels

protected org.json.JSONArray handleEmbeddedResourceModels(RepresentationModel pParentModel,
                                                          java.lang.String pRel,
                                                          java.util.List<RepresentationModel> pModels,
                                                          atg.service.payloadschema.filter.FilteringContext pParentFilteringContext)
                                                   throws org.json.JSONException

Method to create a JSON array for the given embedded resource models and relation name.

Parameters:

pParentModel - Parent representation model that is embedding other resources

pRel - Relation name for the embedded resources

pModels - List of embeddded representation models to process

pParentFilteringContext - Filtering context of the parent resource

Returns:

Embedded JSON array

Throws:

org.json.JSONException

handleResponseURIPath

protected RepresentationModel handleResponseURIPath(RepresentationModel pModel,
                                                    atg.service.payloadschema.filter.FilteringContext pFilteringContext)

A response uri was set so we need to invoke a GET of that uri to get the model we want to build our response on. We will replace the self uri, headers and the status code with the values from our original endpoint model.

Parameters:

pModel - original model

pFilteringContext - filtering context to use for the GET

Returns:

a representation model to use for the response.

handleMembers

protected org.json.JSONObject handleMembers(RepresentationModel pModel,
                                            atg.service.payloadschema.filter.FilteringContext pFilteringContext)
                                     throws org.json.JSONException

Method to create a JSON object for the members of a collection resource by processing the given representation model.

Parameters:

pModel - Representation model to process

pFilteringContext - Filtering context to apply filtering to members as needed

Returns:

Members JSON

Throws:

org.json.JSONException

addState

protected void addState(org.json.JSONObject pResponseJSON,
                        RepresentationModel pModel,
                        org.json.JSONObject pStateJSON)
                 throws org.json.JSONException

Adds the given state JSON to the overall response JSON.

Parameters:

pResponseJSON - Overall response JSON

pModel - Representation model that contained the state

pStateJSON - State JSON to add

Throws:

org.json.JSONException

addAdditionalState

protected void addAdditionalState(org.json.JSONObject pResponseJSON,
                                  RepresentationModel pModel,
                                  org.json.JSONObject pAdditionalStateJSON)
                           throws org.json.JSONException

Adds the given additional state JSON to the overall response JSON.

Parameters:

pResponseJSON - Overall response JSON

pModel - Representation model that contained the state

pAdditionalStateJSON - Additional state JSON to add

Throws:

org.json.JSONException

addProperties

protected void addProperties(org.json.JSONObject pResponseJSON,
                             RepresentationModel pModel,
                             org.json.JSONObject pPropertiesJSON)
                      throws org.json.JSONException

Adds the given properties JSON to the overall response JSON

Parameters:

pResponseJSON - Overall response JSON

pModel - Representation model the properties came from

pPropertiesJSON - Properties JSON to add

Throws:

org.json.JSONException

addLinks

protected void addLinks(org.json.JSONObject pResponseJSON,
                        RepresentationModel pModel,
                        org.json.JSONObject pLinksJSON)
                 throws org.json.JSONException

Add the given links JSON object to the overall response JSON.

Parameters:

pResponseJSON - Overall JSON object

pModel - Representation model the links apply to

pLinksJSON - Links JSON object to add

Throws:

org.json.JSONException

addEmbeddedResources

protected void addEmbeddedResources(org.json.JSONObject pResponseJSON,
                                    RepresentationModel pModel,
                                    org.json.JSONObject pEmbeddedResourcesJSON)
                             throws org.json.JSONException

Adds the given embedded resources JSON object to the overall response JSON.

Parameters:

pResponseJSON - Overall response JSON

pModel - Representation model the embedded resources were in

pEmbeddedResourcesJSON - Embedded resources JSON

Throws:

org.json.JSONException

addEmbeddedSelfLinks

protected void addEmbeddedSelfLinks(java.util.List<java.lang.String> pUris,
                                    org.json.JSONArray pEmbeddedArray)
                             throws org.json.JSONException

Adds self links for 'expand=false' members where only the self link is added to the response.

Parameters:

pUris - String URIs for the embedded resources

pEmbeddedArray - JSON array to add the self links to

Throws:

org.json.JSONException

addMembers

protected void addMembers(org.json.JSONObject pResponseJSON,
                          RepresentationModel pModel,
                          org.json.JSONObject pMembersJSON)
                   throws org.json.JSONException

Adds the given members JSON object to the overall response JSON object.

Parameters:

pResponseJSON - Overall response JSON

pModel - Representation model the members belong to

pMembersJSON - Members json

Throws:

org.json.JSONException

convertModelToJson

protected org.json.JSONObject convertModelToJson(RepresentationModel pModel,
                                                 atg.service.payloadschema.filter.FilteringContext pFilteringContext)
                                          throws org.json.JSONException

Method to convert a model to json.

Parameters:

pModel - RepresentationModel to convert

pFilteringContext - context data for current filtering operation

Returns:

converted json

Throws:

org.json.JSONException

getSize

public long getSize(java.lang.Object pObject,
                    java.lang.Class<?> pType,
                    java.lang.reflect.Type pGenericType,
                    java.lang.annotation.Annotation[] pAnnotations,
                    MediaType pMediaType)

get the size of the returned data

isWriteable

public boolean isWriteable(java.lang.Class<?> pType,
                           java.lang.reflect.Type pGenericType,
                           java.lang.annotation.Annotation[] pAnnotations,
                           MediaType pMediaType)

Checks to see if this provider can write the given type.

writeTo

public void writeTo(java.lang.Object pObject,
                    java.lang.Class<?> pType,
                    java.lang.reflect.Type pGenericType,
                    java.lang.annotation.Annotation[] pAnnotations,
                    MediaType pMediaType,
                    <any> pHttpHeaders,
                    java.io.OutputStream pEntityStream)

This method converts the java object to the HAL specific json response.

writeState

public void writeState(java.util.Map<java.lang.String,org.json.JSONObject> pKeyToStateString)

Specified by:

writeState in interface atg.servlet.StateMessageBodyWriter<org.json.JSONObject>

Parameters:

pKeyToStateString - key to string representation of state data.

getOutputProducer

public atg.service.payloadschema.filter.OutputProducer getOutputProducer()

Returns a JSON output producer to be used to produce JSON representations of objects whose state is to be written in message body.

Specified by:

getOutputProducer in interface atg.servlet.StateMessageBodyWriter<org.json.JSONObject>

Returns:

a JSON output producer