RestResourceRegistry.ResourceHolder (ATG Java API)

java.lang.Object
- atg.service.jaxrs.RestResourceRegistry.ResourceHolder

Enclosing class:

RestResourceRegistry
```
public static class RestResourceRegistry.ResourceHolder
extends java.lang.Object
```
Internal class that provides various maps for information on a rest resource. It is a container for a collection of resource settings since a resource conceptually can be across multiple class/component files where a resource settings holds information for a single class/component

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Set<RestResourceRegistry.EndpointSettings>`	`mAllEndpoints`
`protected java.util.Set<RestResourceRegistry.ResourceHolder>`	`mAllRootResourceHolders`
`protected java.util.Set<RestResourceRegistry.SubresourceLocatorSettings>`	`mAllSubresourceLocators`
`protected java.util.Set<java.lang.String>`	`mAllSubresources`
`protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>`	`mAllTemplates`
`protected RestResourceRegistry.EndpointSettings`	`mCollectionGETEndpoint`
`protected java.util.Set<java.lang.String>`	`mParentResources`
`protected java.lang.String`	`mPath`
`protected boolean`	`mReadOnly`
`protected RestResourceRegistry`	`mRegistry`
`protected java.lang.String`	`mResourceId`
`protected java.util.Map<java.lang.Class<?>,RestResourceRegistry.ResourceSettings>`	`mResourceSettings`
`protected RestResourceRegistry.EndpointSettings`	`mSingularGETEndpoint`
`protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Set<RestResourceRegistry.EndpointSettings>>>`	`mTemplatesByParentResourcePath`
`protected boolean`	`mTrackVersion`

Constructor Summary

Constructors
Constructor and Description

ResourceHolder(java.lang.String pResourceId, RestResourceRegistry pRegistry)
Constructor.

Constructors
Constructor and Description
`ResourceHolder(java.lang.String pResourceId, RestResourceRegistry pRegistry)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addParentResource(java.lang.String pParentResourceId)` Adds a set entry for the parent resources of this rest resource.
`protected void`	`addResourceSettings(RestResourceRegistry.ResourceSettings pResourceSettings)` Adds a resource settings to this resource info.
`protected void`	`determineRoots(RestResourceRegistry.ResourceHolder pResource, java.util.Set<RestResourceRegistry.ResourceHolder> pAllRoots)` Recursive method to traverse up through the parent resource references to the roots for this holder.
`java.util.Set<RestResourceRegistry.EndpointSettings>`	`getAllEndpointSettings()` Gets the set of all endpoint settings in this resource info
`java.util.Set<RestResourceRegistry.ResourceHolder>`	`getAllRootResourceHolders()` Return the set of root resource holders for this resource holder
`java.util.Set<RestResourceRegistry.SubresourceLocatorSettings>`	`getAllSubresourceLocators()` Gets all the subresource locator settings for this resource.
`java.util.Set<java.lang.String>`	`getAllSubresources()` Gets a set of all the subresource ids this resource can link to.
`java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>`	`getAllTemplates()` Gets the map of all endpoint template paths in this resource info where the key is the template uri path and the value is the endpoint settings it points to.
`RestResourceRegistry.EndpointSettings`	`getCollectionGETEndpoint()` Utility method to return the collection GET endpoint settings
`RestResourceRegistry.EndpointSettings`	`getEndpoint(java.lang.String pHttpMethod, boolean pSingular)` Returns an endpoint setting for this resource by matching against the http method and singular vs collection.
`java.util.Set<java.lang.String>`	`getParentResources()` Gets the set of parent resource ids.
`java.lang.String`	`getPath()` The top level path uri for the resource.
`RestResourceRegistry`	`getRegistry()` Gets the rest resource registry this resource belongs to
`java.lang.String`	`getResourceId()` Gets the id for the rest resource.
`RestResourceRegistry.ResourceSettings`	`getResourceSettings(java.lang.Class<?> pResourceClass)` Gets a resource settings in this resource info for the given resource class.
`java.util.Map<java.lang.Class<?>,RestResourceRegistry.ResourceSettings>`	`getResourceSettingsMap()` Gets the map of the resource settings for this resource keyed by the resource class.
`RestResourceRegistry.EndpointSettings`	`getSingularGETEndpoint()` Utility method to return the singular GET endpoint settings
`java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Set<RestResourceRegistry.EndpointSettings>>>`	`getTemplatesByParentResourcePath()` Gets a map of parent path to a map of template uri path to endpoint.
`protected void`	`initialize()` Initialize all of the various maps that keep track of endpoints, template paths and subresources associated with this resource.
`boolean`	`isReadOnly()` Method to determine if this resource is read-only, i.e.
`boolean`	`isSubresource()` Returns true if this is a subresource, i.e.
`protected void`	`setAllEndpointSettings(java.util.Set<RestResourceRegistry.EndpointSettings> pAllEndpointSettings)` Setter for the set of all endpoint settings in this resource info
`protected void`	`setAllRootResourceHolders(java.util.Set<RestResourceRegistry.ResourceHolder> pAllRootResourceHolders)` Stter for the set of root resource holders for this resource holder
`protected void`	`setAllSubresourceLocators(java.util.Set<RestResourceRegistry.SubresourceLocatorSettings> pAllSubresourceLocators)` Setter for all the subresource locator settings for this resource.
`protected void`	`setAllSubresources(java.util.Set<java.lang.String> pAllSubresources)` Setter for a set of all the subresource ids this resource can link to.
`protected void`	`setAllTemplates(java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> pAllTemplates)` Setter for the map of all endpoint template paths in this resource info where the key is the template uri path and the value is the endpoint settings it points to.
`protected void`	`setPath(java.lang.String pPath)` The top level path uri for the resource.
`protected void`	`setReadOnly(boolean pReadOnly)` Method to set if this resource is read-only, i.e.
`protected void`	`setRegistry(RestResourceRegistry pRegistry)` Sets the rest resource registry this resource belongs to
`protected void`	`setResourceId(java.lang.String pResourceId)` Sets the id for the rest resource.
`protected void`	`setResourceSettingsMap(java.util.Map<java.lang.Class<?>,RestResourceRegistry.ResourceSettings> pResourceSettings)` Sets the map of the resource settings for this resource keyed by the resource class.
`protected void`	`setTemplatesByParentResourcePath(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Set<RestResourceRegistry.EndpointSettings>>> pTemplatesByParentResourcePath)` Setter for a map of parent path to a map of template uri path to endpoint.
`protected void`	`setTrackVersion(boolean pTrackVersion)` Set to true if the framework should attempt to determine the version of this resource for inclusion in the ETag.
`boolean`	`shouldTrackVersion()` Returns true if the framework should attempt to determine the version of this resource for inclusion in the ETag.
`java.lang.String`	`toString()`

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

- Field Detail
  - mResourceId
```
protected java.lang.String mResourceId
```
  - mPath
```
protected java.lang.String mPath
```
  - mRegistry
```
protected RestResourceRegistry mRegistry
```
  - mResourceSettings
```
protected java.util.Map<java.lang.Class<?>,RestResourceRegistry.ResourceSettings> mResourceSettings
```
  - mAllEndpoints
```
protected java.util.Set<RestResourceRegistry.EndpointSettings> mAllEndpoints
```
  - mAllTemplates
```
protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> mAllTemplates
```
  - mTemplatesByParentResourcePath
```
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Set<RestResourceRegistry.EndpointSettings>>> mTemplatesByParentResourcePath
```
  - mSingularGETEndpoint
```
protected RestResourceRegistry.EndpointSettings mSingularGETEndpoint
```
  - mCollectionGETEndpoint
```
protected RestResourceRegistry.EndpointSettings mCollectionGETEndpoint
```
  - mParentResources
```
protected java.util.Set<java.lang.String> mParentResources
```
  - mAllSubresources
```
protected java.util.Set<java.lang.String> mAllSubresources
```
  - mAllSubresourceLocators
```
protected java.util.Set<RestResourceRegistry.SubresourceLocatorSettings> mAllSubresourceLocators
```
  - mAllRootResourceHolders
```
protected java.util.Set<RestResourceRegistry.ResourceHolder> mAllRootResourceHolders
```
  - mTrackVersion
```
protected boolean mTrackVersion
```
  - mReadOnly
```
protected boolean mReadOnly
```
- Constructor Detail
  - ResourceHolder
```
public ResourceHolder(java.lang.String pResourceId,
                      RestResourceRegistry pRegistry)
