|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.rest.processor.GenericRestProcessor
public abstract class GenericRestProcessor
The base class for processing rest requests.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
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 | |
---|---|
GenericRestProcessor()
Constructor |
Method Summary | |
---|---|
protected JSONObject |
determineJSONControlParams()
This method determines JSON control params |
protected boolean |
determineJSONUsage()
This method determines whether to use JSON input |
protected boolean |
getBooleanControlParam(java.lang.String pName,
boolean pDefault)
get a specified boolean control param value |
ComponentResolver |
getComponentResolver()
|
FilteringManager |
getFilteringManager()
|
RestOutputCustomizer |
getOutputCustomizer()
Returns the requested or configured rest output customizer. |
RestPipelineServlet |
getParentServlet()
|
protected java.lang.String |
getStringControlParam(java.lang.String pName)
get a specified string control param value |
boolean |
isAcceptJSONInput()
get AcceptJSONInput |
protected boolean |
isResourceWritable(ParsedURI pParsedURI)
Returns true if the property is writable based on the filtering configuration. |
protected boolean |
isResourceWritable(java.lang.String pPropertyName,
ParsedURI pParsedURI)
Returns true if the property is writable based on the filtering configuration. |
void |
setAcceptJSONInput(boolean pAcceptJSONInput)
set AcceptJSONInput |
void |
setComponentResolver(ComponentResolver pComponentResolver)
|
void |
setOutputCustomizer(RestOutputCustomizer pOutputCustomizer)
Set the configured rest output customizer. |
void |
setParentServlet(RestPipelineServlet pParentServlet)
This method sets the parent rest pipeline servlet |
protected boolean |
useSimpleResponseCodes()
Returns true if simple response codes should be used for responses. |
protected boolean |
validateResource(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Validates that the REST request is for a valid resource type. |
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, toString, wait, wait, wait |
Methods inherited from interface atg.rest.processor.RestProcessor |
---|
doRESTDelete, doRESTGet, doRESTPost, doRESTPut |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public GenericRestProcessor()
Method Detail |
---|
public RestOutputCustomizer getOutputCustomizer() throws RestException, java.io.IOException
RestException
java.io.IOException
public void setOutputCustomizer(RestOutputCustomizer pOutputCustomizer)
pOutputCustomizer
- the outputCustomizer to setpublic RestPipelineServlet getParentServlet()
public void setParentServlet(RestPipelineServlet pParentServlet)
RestProcessor
setParentServlet
in interface RestProcessor
pParentServlet
- the parentServlet to setpublic ComponentResolver getComponentResolver()
public void setComponentResolver(ComponentResolver pComponentResolver)
pComponentResolver
- the componentResolver to setpublic FilteringManager getFilteringManager()
public void setAcceptJSONInput(boolean pAcceptJSONInput)
pAcceptJSONInput
- the AcceptJSONInputpublic boolean isAcceptJSONInput()
protected boolean validateResource(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
parsedURI
- an object containing the parsed URIpRequest
- the servlet requestpResponse
- the servlet response
RestException
- if an error occurs processing the REST request
java.io.IOException
- if an input or output stream exception occursprotected boolean isResourceWritable(ParsedURI pParsedURI)
pParsedURI
- an object containing the parsed URI
protected boolean isResourceWritable(java.lang.String pPropertyName, ParsedURI pParsedURI)
pPropertyName
- the property namepParsedURI
- an object containing the parsed URI
protected boolean useSimpleResponseCodes()
protected boolean getBooleanControlParam(java.lang.String pName, boolean pDefault)
pName
- the name of the control parampDefault
- the default value for the control param
protected java.lang.String getStringControlParam(java.lang.String pName)
pName
- the name of the control param
protected JSONObject determineJSONControlParams() throws RestException
java.lang.IllegalArgumentException
- if an unexpected error occurs during parsing JSON input param
RestException
protected boolean determineJSONUsage()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |