RestContext (ATG Java API)

java.lang.Object
- atg.service.jaxrs.RestContext

```
public class RestContext
extends java.lang.Object
```
A RestContext is used to store rest request data on a thread local so it is available to downstream code that may not have access via parameter passing. A stack is maintained to allow nested embedded resource calls to have their own RestContext. Use the ListingRequest property to determine the properties of the current rest request. Use the ListingResponse property to provide the results of the current request.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string
`protected JAXRSApplication`	`mApplication`
`protected atg.service.jaxrs.ETagService`	`mETagService` A reference to an ETag service component.
`protected boolean`	`mGenerateETags` Flag when true we will generate ETags for responses we build
`protected boolean`	`mGetForUpdate` property: getForUpdate
`protected java.lang.Object`	`mOutputObject`
`protected java.util.Stack<java.lang.String>`	`mRelPath` property: relPath
`protected RestException`	`mRestException` rest exception if any occurred in this context

Constructor Summary

Constructors
Constructor and Description

RestContext()
Constructor

Constructors
Constructor and Description
`RestContext()` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSupplementaryPayloadSchemaPropertyName(java.lang.String pName)` Adds a name to the set the supplementary schema property names property.
`ListingRequest`	`buildListingRequest()` Uses the RestContextBuilder to build a ListingRequest object that contains the query params from the request.
`atg.service.payloadschema.filter.FilteringContext`	`createFilteringContext()` Creates a filtering context object based on this current rest context
`JAXRSApplication`	`getApplication()` Gets the jaxrs application that is in context for the current request.
`Link`	`getCollectionLink()` Returns the link for the current collection in context This can then be used by member resources for their 'collection' link.
`static RestContext`	`getCurrentContext()` Returns the JAXRSContext associated with the current thread.
`java.lang.String`	`getDeveloperOverrideFilterId()` Returns the id for the filter set by the developer on the representation model to override the default filter for the current resource
`org.json.JSONArray`	`getEmbeddedETag()` Returns property embeddedETag.
`java.lang.String`	`getEndpointFilterId()` Gets the filter id configured in the Endpoint annotation for the current resource
`java.lang.Object`	`getEndpointProxy()` Returns EndpointProxy
`RestResourceRegistry.EndpointSettings`	`getEndpointSettings()` get EndpointSettings
`atg.service.jaxrs.ETagService`	`getETagService()` Returns a reference to an ETag service component
`java.lang.String`	`getETagValue()` get ETagValue
`java.util.Set<java.lang.String>`	`getExclude()` Getter for the set of string names of properties or relations the response should definitely exclude.
`java.util.Set<java.lang.String>`	`getExpandResources()` Returns a set of the expand parameters set on the URL
`java.util.Set<java.lang.String>`	`getFields()` Getter for the set of string names of properties or relations the response should be constrained to.
`int`	`getFilterDepth()` Returns the depth at which to filter the current resource
`int`	`getFilterDepthForContext()` Gets the depth with which to filter the current resource to.
`java.lang.String`	`getFilterId()` Gets the filter id for the current resource
`org.json.JSONObject`	`getInputJson()` Returns property inputJson.
`java.util.Set<java.lang.String>`	`getLinks()` Returns a set of the link parameters set on the URL
`LinkUtils`	`getLinkUtils()` Reference to the current context `LinkUtils` component.
`ListingRequest`	`getListingRequest()` Returns ListingRequest
`ListingResponse`	`getListingResponse()` Returns ListingResponse
`java.io.Serializable`	`getLockKey()` Return the current lock key
`java.lang.Object`	`getLockOwner()` Return the current lock owner
`atg.service.jaxrs.RestLockService.LockType`	`getLockType()` get LockType
`int`	`getNestingDepth()` Returns the current nesting depth relative to the root resource
`java.lang.Object`	`getOutputObject()` Returns the output object.
`java.lang.String`	`getOverrideFilterId()` Returns the id for the filter to override the default filter for the current resource
`java.util.Stack<java.lang.String>`	`getRelPath()` Stack of rel names leading to the current resource in context.
`java.util.Set<java.lang.String>`	`getRequestAccepts()` Set of string Accept media types for the current request
`ContainerRequestContext`	`getRequestContext()` Returns property requestContext.
`<any>`	`getRequestHeaders()` Returns property headers.
`ResourceInfo`	`getResourceInfo()` Returns property resourceInfo.
`java.lang.String`	`getResourceKey()` Sets the unique string that identifies a specific endpoint method It is determined from the hash of the Method itself.
`protected atg.service.jaxrs.RestUpdateInfo.RestResourceUpdateInfo`	`getResourceUpdateInfo()` Returns a ResourceUpdateInfo object containing property values changes from validated message input
`int`	`getResourceVersion()` Returns the current version of a resource
`java.lang.Object`	`getResponse()` Gets the response.
`MediaType`	`getResponseMediaType()` Returns the media type for the response
`RestException`	`getRestException()` Getter for the rest exception if any occurred in this context
`RestResourceRegistry`	`getRestResourceRegistry()` Reference to the current context `RestResourceRegistry` component.
`RestUtils`	`getRestUtils()` Reference to the current context `RestUtils` component.
`static int`	`getStackSize()` Returns the context thread local stack size
`java.util.Set<java.lang.String>`	`getSupplementaryPayloadSchemaPropertyNames()` Gets the supplementary schema property names property.
`java.lang.String`	`getUriPath()` get UriPath
`boolean`	`isBypassTokenSecurity()` Returns the bypass token security property.
`boolean`	`isGenerateETags()` Getter for a flag which when true we will generate ETags for response resources we output for this request.
`boolean`	`isGetForUpdate()` Returns true if the getForUpdate query parameter was passed in for this request as true.
`boolean`	`isJsonRequest()` Examines the headers sent on the request to see if the data sent was a JSON payload.
`boolean`	`isRepresentationModelResponse()` Checks if a representation model response has been set
`static RestContext`	`popCurrentContext()` Removes the JAXRSContext associated with the current thread from the stack
`static RestContext`	`popCurrentContext(boolean pOnlyIfTop)`
`void`	`setApplication(JAXRSApplication pApplication)` Sets the jaxrs application that is in context for the current request.
`void`	`setBypassTokenSecurity(boolean pBypassTokenSecurity)` Sets the bypass token security property.
`void`	`setCollectionLink(Link pCollectionLink)` Sets the link for the current collection in context This can then be used by member resources for their 'collection' link.
`static void`	`setCurrentContext(RestContext pContext)` set the JAXRSContext associated with the current thread.
`void`	`setDeveloperOverrideFilterId(java.lang.String pDeveloperOverrideFilterId)` Sets the id of the filter set by the developer on the representation model to override the default filter for the current resource
`void`	`setEmbeddedETag(org.json.JSONArray pEmbeddedETag)` Sets property embeddedETag.
`void`	`setEndpointProxy(java.lang.Object pEndpointProxy)` Sets property EndpointProxy.
`void`	`setEndpointSettings(RestResourceRegistry.EndpointSettings pEndpointSettings)` set EndpointSettings
`void`	`setETagService(atg.service.jaxrs.ETagService pETagService)` Sets a reference to an ETag service component
`void`	`setETagValue(java.lang.String pETagValue)` set ETagValue
`void`	`setExclude(java.util.Set<java.lang.String> pExclude)` Setter for the list of string names of properties or relations the response should definitely exclude.
`void`	`setExpandResources(java.util.Set<java.lang.String> pExpandResources)` Sets the set of expand parameters passed via the URL
`void`	`setFields(java.util.Set<java.lang.String> pFields)` Setter for the set of string names of properties or relations the response should be constrained to.
`void`	`setFilterDepth(int pFilterDepth)` Sets the depth at which the current resource is to be filtered.
`void`	`setGenerateETags(boolean pGenerateETags)` Setter for a flag which when true we will generate ETags for response resources we output for this request.
`void`	`setGetForUpdate(boolean pGetForUpdate)` Set to true if the getForUpdate query parameter was passed in for this request as true.
`void`	`setInputJson(org.json.JSONObject pInputJson)` Sets property inputJson.
`void`	`setLinks(java.util.Set<java.lang.String> pLinks)` Sets the list of link parameters passed via the URL
`void`	`setLockKey(java.io.Serializable pLockKey)` Set the current lock key
`void`	`setLockOwner(java.lang.Object pLockOwner)` Set the current lock owner
`void`	`setLockType(atg.service.jaxrs.RestLockService.LockType pLockType)` set LockType
`void`	`setOutputObject(java.lang.Object pOutputObject)` Sets the output object.
`void`	`setOverrideFilterId(java.lang.String pOverrideFilterId)` Sets the id of the filter to override the default filter for the current resource
`void`	`setRelPath(java.util.Stack<java.lang.String> pRelPath)` Stack of rel names leading to the current resource in context.
`void`	`setRequestContext(ContainerRequestContext pRequestContext)` Sets property requestContext.
`void`	`setRequestHeaders(<any> pRequestHeaders)` Sets property request headers.
`void`	`setResourceInfo(ResourceInfo pResourceInfo)` Sets property resourceInfo.
`void`	`setResourceKey(java.lang.String pResourceKey)` Sets the unique string that identifies a specific endpoint method.
`void`	`setResourceUpdateInfo(atg.service.jaxrs.RestUpdateInfo.RestResourceUpdateInfo pRequestUpdateInfo)` Sets a ResourceUpdateInfo object containing property values changes from validated message input
`void`	`setResourceVersion(int pResourceVersion)` Sets the version of the resource to use it in the Embedded ETag generation.
`void`	`setResponse(java.lang.Object pResponse)` Sets the response.
`void`	`setResponseMediaType(MediaType pResponseMediaType)` Sets the media type for the response
`void`	`setRestException(RestException pRestException)` Setter for the rest exception if any occurred in this context
`void`	`setRestResourceRegistry(JAXRSApplication pApplication)` Sets the jaxrs application that is in context for the current request.
`void`	`setSupplementaryPayloadSchemaPropertyNames(java.util.Set<java.lang.String> pSupplementaryPayloadSchemaPropertyNames)` Sets the supplementary schema property names property.
`void`	`setUriPath(java.lang.String pUriPath)` set UriPath

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLASS_VERSION
```
public static final java.lang.String CLASS_VERSION
```
    Class version string
    
    See Also:
    
    Constant Field Values
  - mApplication
```
protected JAXRSApplication mApplication
```
  - mOutputObject
```
protected java.lang.Object mOutputObject
```
  - mGenerateETags
```
protected boolean mGenerateETags
```
    Flag when true we will generate ETags for responses we build
  - mGetForUpdate
```
protected boolean mGetForUpdate
```
    property: getForUpdate
  - mETagService
```
protected atg.service.jaxrs.ETagService mETagService
```
    A reference to an ETag service component.
  - mRelPath
```
protected java.util.Stack<java.lang.String> mRelPath
```
    property: relPath
  - mRestException
```
protected RestException mRestException
```
    rest exception if any occurred in this context
- Constructor Detail
  - RestContext
```
public RestContext()
```
    Constructor
- Method Detail
  - setRestResourceRegistry
```
public void setRestResourceRegistry(JAXRSApplication pApplication)
```
    Sets the jaxrs application that is in context for the current request. The registry can be obtained from the application.
    
    Parameters:
    
    pApplication - the jaxrs application currently in context
  - getApplication
```
public JAXRSApplication getApplication()
```
    Gets the jaxrs application that is in context for the current request. The registry can be obtained from the application.
    
    Returns:
    
    the jaxrs application currently in context
  - setApplication
```
public void setApplication(JAXRSApplication pApplication)
```
    Sets the jaxrs application that is in context for the current request. The registry can be obtained from the application.
    
    Parameters:
    
    pApplication - the jaxrs application currently in context
  - getRestResourceRegistry
```
public RestResourceRegistry getRestResourceRegistry()
```
    Reference to the current context RestResourceRegistry component.
    
    Returns:
    
    RestResourceRegistry in context for current request
  - getLinkUtils
```
public LinkUtils getLinkUtils()
```
    Reference to the current context LinkUtils component. LinkUtils provides utility methods for managing links and resource references. Default implementation is to get the LinkUtils reference from the rest resource registry.
    
    Returns:
    
    LinkUtils to use
  - getRestUtils
```
public RestUtils getRestUtils()
```
    Reference to the current context RestUtils component. RestUtils provides utility methods for endpoint developers. Default implementation is to get the RestUtils reference from the rest resource registry.
    
    Returns:
    
    RestUtils to use
  - setRequestHeaders
```
public void setRequestHeaders(<any> pRequestHeaders)
```
    Sets property request headers. The post matching http request headers
    
    Parameters:
    
    pRequestHeaders - the request headers.
  - getRequestHeaders
```
public <any> getRequestHeaders()
```
    Returns property headers. The post matching http headers. Populated by JAXRSPostMatchRequestFilter.
    
    Returns:
    
    the property headers.
  - isJsonRequest
```
public boolean isJsonRequest()
```
    Examines the headers sent on the request to see if the data sent was a JSON payload. The header 'content-type': "application/json" header tells us this.
    
    Returns:
    
    boolean true if the JSON header is present otherwise return false.
  - setResourceInfo
```
public void setResourceInfo(ResourceInfo pResourceInfo)
```
    Sets property resourceInfo. The post matching resource method info.
    
    Parameters:
    
    pResourceInfo - the resource information object.
  - getResourceInfo
```
public ResourceInfo getResourceInfo()
```
    Returns property resourceInfo. The post matching resource method info. Populated by JAXRSPostMatchRequestFilter.
    
    Returns:
    
    the resource info object
    
    See Also:
    
    ResourceInfo
  - setRequestContext
```
public void setRequestContext(ContainerRequestContext pRequestContext)
```
    Sets property requestContext. The container request context post matching
    
    Parameters:
    
    pRequestContext - the request context
    
    See Also:
    
    ContainerRequestContext
  - getRequestContext
```
public ContainerRequestContext getRequestContext()
```
    Returns property requestContext. The container request context post matching. Populated by JAXRSPostMatchRequestFilter.
    
    Returns:
    
    the request context object.
    
    See Also:
    
    ContainerRequestContext
  - setInputJson
```
public void setInputJson(org.json.JSONObject pInputJson)
```
    Sets property inputJson. The current input JSON.
    
    Parameters:
    
    pInputJson - the input JSON
    
    See Also:
    
    JSONObject
  - getInputJson
```
public org.json.JSONObject getInputJson()
```
    Returns property inputJson. The current input JSON. Populated by JSONMessageBodyReader.
    
    Returns:
    
    The input JSON.
    
    See Also:
    
    JSONObject
  - getOutputObject
```
public java.lang.Object getOutputObject()
```
    Returns the output object. The output object to be written to the response.
    
    Returns:
    
    the output object
  - setOutputObject
```
public void setOutputObject(java.lang.Object pOutputObject)
```
    Sets the output object. The output object to be written to the response.
    
    Parameters:
    
    pOutputObject - the output object
  - setGenerateETags
```
public void setGenerateETags(boolean pGenerateETags)
```
    Setter for a flag which when true we will generate ETags for response resources we output for this request. Defaults to true. For embedded resource requests this will normally be overridden via the generateEmbeddedETags query parameter to false.
    
    Parameters:
    
    pGenerateETags - true to generate ETags for response resources we output for this request.
  - isGenerateETags
```
public boolean isGenerateETags()
```
    Getter for a flag which when true we will generate ETags for response resources we output for this request. Defaults to true. For embedded resource requests this will normally be overridden via the generateEmbeddedETags query parameter to false.
    
    Returns:
    
    true to generate ETags for response resources we output for this request.
  - setETagValue
```
public void setETagValue(java.lang.String pETagValue)
```
    set ETagValue
    
    Parameters:
    
    pETagValue - the ETagValue
  - getETagValue
```
public java.lang.String getETagValue()
```
    get ETagValue
    
    Returns:
    
    the ETagValue
  - setLockType
```
public void setLockType(atg.service.jaxrs.RestLockService.LockType pLockType)
```
    set LockType
    
    Parameters:
    
    pLockType - the LockType
  - getLockType
```
public atg.service.jaxrs.RestLockService.LockType getLockType()
```
    get LockType
    
    Returns:
    
    the LockType
  - isGetForUpdate
```
public boolean isGetForUpdate()
```
    Returns true if the getForUpdate query parameter was passed in for this request as true.
    
    Returns:
    
    true if getForUpdate query parameter is true
  - setGetForUpdate
```
public void setGetForUpdate(boolean pGetForUpdate)
```
    Set to true if the getForUpdate query parameter was passed in for this request as true.
    
    Parameters:
    
    pGetForUpdate - true if getForUpdate query parameter is true
  - setResourceKey
```
public void setResourceKey(java.lang.String pResourceKey)
```
    Sets the unique string that identifies a specific endpoint method. It is determined from the hash of the Method itself. This is the key used to look up the endpoint registry.
    
    Parameters:
    
    pResourceKey - the ResourceKey
  - getResourceKey
```
public java.lang.String getResourceKey()
```
    Sets the unique string that identifies a specific endpoint method It is determined from the hash of the Method itself. This is the key used to look up the endpoint registry.
    
    Returns:
    
    the String ResourceKey
  - setUriPath
```
public void setUriPath(java.lang.String pUriPath)
```
    set UriPath
    
    Parameters:
    
    pUriPath - the UriPath
  - getUriPath
```
public java.lang.String getUriPath()
```
    get UriPath
    
    Returns:
    
    the UriPath
  - setEndpointSettings
```
public void setEndpointSettings(RestResourceRegistry.EndpointSettings pEndpointSettings)
```
    set EndpointSettings
    
    Parameters:
    
    pEndpointSettings - the EndpointSettings
  - getEndpointSettings
```
public RestResourceRegistry.EndpointSettings getEndpointSettings()
```
    get EndpointSettings
    
    Returns:
    
    the EndpointSettings
  - setResourceVersion
```
public void setResourceVersion(int pResourceVersion)
```
    Sets the version of the resource to use it in the Embedded ETag generation.
    
    Parameters:
    
    pResourceVersion - the ResourceVersion
  - getResourceVersion
```
public int getResourceVersion()
```
    Returns the current version of a resource
    
    Returns:
    
    the mResourceVersion
  - getETagService
```
public atg.service.jaxrs.ETagService getETagService()
```
    Returns a reference to an ETag service component
    
    Returns:
    
    ETagService
  - setETagService
```
public void setETagService(atg.service.jaxrs.ETagService pETagService)
```
    Sets a reference to an ETag service component
    
    Parameters:
    
    pETagService - ETag service to use for the request
  - setEmbeddedETag
```
public void setEmbeddedETag(org.json.JSONArray pEmbeddedETag)
```
    Sets property embeddedETag. The embedded resources ETag.
    
    Parameters:
    
    pEmbeddedETag - The embedded ETag.
  - getEmbeddedETag
```
public org.json.JSONArray getEmbeddedETag()
```
    Returns property embeddedETag. The embedded resources ETag JSON.
    
    Returns:
    
    the embedded ETag, if there is one.
  - getLockOwner
```
public java.lang.Object getLockOwner()
```
    Return the current lock owner
    
    Returns:
    
    the current lock owner, null if none specified.
  - setLockOwner
```
public void setLockOwner(java.lang.Object pLockOwner)
```
    Set the current lock owner
    
    Parameters:
    
    pLockOwner - The lock owner.
  - getLockKey
```
public java.io.Serializable getLockKey()
```
    Return the current lock key
    
    Returns:
    
    the current lock key, null if none specified.
  - setLockKey
```
public void setLockKey(java.io.Serializable pLockKey)
```
    Set the current lock key
    
    Parameters:
    
    pLockKey - The lock key.
  - getOverrideFilterId
```
public java.lang.String getOverrideFilterId()
```
    Returns the id for the filter to override the default filter for the current resource
    
    Returns:
    
    id of override filter
  - setOverrideFilterId
```
public void setOverrideFilterId(java.lang.String pOverrideFilterId)
```
    Sets the id of the filter to override the default filter for the current resource
    
    Parameters:
    
    pOverrideFilterId - id of the override filter
  - getDeveloperOverrideFilterId
```
public java.lang.String getDeveloperOverrideFilterId()
```
    Returns the id for the filter set by the developer on the representation model to override the default filter for the current resource
    
    Returns:
    
    id of the developer override filter
  - setDeveloperOverrideFilterId
```
public void setDeveloperOverrideFilterId(java.lang.String pDeveloperOverrideFilterId)
```
    Sets the id of the filter set by the developer on the representation model to override the default filter for the current resource
    
    Parameters:
    
    pDeveloperOverrideFilterId - id of the developer override filter
  - getFilterDepth
```
public int getFilterDepth()
```
    Returns the depth at which to filter the current resource
    
    Returns:
    
    depth to filter
  - setFilterDepth
```
public void setFilterDepth(int pFilterDepth)
```
    Sets the depth at which the current resource is to be filtered.
    
    Parameters:
    
    pFilterDepth - the depth to which the current resource is filtered.
  - getNestingDepth
```
public int getNestingDepth()
```
    Returns the current nesting depth relative to the root resource
    
    Returns:
    
    current nesting depth
  - getRelPath
```
public java.util.Stack<java.lang.String> getRelPath()
```
    Stack of rel names leading to the current resource in context. If this is a root resource then the stack will be empty.
    
    Returns:
    
    stack of string rel names leading to the current resource in context
  - setRelPath
```
public void setRelPath(java.util.Stack<java.lang.String> pRelPath)
```
    Stack of rel names leading to the current resource in context. If this is a root resource then the stack will be empty.
    
    Parameters:
    
    pRelPath - stack of string rel names leading to the current resource in context
  - getExpandResources
```
public java.util.Set<java.lang.String> getExpandResources()
```
    Returns a set of the expand parameters set on the URL
    
    Returns:
    
    set of expand parameters
  - setExpandResources
```
public void setExpandResources(java.util.Set<java.lang.String> pExpandResources)
```
    Sets the set of expand parameters passed via the URL
    
    Parameters:
    
    pExpandResources - list of expand parameters
  - getResourceUpdateInfo
```
protected atg.service.jaxrs.RestUpdateInfo.RestResourceUpdateInfo getResourceUpdateInfo()
```
    Returns a ResourceUpdateInfo object containing property values changes from validated message input
    
    Returns:
    
    ResourceUpdateInfo containing property value changes
  - setResourceUpdateInfo
```
public void setResourceUpdateInfo(atg.service.jaxrs.RestUpdateInfo.RestResourceUpdateInfo pRequestUpdateInfo)
```
    Sets a ResourceUpdateInfo object containing property values changes from validated message input
    
    Parameters:
    
    pRequestUpdateInfo - ResourceUpdateInfo containing property value changes
  - getRequestAccepts
```
public java.util.Set<java.lang.String> getRequestAccepts()
```
    Set of string Accept media types for the current request
    
    Returns:
    
    Set of accept media types
  - getResponseMediaType
```
public MediaType getResponseMediaType()
```
    Returns the media type for the response
    
    Returns:
    
    the response media type
  - setResponseMediaType
```
public void setResponseMediaType(MediaType pResponseMediaType)
```
    Sets the media type for the response
    
    Parameters:
    
    pResponseMediaType - the response media type
  - getLinks
```
public java.util.Set<java.lang.String> getLinks()
```
    Returns a set of the link parameters set on the URL
    
    Returns:
    
    set of link parameters
  - setLinks
```
public void setLinks(java.util.Set<java.lang.String> pLinks)
```
    Sets the list of link parameters passed via the URL
    
    Parameters:
    
    pLinks - list of link parameters
  - getCollectionLink
```
public Link getCollectionLink()
```
    Returns the link for the current collection in context This can then be used by member resources for their 'collection' link.
    
    Returns:
    
    link to the collection
  - setCollectionLink
```
public void setCollectionLink(Link pCollectionLink)
```
    Sets the link for the current collection in context This can then be used by member resources for their 'collection' link.
    
    Parameters:
    
    pCollectionLink - link to the collection
  - getFields
```
public java.util.Set<java.lang.String> getFields()
```
    Getter for the set of string names of properties or relations the response should be constrained to. Normally this is specified by the 'fields' query parameter. Property names can use dot notation to allow nested properties to be referenced. Wildcard '*' can be used to specify all properties at that level, e.g. /currentUser?=fields=*,addresses.id - would indicate the response should include all of the normal properties for the current user resource but only the 'id' property for the addresses embedded sub-resource.
    
    Returns:
    
    set of property names or relation names
  - setFields
```
public void setFields(java.util.Set<java.lang.String> pFields)
```
    Setter for the set of string names of properties or relations the response should be constrained to. Normally this is specified by the 'fields' query parameter. Property names can use dot notation to allow nested properties to be referenced. Wildcard '*' can be used to specify all properties at that level, e.g. /currentUser?=fields=*,addresses.id - would indicate the response should include all of the normal properties for the current user resource but only the 'id' property for the addresses embedded sub-resource.
    
    Parameters:
    
    pFields - set of property names or relation names
  - getExclude
```
public java.util.Set<java.lang.String> getExclude()
```
    Getter for the set of string names of properties or relations the response should definitely exclude. Normally this is specified by the 'exclude' query parameter. Property names can use dot notation to allow nested properties to be referenced. Note: wildcard notation is not supported e.g. /currentUser?=exclude=receiveEmail,addresses.id,creditCards - would indicate the response should not provide 'receiveEmail' property of the user nor the 'id' property of the embedded addresses sub-resource nor should it embed the creditCards resource at all.
    
    Returns:
    
    set of exclude property names or relation names
  - setExclude
```
public void setExclude(java.util.Set<java.lang.String> pExclude)
```
    Setter for the list of string names of properties or relations the response should definitely exclude. Normally this is specified by the 'exclude' query parameter. Property names can use dot notation to allow nested properties to be referenced. Note: wildcard notation is not supported e.g. /currentUser?=exclude=receiveEmail,addresses.id,creditCards - would indicate the response should not provide 'receiveEmail' property of the user nor the 'id' property of the embedded addresses sub-resource nor should it embed the creditCards resource at all.
    
    Parameters:
    
    pExclude - set of exclude property names or relation names
  - getStackSize
```
public static int getStackSize()
```
    Returns the context thread local stack size
    
    Returns:
    
    size of context stack containing internal request contexts
  - setCurrentContext
```
public static void setCurrentContext(RestContext pContext)
```
    set the JAXRSContext associated with the current thread.
    
    Parameters:
    
    pContext - represents the current context in the thread
  - getCurrentContext
```
public static RestContext getCurrentContext()
```
    Returns the JAXRSContext associated with the current thread.
    
    Returns:
    
    RestContext the current context
  - popCurrentContext
```
public static RestContext popCurrentContext()
```
    Removes the JAXRSContext associated with the current thread from the stack
    
    Returns:
    
    the old RestContext or null if none
  - popCurrentContext
```
public static RestContext popCurrentContext(boolean pOnlyIfTop)
```
  - setEndpointProxy
```
public void setEndpointProxy(java.lang.Object pEndpointProxy)
```
    Sets property EndpointProxy.
    
    Parameters:
    
    pEndpointProxy - the endpoint proxy instance
  - getEndpointProxy
```
public java.lang.Object getEndpointProxy()
```
    Returns EndpointProxy
    
    Returns:
    
    mEndpointProxy the proxy instance of the endpoint class
  - getListingRequest
```
public ListingRequest getListingRequest()
```
    Returns ListingRequest
    
    Returns:
    
    mListingRequest the listing request containing the parsed query parameters from the original request
  - getListingResponse
```
public ListingResponse getListingResponse()
```
    Returns ListingResponse
    
    Returns:
    
    mListingResponse the listing response object to store the collection of items which are result of query executed through listing request
  - buildListingRequest
```
public ListingRequest buildListingRequest()
                                   throws RestException