```
    Constructor. Takes the resource if and registry for this resource.
    
    Parameters:
    
    pResourceId - id of this resource info
    
    pRegistry - registry this resource belongs to
- Method Detail
  - initialize
```
protected void initialize()
```
    Initialize all of the various maps that keep track of endpoints, template paths and subresources associated with this resource. This initialization needs to take place anytime the resource settings for this resource change.
  - getResourceId
```
public java.lang.String getResourceId()
```
    Gets the id for the rest resource. The id must be unique across this registry. However it should be invariant across all registries for the same conceptual resource, e.g. v2 of a resource should have the same id as v1. By default this id comes from the RestResource annotation.
    
    Returns:
    
    The id for the rest resource.
  - setResourceId
```
protected void setResourceId(java.lang.String pResourceId)
```
    Sets the id for the rest resource. The id must be unique across this registry. However it should be invariant across all registries for the same conceptual resource, e.g. v2 of a resource should have the same id as v1. By default this id comes from the RestResource annotation.
    
    Parameters:
    
    pResourceId - The id for the Rest resource.
  - isReadOnly
```
public boolean isReadOnly()
```
    Method to determine if this resource is read-only, i.e. only has GET endpoints.
    
    Returns:
    
    true if it is read only otherwise false.
  - setReadOnly
```
protected void setReadOnly(boolean pReadOnly)
```
    Method to set if this resource is read-only, i.e. only has GET endpoints.
    
    Parameters:
    
    pReadOnly - true if it is read only otherwise false.
  - shouldTrackVersion
```
public boolean shouldTrackVersion()
```
    Returns true if the framework should attempt to determine the version of this resource for inclusion in the ETag. If no inherent version can be determined then the framework will persist an incremental version for the resource after each update. If version tracking is disabled then the ETag will not contain a version and If-Match and If-None-Match headers will not be usable for this resource.
    
    Returns:
    
    true if the framework should determine a version for the resource else false
  - setTrackVersion
```
protected void setTrackVersion(boolean pTrackVersion)
```
    Set to true if the framework should attempt to determine the version of this resource for inclusion in the ETag. If no inherent version can be determined then the framework will persist an incremental version for the resource after each update. If version tracking is disabled then the ETag will not contain a version and If-Match and If-None-Match headers will not be usable for this resource.
    
    Parameters:
    
    pTrackVersion - true if the framework should determine a version for the resource else false
  - getResourceSettingsMap
```
public java.util.Map<java.lang.Class<?>,RestResourceRegistry.ResourceSettings> getResourceSettingsMap()
```
    Gets the map of the resource settings for this resource keyed by the resource class.
    
    Returns:
    
    map of the resource settings for this resource keyed by the resource class.
  - setResourceSettingsMap
```
protected void setResourceSettingsMap(java.util.Map<java.lang.Class<?>,RestResourceRegistry.ResourceSettings> pResourceSettings)
```
    Sets the map of the resource settings for this resource keyed by the resource class.
    
    Parameters:
    
    pResourceSettings - map of the resource settings for this resource keyed by the resource class.
  - getResourceSettings
```
public RestResourceRegistry.ResourceSettings getResourceSettings(java.lang.Class<?> pResourceClass)
```
    Gets a resource settings in this resource info for the given resource class.
    
    Parameters:
    
    pResourceClass - class of the resource settings to retrieve
    
    Returns:
    
    resource settings for the given class
  - addResourceSettings
```
protected void addResourceSettings(RestResourceRegistry.ResourceSettings pResourceSettings)
```
    Adds a resource settings to this resource info.
    
    Parameters:
    
    pResourceSettings - resource settings to add
  - getRegistry
```
public RestResourceRegistry getRegistry()
```
    Gets the rest resource registry this resource belongs to
    
    Returns:
    
    rest resource registry this resource belongs to
  - setRegistry
```
protected void setRegistry(RestResourceRegistry pRegistry)
```
    Sets the rest resource registry this resource belongs to
    
    Parameters:
    
    pRegistry - rest resource registry this resource belongs to
  - getPath
```
public java.lang.String getPath()
```
    The top level path uri for the resource. For subresources this will be null.
    
    Returns:
    
    the top level path uri for the resource.
  - setPath
```
protected void setPath(java.lang.String pPath)
```
    The top level path uri for the resource. For subresources this will be null.
    
    Parameters:
    
    pPath - the top level path uri for the resource.
  - getAllEndpointSettings
```
public java.util.Set<RestResourceRegistry.EndpointSettings> getAllEndpointSettings()
```
    Gets the set of all endpoint settings in this resource info
    
    Returns:
    
    the set of all endpoint settings in this resource info
  - setAllEndpointSettings
```
protected void setAllEndpointSettings(java.util.Set<RestResourceRegistry.EndpointSettings> pAllEndpointSettings)
```
    Setter for the set of all endpoint settings in this resource info
    
    Parameters:
    
    pAllEndpointSettings - the set of all endpoint settings in this resource info
  - getAllTemplates
```
public java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> getAllTemplates()
```
    Gets the map of all endpoint template paths in this resource info where the key is the template uri path and the value is the endpoint settings it points to.
    
    Returns:
    
    the map of all template paths keyed by path with endpoint settings value in this resource info
  - setAllTemplates
```
protected void setAllTemplates(java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> pAllTemplates)
```
    Setter for the map of all endpoint template paths in this resource info where the key is the template uri path and the value is the endpoint settings it points to.
    
    Parameters:
    
    pAllTemplates - the map of all template paths keyed by path with endpoint settings value in this resource info
  - getTemplatesByParentResourcePath
```
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Set<RestResourceRegistry.EndpointSettings>>> getTemplatesByParentResourcePath()
```
    Gets a map of parent path to a map of template uri path to endpoint. This is used for the logic to determine the links to add to a representation.
    
    Returns:
    
    map keyed by parent uri path where the value is a map keyed by endpoint template path to endpoint value
  - setTemplatesByParentResourcePath
```
protected void setTemplatesByParentResourcePath(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Set<RestResourceRegistry.EndpointSettings>>> pTemplatesByParentResourcePath)
```
    Setter for a map of parent path to a map of template uri path to endpoint. This is used for the logic to determine the links to add to a representation.
    
    Parameters:
    
    pTemplatesByParentResourcePath - map keyed by parent uri path where the value is a map keyed by endpoint template path to endpoint value
  - getEndpoint
```
public RestResourceRegistry.EndpointSettings getEndpoint(java.lang.String pHttpMethod,
                                                         boolean pSingular)
