atg.service.jaxrs

Class HypermediaJSONMessageBodyReader

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.jaxrs.HypermediaJSONMessageBodyReader

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

Direct Known Subclasses:

JAXRSJSONMessageBodyReader

public abstract class HypermediaJSONMessageBodyReader
extends GenericService
implements atg.servlet.StateMessageBodyReader<org.json.JSONObject>

This class provides a base message body reader implementation for hypermedia types and also implements state message body reader to read state data from a JSON message body. 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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected static java.lang.String	INPUT_JSON_REQUEST_ATTRIBUTE_NAME A separator to separate the signing key from the encoded state data
protected atg.security.OPSSCipherSigningService	mSigningService
protected java.util.Set<java.lang.String>	mSupplementaryPayloadSchemaProperties

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

Method Summary

Modifier and Type	Method and Description
void	addSupplementaryPayloadSchemaProperty(java.lang.String pSupplementaryPayloadSchemaProperty) Adds a property name to supplementaryPayloadSchemaProperties.
atg.security.OPSSCipherSigningService	getSigningService() Returns the signingService property.
java.util.Set<java.lang.String>	getSupplementaryPayloadSchemaProperties() Returns the supplementaryPayloadSchemaProperties property.
java.util.Map<java.lang.String,org.json.JSONObject>	readStateData()
void	setSigningService(atg.security.OPSSCipherSigningService pSigningService) Sets the signingService property.
void	setSupplementaryPayloadSchemaProperties(java.util.Set<java.lang.String> pSupplementaryPayloadSchemaProperties) Sets the supplementaryPayloadSchemaProperties property.

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

INPUT_JSON_REQUEST_ATTRIBUTE_NAME

protected static final java.lang.String INPUT_JSON_REQUEST_ATTRIBUTE_NAME

A separator to separate the signing key from the encoded state data

See Also:

Constant Field Values

mSigningService

protected atg.security.OPSSCipherSigningService mSigningService

mSupplementaryPayloadSchemaProperties

protected java.util.Set<java.lang.String> mSupplementaryPayloadSchemaProperties

Constructor Detail

HypermediaJSONMessageBodyReader

public HypermediaJSONMessageBodyReader()

Method Detail

getSigningService

public atg.security.OPSSCipherSigningService getSigningService()

Returns the signingService property. The signing service used to verify the signed state data.

Returns:

the signingService property

setSigningService

public void setSigningService(atg.security.OPSSCipherSigningService pSigningService)

Sets the signingService property. The signing service used to verify the signed state data.

Parameters:

pSigningService - the signingService property

getSupplementaryPayloadSchemaProperties

public java.util.Set<java.lang.String> getSupplementaryPayloadSchemaProperties()

Returns the supplementaryPayloadSchemaProperties property. These are the names of properties which are not defined in the schema xml but which shouldn't be treated as unknown (i.e. shouldn't cause a validation error).

Returns:

the supplementaryPayloadSchemaProperties property

setSupplementaryPayloadSchemaProperties

public void setSupplementaryPayloadSchemaProperties(java.util.Set<java.lang.String> pSupplementaryPayloadSchemaProperties)

Sets the supplementaryPayloadSchemaProperties property. These are the names of properties which are not defined in the schema xml but which shouldn't be treated as unknown (i.e. shouldn't cause a validation error).

Parameters:

pSupplementaryPayloadSchemaProperties - the supplementaryPayloadSchemaProperties property

addSupplementaryPayloadSchemaProperty

public void addSupplementaryPayloadSchemaProperty(java.lang.String pSupplementaryPayloadSchemaProperty)

Adds a property name to supplementaryPayloadSchemaProperties. These are the names of properties which are not defined in the schema xml but which shouldn't be treated as unknown (i.e. shouldn't cause a validation error).

Parameters:

pSupplementaryPayloadSchemaProperty - a supplementaryPayloadSchemaProperty property

readStateData

public java.util.Map<java.lang.String,org.json.JSONObject> readStateData()
                                                                  throws SecurityException

Specified by:

readStateData in interface atg.servlet.StateMessageBodyReader<org.json.JSONObject>

Returns:

a map of key to JSONObject representing state data

Throws:

SecurityException