public abstract class RestOutputCustomizerImpl extends GenericService implements RestOutputCustomizer
Modifier and Type | Class and Description |
---|---|
class |
RestOutputCustomizerImpl.NucleusComponentReferenceObject
class to store nucleus component reference values
|
class |
RestOutputCustomizerImpl.RepositoryItemReferenceObject
class to store repository item reference values
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
protected static java.lang.String |
REQUEST_SCOPE_PATH |
protected static java.lang.String |
SESSION_SCOPE_PATH |
protected static char |
SPACE |
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
RestOutputCustomizerImpl()
Constructor
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
checkAgainstNonExpandableList(java.lang.Object pValue)
This method checks input value against nonExpandableList
|
java.lang.Object |
createBeanOutput(ParsedURI pParsedURI,
java.lang.Object pResContainer,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method creates an object which contains a representation of the data to be output
|
java.lang.Object |
createBeanValueOutput(ParsedURI pParsedURI,
java.lang.String pResourceName,
java.lang.Object pValue,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Outputs a bean property value to the output stream in the appropriate format.
|
protected ComponentConfiguration |
createComponentConfiguration(java.lang.String pComponentName,
boolean pDefaultIncludes,
JSONObject pObject)
create a ComponentConfiguration object from a json object
of the form:
{ "
|
protected void |
createOutputObject(ParsedURI pParsedURI,
java.lang.Object pResContainer,
java.lang.Object pParent,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method creates and returns a child element representing the data which will be
written to the response's output stream.
|
protected void |
createOutputObjectNoFiltering(ParsedURI pParsedURI,
java.lang.Object pResContainer,
java.lang.Object pParent,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method creates and returns a child element representing the data which will be
written to the response's output stream.
|
protected void |
createOutputObjectWithDefaultIncludes(ComponentConfiguration pComponentConfig,
ParsedURI pParsedURI,
java.lang.Object pResContainer,
java.lang.Object pParent,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method creates and returns a child element representing the data which will be
written to the response's output stream.
|
protected void |
createOutputObjectWithoutDefaultIncludes(ComponentConfiguration pComponentConfig,
ParsedURI pParsedURI,
java.lang.Object pResContainer,
java.lang.Object pParent,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method creates and returns a child element representing the data which will be
written to the response's output stream.
|
protected boolean |
enableShowRESTPaths()
enable show rest paths
|
protected JSONObject |
findComponentConfigJSON(JSONArray pArray,
int pNestingDepth,
java.lang.String pItemDescriptorName)
find the json object for a component configuration
from an array of component configurations
|
java.lang.String |
getArrayElementString()
The string to use for array element tags
|
protected boolean |
getBooleanControlParam(java.lang.String pName,
boolean pDefault)
get a specified boolean control param value
|
java.lang.String |
getCollectionElementString()
The string to use for collection element tags
|
protected ComponentConfiguration |
getComponentConfiguration(ParsedURI pParsedURI,
java.lang.Object pResContainer,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns the component configuration for the resource container
|
protected ComponentConfiguration |
getComponentConfiguration(ParsedURI pParsedURI,
java.lang.Object pResContainer,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns the component configuration for the resource container
|
ComponentResolver |
getComponentResolver() |
java.lang.String |
getContentType()
Returns the content type that the output customizer will set on the response
|
java.lang.String |
getEncoding()
Returns the encoding to use for the XML output.
|
FilteringManager |
getFilteringManager() |
java.lang.String |
getFormat()
Returns a format for the output customizer, for example "json" or "xml"
|
protected java.lang.String |
getHostAndPortString(DynamoHttpServletRequest pRequest)
Returns the host and port string from the request
|
int |
getIndentSize()
Returns the indent size, which is the number of space characters used when indenting, default is 2.
|
java.lang.String |
getMapElementString()
The string to use for map element tags
|
java.lang.String |
getMapKeyElementString()
The string to use for map key tags
|
java.lang.String |
getMapValueElementString()
The string to use for map value tags
|
protected java.lang.String |
getNucleusComponentPropertyReferenceString(BeanURI pBeanURI,
java.lang.String pPropertyName,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns a REST URL string for the given nucleus component property
|
protected java.lang.String |
getNucleusComponentPropertyReferenceString(GenericService pService,
java.lang.String pPropertyName,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns a REST URL string for the given nucleus component property
|
protected java.lang.String |
getNucleusComponentReferenceString(BeanURI pBeanURI,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns a REST URL string for the given nucleus component
|
protected java.lang.String |
getNucleusComponentReferenceString(GenericService pService,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns a REST URL string for the given nucleus component
|
protected java.lang.String |
getReferenceStringRoot(DynamoHttpServletRequest pRequest)
Returns the base of a rest URL, example http://localhost:80/rest
|
protected java.lang.String |
getRepositoryItemPropertyReferenceString(RepositoryItem pItem,
java.lang.String pPropertyName,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns a REST URL string for the given repository item property
|
protected java.lang.String |
getRepositoryItemReferenceString(RepositoryItem pItem,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Returns a REST URL string for the given repository item
|
java.lang.String |
getRootElementString()
Returns the string that the output customizer will use as its root
|
protected java.lang.String |
getStringControlParam(java.lang.String pName)
get a specified string control param value
|
java.lang.String |
getTimeZoneId()
Returns the Time Zone id to use for output dates.
|
boolean |
isEnableFormatDateOutput()
get EnableFormatDateOutput
|
boolean |
isEnablePerRequestClassFilters()
get EnablePerRequestClassFilters
|
boolean |
isEnablePerRequestComponentFilters()
get EnablePerRequestComponentFilters
|
boolean |
isEnablePerRequestFilters()
get EnablePerRequestFilters
|
boolean |
isEnablePerRequestRepositoryFilters()
get EnablePerRequestRepositoryFilters
|
boolean |
isLoggingPropertyDebug() |
protected boolean |
isObjectANonGenericServiceNucleusComponent(java.lang.Object pContainer,
BeanURI pURI)
determine if the container object is a non-GenericService nucleus component
|
boolean |
isShowRESTPaths()
get ShowRESTPaths
|
protected boolean |
loadNucleusComponentIntoMap(java.lang.String pComponentPath,
java.lang.Object pComponent,
BeanURI pURI)
load a nucleus component into the uri's properties map
|
protected boolean |
loadNucleusComponentIntoMap(java.lang.String pResourceName,
java.lang.Object pValue,
java.lang.Object pContainer,
BeanURI pURI)
load a nucleus component into the uri's properties map
|
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)
Outputs a bean property value to the output stream
|
protected void |
outputFilteredProperty(PropertyConfiguration pPropertyConfig,
ParsedURI pParsedURI,
java.lang.Object pResContainer,
java.lang.Object pParent,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method adds a single property and value to the output object.
|
protected void |
outputNonFilteredProperty(java.lang.String pPropertyName,
ParsedURI pParsedURI,
java.lang.Object pResContainer,
java.lang.Object pParent,
int pNestingDepth,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method adds a single property and value to the output object.
|
protected ComponentConfiguration |
searchComponentConfigs(java.lang.String pKey,
int pDepth)
get a component config using the key and depth
|
void |
setArrayElementString(java.lang.String pArrayElementString)
Sets the string to use for array element tags
|
void |
setCollectionElementString(java.lang.String pCollectionElementString)
Sets the string to use for collection element tags
|
void |
setContentType(java.lang.String pContentType)
Sets the content type that the output customizer will set on the response
|
void |
setEnableFormatDateOutput(boolean pEnableFormatDateOutput)
set EnableFormatDateOutput
|
void |
setEnablePerRequestClassFilters(boolean pEnablePerRequestClassFilters)
set EnablePerRequestClassFilters
|
void |
setEnablePerRequestComponentFilters(boolean pEnablePerRequestComponentFilters)
set EnablePerRequestComponentFilters
|
void |
setEnablePerRequestFilters(boolean pEnablePerRequestFilters)
set EnablePerRequestFilters
|
void |
setEnablePerRequestRepositoryFilters(boolean pEnablePerRequestRepositoryFilters)
set EnablePerRequestRepositoryFilters
|
void |
setEncoding(java.lang.String pEncoding)
Sets the encoding for the XML output
|
void |
setFormat(java.lang.String pFormat)
Sets a format for the output customizer, for example "json" or "xml"
|
void |
setIndentSize(int pIndentSize)
Sets the indent size, which is the number of space characters used when indenting
|
void |
setLoggingPropertyDebug(boolean pLoggingPropertyDebug) |
void |
setMapElementString(java.lang.String pMapElementString)
Sets the string to use for map element tags
|
void |
setMapKeyElementString(java.lang.String pMapKeyElementString)
Sets the string to use for map key tags
|
void |
setMapValueElementString(java.lang.String pMapValueElementString)
Sets the string to use for map value tags
|
void |
setRootElementString(java.lang.String pRootElementString)
Sets the string that the output customizer will use as its root
|
void |
setShowRESTPaths(boolean pShowRESTPaths)
set ShowRESTPaths
|
void |
setTimeZoneId(java.lang.String pTimeZoneId)
Sets the Time Zone for output date data
|
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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addValueToOutputObject, createOutputContainer, sendToOutputStream
public static java.lang.String CLASS_VERSION
protected static final char SPACE
protected static final java.lang.String REQUEST_SCOPE_PATH
protected static final java.lang.String SESSION_SCOPE_PATH
public java.lang.String getFormat()
getFormat
in interface RestOutputCustomizer
public void setFormat(java.lang.String pFormat)
pFormat
- the format to setpublic int getIndentSize()
public void setIndentSize(int pIndentSize)
pIndentSize
- the indentSize to setpublic java.lang.String getEncoding()
public void setEncoding(java.lang.String pEncoding)
pEncoding
- the encoding to setpublic java.lang.String getTimeZoneId()
public void setTimeZoneId(java.lang.String pTimeZoneId)
pTimeZoneId
- the Time Zone idpublic java.lang.String getContentType()
public void setContentType(java.lang.String pContentType)
pContentType
- the contentType to setpublic java.lang.String getRootElementString()
public void setRootElementString(java.lang.String pRootElementString)
pRootElementString
- the rootElementString to setpublic java.lang.String getArrayElementString()
public void setArrayElementString(java.lang.String pArrayElementString)
pArrayElementString
- the arrayElementString to setpublic java.lang.String getCollectionElementString()
public void setCollectionElementString(java.lang.String pCollectionElementString)
pCollectionElementString
- the collectionElementString to setpublic java.lang.String getMapElementString()
public void setMapElementString(java.lang.String pMapElementString)
pMapElementString
- the mapElementString to setpublic java.lang.String getMapKeyElementString()
public void setMapKeyElementString(java.lang.String pMapKeyElementString)
pMapKeyElementString
- the mapKeyElementString to setpublic java.lang.String getMapValueElementString()
public void setMapValueElementString(java.lang.String pMapValueElementString)
pMapValueElementString
- the mapValueElementString to setpublic boolean isLoggingPropertyDebug()
public void setLoggingPropertyDebug(boolean pLoggingPropertyDebug)
pLoggingPropertyDebug
- the loggingPropertyDebug to setpublic ComponentResolver getComponentResolver()
public FilteringManager getFilteringManager()
public void setShowRESTPaths(boolean pShowRESTPaths)
pShowRESTPaths
- the ShowRESTPathspublic boolean isShowRESTPaths()
public void setEnablePerRequestFilters(boolean pEnablePerRequestFilters)
pEnablePerRequestFilters
- the EnablePerRequestFilterspublic boolean isEnablePerRequestFilters()
public void setEnablePerRequestRepositoryFilters(boolean pEnablePerRequestRepositoryFilters)
pEnablePerRequestRepositoryFilters
- the EnablePerRequestRepositoryFilterspublic boolean isEnablePerRequestRepositoryFilters()
public void setEnablePerRequestComponentFilters(boolean pEnablePerRequestComponentFilters)
pEnablePerRequestComponentFilters
- the EnablePerRequestComponentFilterspublic boolean isEnablePerRequestComponentFilters()
public void setEnablePerRequestClassFilters(boolean pEnablePerRequestClassFilters)
pEnablePerRequestClassFilters
- the EnablePerRequestClassFilterspublic boolean isEnablePerRequestClassFilters()
public void setEnableFormatDateOutput(boolean pEnableFormatDateOutput)
pEnableFormatDateOutput
- the EnableFormatDateOutputpublic boolean isEnableFormatDateOutput()
public java.lang.Object checkAgainstNonExpandableList(java.lang.Object pValue)
pValue
- public java.lang.Object createBeanOutput(ParsedURI pParsedURI, java.lang.Object pResContainer, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
createBeanOutput
in interface RestOutputCustomizer
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 occurspublic java.lang.Object createBeanValueOutput(ParsedURI pParsedURI, java.lang.String pResourceName, java.lang.Object pValue, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
createBeanValueOutput
in interface RestOutputCustomizer
pParsedURI
- an object containing the ParsedURIpResourceName
- 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)
public void outputBean(ParsedURI pParsedURI, java.lang.Object pResContainer, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
outputBean
in interface RestOutputCustomizer
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 occurspublic void outputBeanValue(ParsedURI pParsedURI, java.lang.String pResourceName, java.lang.Object pValue, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
outputBeanValue
in interface RestOutputCustomizer
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)
public void outputBeanProperty(ParsedURI pParsedURI, java.lang.Object pResContainer, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, RestException
outputBeanProperty
in interface RestOutputCustomizer
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 occursprotected ComponentConfiguration getComponentConfiguration(ParsedURI pParsedURI, java.lang.Object pResContainer, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException
pParsedURI
- an object containing the parsed URIpResContainer
- the object container which is the resourcepRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an error occurs processing the REST requestprotected ComponentConfiguration getComponentConfiguration(ParsedURI pParsedURI, java.lang.Object pResContainer, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException
pParsedURI
- an object containing the parsed URIpResContainer
- the object container which is the resourcepNestingDepth
- the current nesting depthpRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an error occurs processing the REST requestprotected ComponentConfiguration searchComponentConfigs(java.lang.String pKey, int pDepth)
protected JSONObject findComponentConfigJSON(JSONArray pArray, int pNestingDepth, java.lang.String pItemDescriptorName) throws JSONException
pArray
- the json array of configurationspNestingDepth
- the current nesting depthpItemDescriptorName
- the item descriptor nameJSONException
protected ComponentConfiguration createComponentConfiguration(java.lang.String pComponentName, boolean pDefaultIncludes, JSONObject pObject) throws JSONException, RestInitializationException
pComponentName
- the component namepDefaultIncludes
- should we include everything by defaultpObject
- the json objectJSONException
- if there's an error parsing the json objectRestInitializationException
protected void createOutputObject(ParsedURI pParsedURI, java.lang.Object pResContainer, java.lang.Object pParent, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pParsedURI
- an object containing the parsed URIpResContainer
- the object container which is the resourcepParent
- the parent object to write or construct the output data inpNestingDepth
- 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 error occurs writing data to the output objectprotected void createOutputObjectNoFiltering(ParsedURI pParsedURI, java.lang.Object pResContainer, java.lang.Object pParent, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pParsedURI
- an object containing the parsed URIpResContainer
- the object container which is the resourcepParent
- the parent object to write or construct the output data inpNestingDepth
- 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 error occurs writing data to the output objectprotected void createOutputObjectWithDefaultIncludes(ComponentConfiguration pComponentConfig, ParsedURI pParsedURI, java.lang.Object pResContainer, java.lang.Object pParent, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pComponentConfig
- the ComponentConfiguration object for the resource in pResContainerpParsedURI
- an object containing the parsed URIpResContainer
- the object container which is the resourcepParent
- the parent object to write or construct the output data inpNestingDepth
- 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 error occurs writing data to the output objectprotected void createOutputObjectWithoutDefaultIncludes(ComponentConfiguration pComponentConfig, ParsedURI pParsedURI, java.lang.Object pResContainer, java.lang.Object pParent, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pComponentConfig
- the ComponentConfiguration object for the resource in pResContainerpParsedURI
- an object containing the parsed URIpResContainer
- the object container which is the resourcepParent
- the parent object to write or construct the output data inpNestingDepth
- 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 error occurs writing data to the output objectprotected void outputNonFilteredProperty(java.lang.String pPropertyName, ParsedURI pParsedURI, java.lang.Object pResContainer, java.lang.Object pParent, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pPropertyName
- the name of the propertypParsedURI
- an object containing the parsed URIpResContainer
- the object container which is the resourcepParent
- the parent object to write or construct the output data inpNestingDepth
- 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 error occurs writing data to the output objectprotected void outputFilteredProperty(PropertyConfiguration pPropertyConfig, ParsedURI pParsedURI, java.lang.Object pResContainer, java.lang.Object pParent, int pNestingDepth, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException, java.io.IOException
pPropertyConfig
- the PropertyConfiguration object which contains the filtering informationpParsedURI
- an object containing the parsed URIpResContainer
- the object container which is the resourcepParent
- the parent object to write or construct the output data inpNestingDepth
- 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 error occurs writing data to the output objectprotected java.lang.String getReferenceStringRoot(DynamoHttpServletRequest pRequest)
pRequest
- the servlet requestprotected java.lang.String getRepositoryItemReferenceString(RepositoryItem pItem, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException
pItem
- the repository item to generate the reference URL string forpRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an exception occurs determining the item descriptor typeprotected java.lang.String getNucleusComponentReferenceString(GenericService pService, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
pService
- the nucleus component to generate the reference URL string forpRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an exception occurs determining the item descriptor typeprotected java.lang.String getNucleusComponentReferenceString(BeanURI pBeanURI, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
pBeanURI
- the bean uri for the componentpRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an exception occurs determining the item descriptor typeprotected java.lang.String getRepositoryItemPropertyReferenceString(RepositoryItem pItem, java.lang.String pPropertyName, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws RestException
pItem
- the repository item which contains the property to generate the reference URL string forpPropertyName
- the property name to generate the reference URL string forpRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an exception occurs determining the item descriptor typeprotected java.lang.String getNucleusComponentPropertyReferenceString(GenericService pService, java.lang.String pPropertyName, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
pService
- the nucleus component which contains the property to generate the reference URL string forpPropertyName
- the property name to generate the reference URL string forpRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an exception occurs determining the item descriptor typeprotected java.lang.String getNucleusComponentPropertyReferenceString(BeanURI pBeanURI, java.lang.String pPropertyName, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
pBeanURI
- the bean uri for the componentpPropertyName
- the property name to generate the reference URL string forpRequest
- the servlet requestpResponse
- the servlet responseRestException
- if an exception occurs determining the item descriptor typeprotected boolean isObjectANonGenericServiceNucleusComponent(java.lang.Object pContainer, BeanURI pURI)
pContainer
- the container objectpURI
- the uri in which the property map is storedprotected boolean loadNucleusComponentIntoMap(java.lang.String pResourceName, java.lang.Object pValue, java.lang.Object pContainer, BeanURI pURI)
pResourceName
- the name of the property containing the objectpValue
- the objectpContainer
- the container objectpURI
- the uri in which the property map is storedprotected boolean loadNucleusComponentIntoMap(java.lang.String pComponentPath, java.lang.Object pComponent, BeanURI pURI)
pComponentPath
- the component pathpComponent
- the nucleus componentprotected java.lang.String getHostAndPortString(DynamoHttpServletRequest pRequest)
pRequest
- the request objectprotected boolean enableShowRESTPaths()
protected boolean getBooleanControlParam(java.lang.String pName, boolean pDefault)
pName
- the name of the control parampDefault
- the default value for the control paramprotected java.lang.String getStringControlParam(java.lang.String pName)
pName
- the name of the control param