```
    Returns an endpoint setting for this resource by matching against the http method and singular vs collection.
    
    Parameters:
    
    pHttpMethod - http method the endpoint uses
    
    pSingular - true if the endpoint is for the singular resource
    
    Returns:
    
    the endpoint settings for the matching endpoint or null if not found
  - getSingularGETEndpoint
```
public RestResourceRegistry.EndpointSettings getSingularGETEndpoint()
```
    Utility method to return the singular GET endpoint settings
    
    Returns:
    
    the singular GET endpoint settings for this resource
  - getCollectionGETEndpoint
```
public RestResourceRegistry.EndpointSettings getCollectionGETEndpoint()
```
    Utility method to return the collection GET endpoint settings
    
    Returns:
    
    the collection GET endpoint settings for this resource
  - addParentResource
```
protected void addParentResource(java.lang.String pParentResourceId)
```
    Adds a set entry for the parent resources of this rest resource. If this set is empty then this resource is a top level resource and has no parents.
    
    Parameters:
    
    pParentResourceId - The id for a parent resource of this rest resource.
  - getParentResources
```
public java.util.Set<java.lang.String> getParentResources()
```
    Gets the set of parent resource ids. If this set is empty then this resource is a top level resource and has no parents.
    
    Returns:
    
    The set of parent resource ids.
  - isSubresource
```
public boolean isSubresource()
```
    Returns true if this is a subresource, i.e. no parents
    
    Returns:
    
    true if this is a subresource, i.e. no parents
  - getAllSubresourceLocators
```
public java.util.Set<RestResourceRegistry.SubresourceLocatorSettings> getAllSubresourceLocators()
```
    Gets all the subresource locator settings for this resource.
    
    Returns:
    
    set of subresource locator settings for this resource
  - setAllSubresourceLocators
```
protected void setAllSubresourceLocators(java.util.Set<RestResourceRegistry.SubresourceLocatorSettings> pAllSubresourceLocators)
```
    Setter for all the subresource locator settings for this resource.
    
    Parameters:
    
    pAllSubresourceLocators - set of subresource locator settings for this resource
  - getAllSubresources
```
public java.util.Set<java.lang.String> getAllSubresources()
```
    Gets a set of all the subresource ids this resource can link to.
    
    Returns:
    
    set of string subresource ids this resource can link to
  - setAllSubresources
```
protected void setAllSubresources(java.util.Set<java.lang.String> pAllSubresources)
```
    Setter for a set of all the subresource ids this resource can link to.
    
    Parameters:
    
    pAllSubresources - set of string subresource ids this resource can link to
  - getAllRootResourceHolders
```
public java.util.Set<RestResourceRegistry.ResourceHolder> getAllRootResourceHolders()
```
    Return the set of root resource holders for this resource holder
    
    Returns:
    
    set of ResourceHolder roots
  - setAllRootResourceHolders
```
protected void setAllRootResourceHolders(java.util.Set<RestResourceRegistry.ResourceHolder> pAllRootResourceHolders)
```
    Stter for the set of root resource holders for this resource holder
    
    Parameters:
    
    pAllRootResourceHolders - set of ResourceHolder roots
  - determineRoots
```
protected void determineRoots(RestResourceRegistry.ResourceHolder pResource,
                              java.util.Set<RestResourceRegistry.ResourceHolder> pAllRoots)
