atg.service.jaxrs

Class RestResourceRegistry.ResourceSettings

java.lang.Object

atg.service.jaxrs.RestResourceRegistry.ResourceSettings

Enclosing class:

RestResourceRegistry

public static class RestResourceRegistry.ResourceSettings
extends java.lang.Object

A container for the setting of a RestResource class/component. Note, a resource conceptually can exist across multiple classes/components that share the same path. This internal class only holds information for a single class/component. The RestResourceInfo class holds information across the entire resource.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<RestResourceRegistry.EndpointSettings>	mEndpoints The set of endpoints in the rest resource.
protected java.lang.Object	mNucleusInstance Nucleus instance.
protected java.lang.String	mNucleusPath Nucleus path.
protected java.lang.Class<?>	mResourceClass The class for the resource
protected RestResourceRegistry.ResourceHolder	mResourceHolder The resource info for this resource settings
protected java.util.Set<RestResourceRegistry.SubresourceLocatorSettings>	mSubresourceLocators The set of subresource locator settings for this resource

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResourceSettings(RestResourceRegistry.ResourceHolder pResourceHolder, java.lang.Class<?> pResourceClass) Constructor.

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<RestResourceRegistry.EndpointSettings>	getEndpoints() Gets the set of endpoints in the rest resource.
java.lang.Object	getNucleusInstance() Get the Nucleus instance.
java.lang.String	getNucleusPath() Get the Nucleus Path for the resource.
java.lang.Class<?>	getResourceClass() Returns the class for the resource.
RestResourceRegistry.ResourceHolder	getResourceHolder() Gets the resource holder for this resource settings.
protected java.util.Set<RestResourceRegistry.SubresourceLocatorSettings>	getSubresourceLocators() Gets the set of subresource locator settings to uri path for this rest resource.
protected java.util.Set<java.lang.String>	getSubresources() Gets a set of all the subresource ids this resource settings can link to.
protected void	setEndpoints(java.util.Set<RestResourceRegistry.EndpointSettings> pEndpoints) Sets the set of endpoints in the rest resource.
protected void	setNucleusInstance(java.lang.Object pNucleusInstance) Set the Nucleus instance.
protected void	setNucleusPath(java.lang.String pNucleusPath) Set the Nucleus Path for the resource.
protected void	setResourceClass(java.lang.Class<?> pResourceClass) Sets the class for the resource.
protected void	setResourceHolder(RestResourceRegistry.ResourceHolder pResourceHolder) Sets the resource holder for this resource settings.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

mResourceHolder

protected RestResourceRegistry.ResourceHolder mResourceHolder

The resource info for this resource settings

mResourceClass

protected java.lang.Class<?> mResourceClass

The class for the resource

mNucleusPath

protected java.lang.String mNucleusPath

Nucleus path. If set and nucleusInstance is null then the resource instance will be resolved by the RestEndpointInvocationHandler before invoking it.

mNucleusInstance

protected java.lang.Object mNucleusInstance

Nucleus instance. If set then the RestEndpointInvocationHandler will use it for endpoint invocation. It is also used by the resource lookup service for subresource location. Only global nucleus components will have this set.

mSubresourceLocators

protected java.util.Set<RestResourceRegistry.SubresourceLocatorSettings> mSubresourceLocators

The set of subresource locator settings for this resource

mEndpoints

protected java.util.Set<RestResourceRegistry.EndpointSettings> mEndpoints

The set of endpoints in the rest resource.

Constructor Detail

ResourceSettings

protected ResourceSettings(RestResourceRegistry.ResourceHolder pResourceHolder,
                           java.lang.Class<?> pResourceClass)

Constructor. Takes the resource info container and the resource class for this resource settings

Method Detail

getResourceHolder

public RestResourceRegistry.ResourceHolder getResourceHolder()

Gets the resource holder for this resource settings. A resource settings represents a single class/component of a resource however conceptually a resource can extend over multiple classes/components and this is encapsulated in the resource holder.

Returns:

the resource holder for this resource settings

setResourceHolder

protected void setResourceHolder(RestResourceRegistry.ResourceHolder pResourceHolder)

Sets the resource holder for this resource settings. A resource settings represents a single class/component of a resource however conceptually a resource can extend over multiple classes/components and this is encapsulated in the resource holder.

Parameters:

pResourceHolder - the resource holder for this resource settings

getResourceClass

public java.lang.Class<?> getResourceClass()

Returns the class for the resource. May be used for subresource locator methods.

Returns:

the class of the resource

setResourceClass

protected void setResourceClass(java.lang.Class<?> pResourceClass)

Sets the class for the resource. May be used for subresource locator methods.

Parameters:

pResourceClass - the class of the resource

getNucleusPath

public java.lang.String getNucleusPath()

Get the Nucleus Path for the resource.

Returns:

The Nucleus Path for the resource.

setNucleusPath

protected void setNucleusPath(java.lang.String pNucleusPath)

Set the Nucleus Path for the resource.

Parameters:

pNucleusPath - the Nucleus Path for the resource.

getNucleusInstance

public java.lang.Object getNucleusInstance()

Get the Nucleus instance. If set then the RestEndpointInvocationHandler will use it for endpoint invocation. It is also used by the resource lookup service for subresource location. Only global nucleus components will have this set.

Returns:

The Nucleus instance for the resource.

setNucleusInstance

protected void setNucleusInstance(java.lang.Object pNucleusInstance)

Set the Nucleus instance. If set then the RestEndpointInvocationHandler will use it for endpoint invocation. It is also used by the resource lookup service for subresource location. Only global nucleus components will have this set.

Parameters:

pNucleusInstance - the Nucleus instance for the resource.

getSubresourceLocators

protected java.util.Set<RestResourceRegistry.SubresourceLocatorSettings> getSubresourceLocators()

Gets the set of subresource locator settings to uri path for this rest resource.

Returns:

The set of subresource locator settings for this rest resource.

getSubresources

protected java.util.Set<java.lang.String> getSubresources()

Gets a set of all the subresource ids this resource settings can link to.

Returns:

set of string subresource ids this resource settings can link to

setEndpoints

protected void setEndpoints(java.util.Set<RestResourceRegistry.EndpointSettings> pEndpoints)

Sets the set of endpoints in the rest resource.

Parameters:

pEndpoints - The set of endpoints in the rest resource.

getEndpoints

protected java.util.Set<RestResourceRegistry.EndpointSettings> getEndpoints()

Gets the set of endpoints in the rest resource.

Returns:

The set of endpoints in the rest resource.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object