```
    Uses the RestContextBuilder to build a ListingRequest object that contains the query params from the request.
    
    Returns:
    
    the ListingRequest object with the query params.
    
    Throws:
    
    RestException - if an issue occurs while building the list.
  - getResponse
```
public java.lang.Object getResponse()
```
    Gets the response.
    
    Returns:
    
    response
  - setResponse
```
public void setResponse(java.lang.Object pResponse)
```
    Sets the response.
    
    Parameters:
    
    pResponse - the new response
  - isRepresentationModelResponse
```
public boolean isRepresentationModelResponse()
```
    Checks if a representation model response has been set
    
    Returns:
    
    true if a representation model response has been created
  - isBypassTokenSecurity
```
public boolean isBypassTokenSecurity()
```
    Returns the bypass token security property. This flag can be set by endpoints to tell the framework to ignore any token security checks such as for embedded resources.
    
    Returns:
    
    true if token security should be bypassed.
  - setBypassTokenSecurity
```
public void setBypassTokenSecurity(boolean pBypassTokenSecurity)
```
    Sets the bypass token security property. This flag can be set by endpoints to tell the framework to ignore any token security checks such as for embedded resources.
    
    Parameters:
    
    pBypassTokenSecurity - the bypass token security flag
  - getSupplementaryPayloadSchemaPropertyNames
```
public java.util.Set<java.lang.String> getSupplementaryPayloadSchemaPropertyNames()
```
    Gets the supplementary schema property names property. Typically this will be media type specific things like "links" etc.
    
    Returns:
    
    the set of supplementary schema property names
  - setSupplementaryPayloadSchemaPropertyNames
```
public void setSupplementaryPayloadSchemaPropertyNames(java.util.Set<java.lang.String> pSupplementaryPayloadSchemaPropertyNames)
```
    Sets the supplementary schema property names property. Typically this will be media type specific things like "links" etc.
    
    Parameters:
    
    pSupplementaryPayloadSchemaPropertyNames - the supplementary schema property names
  - addSupplementaryPayloadSchemaPropertyName
```
public void addSupplementaryPayloadSchemaPropertyName(java.lang.String pName)
```
    Adds a name to the set the supplementary schema property names property.
    
    Parameters:
    
    pName - Name of the property name to add to the set of supplementary schema properties
  - createFilteringContext
```
public atg.service.payloadschema.filter.FilteringContext createFilteringContext()
```
    Creates a filtering context object based on this current rest context
    
    Returns:
    
    FilteringContext
  - getFilterDepthForContext
```
public int getFilterDepthForContext()
```
    Gets the depth with which to filter the current resource to.
    
    Returns:
    
    the depth for the filter
    
    Throws:
    
    RestException - if context or endpoint settings not set
  - getFilterId
```
public java.lang.String getFilterId()
```
    Gets the filter id for the current resource
    
    Returns:
    
    the filter id of the current resource
  - getEndpointFilterId
```
public java.lang.String getEndpointFilterId()
```
    Gets the filter id configured in the Endpoint annotation for the current resource
    
    Returns:
    
    the filter id of the current resource as configured by the Endpoint annotation
  - getRestException
```
public RestException getRestException()
```
    Getter for the rest exception if any occurred in this context
    
    Returns:
    
    RestException or null if none has occurred
  - setRestException
```
public void setRestException(RestException pRestException)
```
    Setter for the rest exception if any occurred in this context
    
    Parameters:
    
    pRestException - RestException that has been created in a request using this context

Class RestContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

mApplication

mOutputObject

mGenerateETags

mGetForUpdate

mETagService

mRelPath

mRestException

Constructor Detail

RestContext

Method Detail

setRestResourceRegistry

getApplication

setApplication

getRestResourceRegistry

getLinkUtils

getRestUtils

setRequestHeaders

getRequestHeaders

isJsonRequest

setResourceInfo

getResourceInfo

setRequestContext

getRequestContext

setInputJson

getInputJson

getOutputObject

setOutputObject

setGenerateETags

isGenerateETags

setETagValue

getETagValue

setLockType

getLockType

isGetForUpdate

setGetForUpdate

setResourceKey

getResourceKey

setUriPath

getUriPath

setEndpointSettings

getEndpointSettings

setResourceVersion

getResourceVersion

getETagService

setETagService

setEmbeddedETag

getEmbeddedETag

getLockOwner

setLockOwner

getLockKey

setLockKey

getOverrideFilterId

setOverrideFilterId

getDeveloperOverrideFilterId

setDeveloperOverrideFilterId

getFilterDepth

setFilterDepth

getNestingDepth

getRelPath

setRelPath

getExpandResources

setExpandResources

getResourceUpdateInfo

setResourceUpdateInfo

getRequestAccepts

getResponseMediaType

setResponseMediaType

getLinks

setLinks

getCollectionLink

setCollectionLink

getFields

setFields