```
    Recursive method to traverse up through the parent resource references to the roots for this holder.
    
    Parameters:
    
    pResource - current resource holder to be processed
    
    pAllRoots - Set of all roots found so far
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class RestResourceRegistry.ResourceHolder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mResourceId

mPath

mRegistry

mResourceSettings

mAllEndpoints

mAllTemplates

mTemplatesByParentResourcePath

mSingularGETEndpoint

mCollectionGETEndpoint

mParentResources

mAllSubresources

mAllSubresourceLocators

mAllRootResourceHolders

mTrackVersion

mReadOnly

Constructor Detail

ResourceHolder

Method Detail

initialize

getResourceId

setResourceId

isReadOnly

setReadOnly

shouldTrackVersion

setTrackVersion

getResourceSettingsMap

setResourceSettingsMap

getResourceSettings

addResourceSettings

getRegistry

setRegistry

getPath

setPath

getAllEndpointSettings

setAllEndpointSettings

getAllTemplates

setAllTemplates

getTemplatesByParentResourcePath

setTemplatesByParentResourcePath

getEndpoint

getSingularGETEndpoint

getCollectionGETEndpoint

addParentResource

getParentResources

isSubresource

getAllSubresourceLocators

setAllSubresourceLocators

getAllSubresources

setAllSubresources

getAllRootResourceHolders

setAllRootResourceHolders

determineRoots

toString