public interface RestOutputCustomizer
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Modifier and Type | Method and Description |
---|---|
void |
addValueToOutputObject(java.lang.String pPropertyName,
java.lang.Object pValue,
ParsedURI pParsedURI,
java.lang.Object pContainer,
java.lang.Object pParent,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method will add the given value to the Object representing the data that will be output.
|
java.lang.Object |
createBeanOutput(ParsedURI pParsedURI,
java.lang.Object pResContainer,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Creates the object representing the output for a bean
|
java.lang.Object |
createBeanValueOutput(ParsedURI pParsedURI,
java.lang.String pResourceName,
java.lang.Object pValue,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Creates the object representing the output for a property value
|
java.lang.Object |
createOutputContainer()
This method creates the output container, such as JSONObject or Document.
|
java.lang.String |
getFormat()
Returns an identifier for the format, like "xml" or "json"
|
void |
outputBean(ParsedURI pParsedURI,
java.lang.Object pResContainer,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method outputs all the properties of an object to the response's output stream
|
void |
outputBeanProperty(ParsedURI pParsedURI,
java.lang.Object pResContainer,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method outputs a single bean property to the response's output stream by passing it to the output customizer
|
void |
outputBeanValue(ParsedURI pParsedURI,
java.lang.String pResourceName,
java.lang.Object pValue,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called to output the property value of a bean property to the output stream for a REST GET request.
|
void |
sendToOutputStream(java.lang.Object pObject,
DynamoHttpServletResponse pResponse)
Writes the output to the servlet output stream
|
static final java.lang.String CLASS_VERSION
java.lang.String getFormat()
java.lang.Object createOutputContainer()
void outputBean(ParsedURI pParsedURI, java.lang.Object pResContainer, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, RestException
pParsedURI
- an object containing the parsed URIpResContainer
- the object container which is the resourcepNestingDepth
- the current nesting depth from the resourcepRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an error occurs processing the REST requestjava.io.IOException
- if an input or output stream exception occursvoid outputBeanProperty(ParsedURI pParsedURI, java.lang.Object pResContainer, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, RestException
pParsedURI
- an object containing the parsed URIpResContainer
- the object containing the resourcepRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an error occurs processing the REST requestjava.io.IOException
- if an input or output stream exception occursvoid outputBeanValue(ParsedURI pParsedURI, java.lang.String pResourceName, java.lang.Object pValue, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pParsedURI
- an object containing the ParsedURIpResourceName
- the portion of the URI that is the name of the resourcepValue
- the value to outputpNestingDepth
- the current nesting depth from the resourcepRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an error occurs processing the REST requestjava.io.IOException
- if an input or output stream exception occursjava.lang.Object createBeanOutput(ParsedURI pParsedURI, java.lang.Object pResContainer, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pParsedURI
- an object containing the parsed URIpResContainer
- the object container which is the resourcepNestingDepth
- the current nesting depth from the resourcepRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an error occurs processing the REST requestjava.io.IOException
- if an input or output stream exception occursjava.lang.Object createBeanValueOutput(ParsedURI pParsedURI, java.lang.String pResourceName, java.lang.Object pValue, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pParsedURI
- an object containing the parsed URIpResourceName
- the name of the resource being outputpValue
- the value of the resourcepNestingDepth
- the current nesting depth from the resourcepRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an error occurs processing the REST requestjava.io.IOException
- if an input or output stream exception occursatg.rest.output.RestOutputCustomizer#outputBeanValue(java.lang.String, java.lang.Object, atg.servlet.DynamoHttpServletRequest, atg.servlet.DynamoHttpServletResponse)
void addValueToOutputObject(java.lang.String pPropertyName, java.lang.Object pValue, ParsedURI pParsedURI, java.lang.Object pContainer, java.lang.Object pParent, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pPropertyName
- the name of the property valuepValue
- the object representing the valuepParsedURI
- an object containing the parsed URIpContainer
- the parent container object of the propertypParent
- the element to add the value to as a text elementpNestingDepth
- the current nesting depth in the object treepRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an error occurs processing the REST requestjava.io.IOException
- if an error occurs writing to the output streamvoid sendToOutputStream(java.lang.Object pObject, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pObject
- the object representing the data to be written to the output streampResponse
- the servlet responseRestException
- if an error occurs processing the REST requestjava.io.IOException
- if an input or output stream exception occurs