atg.service.jaxrs

Class RestResourceRegistry

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.jaxrs.RestResourceRegistry

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class RestResourceRegistry
extends GenericService

This service handles the task of collecting all rest endpoints into a map. It also deals with scanning for rest security annotations and configuring security for endpoints.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestResourceRegistry.EndpointSettings A container for storing the settings of an endpoint method.
static class	RestResourceRegistry.ResourceHolder Internal class that provides various maps for information on a rest resource.
static class	RestResourceRegistry.ResourceSettings A container for the setting of a RestResource class/component.
static class	RestResourceRegistry.RestResourceRegistryAdminServlet Endpoint registry admin servlet.
class	RestResourceRegistry.SubresourceLocatorSettings Inner class to hold details about a subresource locator method for a resource
protected static interface	RestResourceRegistry.TreeCheckCondition Interface for checking the condition of a class for use with the tree checker.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string.
static java.lang.String	COLON
static java.lang.String	DEFAULT_ACCESS_CONTROLLER_MAP_KEY Map key for default access controller id configured on endpoint annotation
static java.lang.String	DOC_ENDPOINTS
static java.lang.String	DOC_IMPL_CLASS
static java.lang.String	DOC_PATH_PARAMS
static java.lang.String	DOC_REQUEST
static java.lang.String	DOC_RESOURCE_DESCRIPTION
static java.lang.String	DOC_RESOURCE_DISPLAY_NAME
static java.lang.String	DOC_RESPONSE
static java.lang.String	DOC_SAMPLE_REQUEST
static java.lang.String	DOC_SAMPLE_RESPONSE
static java.lang.String	DOUBLE_SLASH
static java.lang.String	JAXRS_ANNOTATIONS_PACKAGE_NAME
static java.lang.String	LEFT_CURLY
protected java.util.Map<java.lang.Class<?>,java.util.Map<java.lang.String,java.lang.Object>>	mClassToResourceMap Map from implementation class to corresponding json.
protected java.util.Map<java.lang.String,java.lang.Class<?>>	mComponentClasses Map of nucleus rest resource classes keyed by nucleus component path
protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>	mEndpointsByIdMap Map containing all endpoints keyed by endpoint id.
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>>	mEndpointsByPathMap Map containing all endpoints keyed on the template path.
protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>	mEndpointsMap Map containing all endpoints keyed by class/method key, see createKey(Class,Method).
protected boolean	mFullPaths property: fullPaths - boolean flag, true to render full paths for uris
protected java.util.Map<java.lang.String,java.lang.Object>	mGlobalComponents Map of global nucleus rest resource component instances keyed by nucleus path
protected JAXRSApplicationRegistry	mJAXRSApplicationRegistry property: jaxrsApplicationRegistry.
protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>	mKnownLinkRelations Map holding known link relations.
protected LinkUtils	mLinkUtils property: linkUtils.
protected java.lang.Object[]	mNucleusProviders property: nucleusProviders.
protected java.lang.String[]	mProviderClassNames property: providerClassNames.
protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>	mPublicEndpointsMap Map containing public only endpoints.
protected java.util.Map<java.lang.String,RestResourceRegistry.ResourceHolder>	mResourceHolders Map of all resource holder keyed by resource id.
protected java.lang.Class<? extends RestContext>	mRestContextClass property: restContextClass.
protected java.lang.Class<?>[]	mRestResourceClasses property: restResourceClasses.
protected RestUtils	mRestUtils property: restUtils.
protected java.util.Set<RestResourceRegistry.ResourceHolder>	mRootResourceHolders Set of top level root resource infos, i.e.
protected boolean	mWarnForWrongContext property: warnForWrongContext.
static java.lang.String	PARAM_PLACEHOLDER
protected static java.lang.String	RESOURCE_BUNDLE_NAME Resource Bundle Name.
static java.lang.String	RIGHT_CURLY
static java.lang.String	SLASH

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
RestResourceRegistry()

Method Summary

Modifier and Type	Method and Description
void	addResourceHolder(RestResourceRegistry.ResourceHolder pResourceHolder) Adds a new resource holder to the map of all resource holder keyed by resource id.
protected void	addRootResourceHolder(java.lang.String pResourceId) Sets a resource holder as a root, i.e.
protected java.lang.Object	atgJsonToOrgJson(java.lang.Object pObject) Convert from atgJson to standard JSON.
java.util.Set<java.lang.String>	buildResourcePaths(RestResourceRegistry.ResourceHolder pResourceHolder)
java.lang.String	buildResourceUriTemplatePath(java.lang.String pContextPath, java.lang.String pResourceId, boolean pSingular, java.lang.String... pPathParams) Constructs a template path for a resource.
protected void	buildTemplates(RestResourceRegistry.ResourceHolder pResourceHolder) Build all the endpoint uri templates for the given resource info.
protected java.lang.String	checkForHttpMethod(java.lang.reflect.Method pMethod) Check that the passed in method is annotated with a http method and returns the String equivalent.
protected java.lang.reflect.Method	checkForPostMatchMethod(java.lang.reflect.Method pEndpointMethod, java.lang.Class<?> pResourceClass) Checks for any post action methods for the endpoint method passed in.
protected java.lang.reflect.Method	checkForPreMatchMethod(java.lang.reflect.Method pEndpointMethod, java.lang.Class<?> pResourceClass) Checks for any pre action methods for the endpoint method passed in.
protected void	checkForRequestResponseTypes(java.lang.reflect.Method pMethod, RestResourceRegistry.EndpointSettings pEndpoint) Checks the method for request/response annotations and sets the passed in endpoint setting object appropriately.
protected void	checkForWrongContext() Outputs a warning log message if this registry does not have a context root that matches the current rest context registry.
protected javax.servlet.Servlet	createAdminServlet() Creates the admin servlet that can be used to display information about the RestResource registry in dyn/admin.
protected RestResourceRegistry.EndpointSettings	createEndpointSettings(RestResourceRegistry.ResourceSettings pResourceSettings, java.lang.reflect.Method pMethod, java.lang.String pHttpMethod) Creates the endpoint settings for an endpoint method.
java.lang.String	createKey() Returns the key to the rest resource in the current rest context.
java.lang.String	createKey(java.lang.Class pClass, java.lang.reflect.Method pMethod) Generates a key that can be used to identify an endpoint.
RestContext	createRestContext() Instantiates a new RestContext for a request.
protected void	doScanEndpoints() Builds up a number of maps containing endpoint information.
void	doStartService() Executes when the service starts up.
protected java.lang.Class	findAnnotatedClass(java.lang.Class<?> pClass, java.lang.Class<? extends java.lang.annotation.Annotation> pAnnotation) Scans the up the hierarchy of the class specified to find a class with the annotation specified.
protected java.lang.reflect.Method	findAnnotatedMethod(java.lang.reflect.Method pMethod, java.lang.Class<? extends java.lang.annotation.Annotation> pAnnotation) Scans the up the hierarchy of the class specified to find a method with the annotation specified.
java.util.Set<java.lang.Class<?>>	getAllResourceClasses() Gets a set of all the resource classes in the registry.
java.lang.String[]	getAuthRequiredAccessTypes() get AuthRequiredAccessTypes.
protected java.lang.annotation.Annotation	getClassAnnotation(java.lang.Class<?> pClass, java.lang.Class<? extends java.lang.annotation.Annotation> pAnnotationClass) Searches the given class and its super classes/interfaces to find an annotation for the given annotation class.
protected java.util.Map<java.lang.Class<?>,java.util.Map<java.lang.String,java.lang.Object>>	getClassToResourceMap() Returns the implementation class to corresponding json.
java.lang.String	getContextRoot() Get ContextRoot.
protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>	getEndpointsByIdMap() Get all the endpoints keyed by endpoint id.
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>>	getEndpointsByPathMap() Get all the endpoints keyed and sorted by template path.
RestResourceRegistry.EndpointSettings	getEndpointSettings() Gets the current endpoint settings based on the current rest resource in the current rest context.
RestResourceRegistry.EndpointSettings	getEndpointSettings(java.lang.String pPath, java.lang.String pHttpMethod) Gets the endpoint settings for a specific path and http method.
protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>	getEndpointsMap() Get all of the endpoints keyed by class/method key.
protected java.util.Map<java.lang.String,java.lang.Object>	getGlobalNucleusRestResourceComponents() Returns references to any global nucleus rest resource components.
protected static java.util.Set<java.lang.Class<?>>	getInheritance(java.lang.Class<?> pClass) Utility method to get the inherited classes and implemented interfaces of the specified class.
JAXRSApplicationRegistry	getJAXRSApplicationRegistry() Reference to the jaxrs application registry.
protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>	getKnownLinkRelations() Returns a map of known link relations keyed by relation with value of endpoint settings.
LinkUtils	getLinkUtils() Reference to a link utils component.
int	getMaxWildcards() Returns MaxWildcards.
protected java.lang.String	getMethodPath(java.lang.reflect.Method pMethod) Determines the uri path for an endpoint method by looking for a Path annotation.
protected java.lang.Class<?>[]	getNonGlobalNucleusRestResourceClasses() Returns the classes for any configured non global nucleus rest resources.
java.lang.Object[]	getNucleusProviders() Get an array of configured provider nucleus component instances, e.g.
protected java.util.Map<java.lang.String,java.lang.Class<?>>	getNucleusRestResourceClasses() Gets a map of all nucleus rest resource classes in the registry keyed by component path.
java.lang.String[]	getNucleusRestResources() Get the component paths for the nucleus rest resources.
protected int	getNumberOfWildcardsInPath(java.lang.String pPath) Returns a count of the number of wildcards in the template path.
RestResourceRegistry.ResourceSettings	getOrCreateResourceSettings(java.lang.String pResourceId, java.lang.Class<?> pResourceClass) Get a resource settings by id or create a new entry if needed.
protected java.lang.Class<?>[]	getProviderClasses() Get the provider classes.
java.lang.String[]	getProviderClassNames() Get the provider class names.
protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>	getPublicEndpointsMap() Get the public endpoints keyed by class/method key.
RelationsRegistry	getRelationsRegistry() Get RelationsRegistry.
atg.service.jaxrs.cache.RepresentationCache	getRepresentationCache() Returns the representationCache property.
protected static java.lang.String	getResource(java.lang.String pResourceKey) Returns a user message from the resource bundle based on the user's locale.
protected static java.lang.String	getResource(java.lang.String pResourceKey, java.lang.Object... pArgs) Returns a user message from the resource bundle based on the user's locale.
RestResourceRegistry.ResourceHolder	getResourceHolder(java.lang.String pResourceId) Gets the resource holder for the given resource id
java.util.Map<java.lang.String,RestResourceRegistry.ResourceHolder>	getResourceHolders() Gets the map of all resource holder keyed by resource id.
atg.service.jaxrs.ResourceLookupService	getResourceLookupService() Get ResourceLookupService.
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	getResourceMap() Get ResourceMap.
java.lang.Class<? extends RestContext>	getRestContextClass() Class to instantiate to hold the rest context for a request.
atg.service.jaxrs.RestLockService	getRestLockService() Returns the restLockService property.
java.lang.Class<?>[]	getRestResourceClasses() Get the classes for rest resources that cannot be nucleus components, usually because they want their scope to be managed by the jaxrs provider instead.
RestUtils	getRestUtils() Reference to a RestUtils component.
java.util.Set<RestResourceRegistry.ResourceHolder>	getRootResourceHolders() Gets the set of resource holder for the root resources, i.e.
java.lang.Object	getSubresource(java.lang.String pSubresourceId) Returns an object that can be returned from a subresource locator method for the given subresource id.
java.lang.Object	getSubresourceByEndpointId(java.lang.String pEndpointId) Returns an object that can be returned from a subresource locator method for the given endpoint method id.
java.lang.String	getTerminationDate() Returns a string describing when the api version represented by this registry will not become deprecated and will not be actively supported.
protected java.lang.String	getTopUrl(java.lang.Class pClass) Returned the URL as specified by the path annotation on the class.
javax.transaction.TransactionManager	getTransactionManager() Get TransactionManager.
atg.service.jaxrs.ValidationService	getValidationService()
java.lang.String	getVersion() Method to try and parse the version from the context root.
boolean	getWarnForWrongContext() Flag, true if this registry should output a warning log if public methods are accessed and this registry context root does not match the current rest context registry context root.
protected boolean	hasAnnotation(java.lang.Class<?> pClass, java.lang.Class<? extends java.lang.annotation.Annotation> pAnnotation) Determines whether a class contains an annotation.
protected boolean	hasJAXRSFieldAnnotation(java.lang.Class pClass) Determines if the class has an JAXRS specific annotation.
boolean	isActive() Returns true if the api version represented by this registry has not been deprecated and is actively supported.
boolean	isAddJsonDocSkeletons() Returns property addJsonDocSkeletons.
boolean	isEnableCrossDomainRequests() Get EnableCrossDomainRequests.
boolean	isPublicOnlyEndpoints() Get PublicOnlyEndpoints.
protected java.lang.String	methodPathPlaceholderParams(java.lang.String pPath) Get a method path with any param levels turned into generic placeholders.
protected RestResourceRegistry.ResourceSettings	processRestResourceClass(java.lang.Class pClass, java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> pTempPublicEndpointsMap, java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> pTempEndpointsMap, java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> pTempEndpointsByIdMap) Processes each rest resource class to extract endpoint information from them.
protected java.util.Set<java.lang.String>	recursePaths(RestResourceRegistry.ResourceHolder pResource, java.util.Set<java.lang.String> pPaths)
protected void	scanEndpoints() Builds up a number of maps containing endpoint information.
void	setActive(boolean pActive) Set to true if the api version represented by this registry has not been deprecated and is actively supported.
void	setAddJsonDocSkeletons(boolean pAddJsonDocSkeletons) Sets property addJsonDocSkeletons.
void	setAuthRequiredAccessTypes(java.lang.String[] pAuthRequiredAccessTypes) set AuthRequiredAccessTypes.
void	setContextRoot(java.lang.String pContextRoot) Set ContextRoot.
void	setEnableCrossDomainRequests(boolean pEnableCrossDomainRequests) Set EnableCrossDomainRequests.
void	setFullPaths(boolean pFullPaths) Setter for the boolean property which is true if full paths should be used rather than absolute paths.
void	setJAXRSApplicationRegistry(JAXRSApplicationRegistry pJAXRSApplicationRegistry) Reference to the jaxrs application registry.
void	setLinkUtils(LinkUtils pLinkUtils) Reference to a LinkUtils component.
void	setMaxWildcards(int pMaxWildcards) Set MaxWildcards property.
void	setNucleusProviders(java.lang.Object[] pNucleusProviders) Set an array of configured provider component instances, e.g.
void	setNucleusRestResources(java.lang.String[] pNucleusRestResources) Set the component paths for the nucleus rest resources.
void	setProviderClassNames(java.lang.String[] pProviderClassNames) Set the provider class names.
void	setPublicOnlyEndpoints(boolean pPublicOnlyEndpoints) Set PublicOnlyEndpoints.
void	setRelationsRegistry(RelationsRegistry pRelationsRegistry) Set RelationsRegistry.
void	setRepresentationCache(atg.service.jaxrs.cache.RepresentationCache pRepresentationCache) Returns the representationcache property.
void	setResourceHolders(java.util.Map<java.lang.String,RestResourceRegistry.ResourceHolder> pResourceHolders) Sets the map of all resource holder keyed by resource id.
void	setResourceLookupService(atg.service.jaxrs.ResourceLookupService pResourceLookupService) Set ResourceLookupService.
protected void	setResourceMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> pResourceMap) Set ResourceMap.
void	setRestContextClass(java.lang.Class<? extends RestContext> pRestContextClass) Class to instantiate to hold the rest context for a request.
void	setRestLockService(atg.service.jaxrs.RestLockService pRestLockService) Returns the restLockService property.
void	setRestResourceClasses(java.lang.Class<?>[] pRestResourceClasses) Set the classes for rest resources that cannot be nucleus components, usually because they want their scope to be managed by the jaxrs provider instead.
void	setRestUtils(RestUtils pRestUtils) Reference to a RestUtils component.
void	setTerminationDate(java.lang.String pTerminationDate) Sets a string describing when the api version represented by this registry will not become deprecated and will not be actively supported.
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager) set TransactionManager.
void	setValidationService(atg.service.jaxrs.ValidationService pValidationService)
void	setWarnForWrongContext(boolean pWarnForWrongContext) Flag, true if this registry should output a warning log if public methods are accessed and this registry context root does not match the current rest context registry context root.
boolean	useFullPaths() Getter for the boolean property which is true if full paths should be used rather than absolute paths.

Methods inherited from class atg.nucleus.GenericService

addLogListener, 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, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string.

See Also:

Constant Field Values

RESOURCE_BUNDLE_NAME

protected static final java.lang.String RESOURCE_BUNDLE_NAME

Resource Bundle Name.

See Also:

Constant Field Values

LEFT_CURLY

public static final java.lang.String LEFT_CURLY

See Also:

Constant Field Values

RIGHT_CURLY

public static final java.lang.String RIGHT_CURLY

See Also:

Constant Field Values

SLASH

public static final java.lang.String SLASH

See Also:

Constant Field Values

DOUBLE_SLASH

public static final java.lang.String DOUBLE_SLASH

See Also:

Constant Field Values

PARAM_PLACEHOLDER

public static final java.lang.String PARAM_PLACEHOLDER

See Also:

Constant Field Values

COLON

public static final java.lang.String COLON

See Also:

Constant Field Values

DEFAULT_ACCESS_CONTROLLER_MAP_KEY

public static final java.lang.String DEFAULT_ACCESS_CONTROLLER_MAP_KEY

Map key for default access controller id configured on endpoint annotation

See Also:

Constant Field Values

DOC_RESOURCE_DISPLAY_NAME

public static final java.lang.String DOC_RESOURCE_DISPLAY_NAME

See Also:

Constant Field Values

DOC_RESOURCE_DESCRIPTION

public static final java.lang.String DOC_RESOURCE_DESCRIPTION

See Also:

Constant Field Values

DOC_ENDPOINTS

public static final java.lang.String DOC_ENDPOINTS

See Also:

Constant Field Values

DOC_IMPL_CLASS

public static final java.lang.String DOC_IMPL_CLASS

See Also:

Constant Field Values

DOC_PATH_PARAMS

public static final java.lang.String DOC_PATH_PARAMS

See Also:

Constant Field Values

DOC_SAMPLE_RESPONSE

public static final java.lang.String DOC_SAMPLE_RESPONSE

See Also:

Constant Field Values

DOC_SAMPLE_REQUEST

public static final java.lang.String DOC_SAMPLE_REQUEST

See Also:

Constant Field Values

DOC_REQUEST

public static final java.lang.String DOC_REQUEST

See Also:

Constant Field Values

DOC_RESPONSE

public static final java.lang.String DOC_RESPONSE

See Also:

Constant Field Values

JAXRS_ANNOTATIONS_PACKAGE_NAME

public static final java.lang.String JAXRS_ANNOTATIONS_PACKAGE_NAME

See Also:

Constant Field Values

mPublicEndpointsMap

protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> mPublicEndpointsMap

Map containing public only endpoints.

mEndpointsByIdMap

protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> mEndpointsByIdMap

Map containing all endpoints keyed by endpoint id.

mEndpointsMap

protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> mEndpointsMap

Map containing all endpoints keyed by class/method key, see createKey(Class,Method).

mEndpointsByPathMap

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>> mEndpointsByPathMap

Map containing all endpoints keyed on the template path. The value is a child map of http method to endpoint settings.

mGlobalComponents

protected java.util.Map<java.lang.String,java.lang.Object> mGlobalComponents

Map of global nucleus rest resource component instances keyed by nucleus path

mComponentClasses

protected java.util.Map<java.lang.String,java.lang.Class<?>> mComponentClasses

Map of nucleus rest resource classes keyed by nucleus component path

mResourceHolders

protected java.util.Map<java.lang.String,RestResourceRegistry.ResourceHolder> mResourceHolders

Map of all resource holder keyed by resource id.

mRootResourceHolders

protected java.util.Set<RestResourceRegistry.ResourceHolder> mRootResourceHolders

Set of top level root resource infos, i.e. no parents

mKnownLinkRelations

protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> mKnownLinkRelations

Map holding known link relations.

mFullPaths

protected boolean mFullPaths

property: fullPaths - boolean flag, true to render full paths for uris

mJAXRSApplicationRegistry

protected JAXRSApplicationRegistry mJAXRSApplicationRegistry

property: jaxrsApplicationRegistry.

mRestContextClass

protected java.lang.Class<? extends RestContext> mRestContextClass

property: restContextClass.

mLinkUtils

protected LinkUtils mLinkUtils

property: linkUtils.

mRestUtils

protected RestUtils mRestUtils

property: restUtils.

mWarnForWrongContext

protected boolean mWarnForWrongContext

property: warnForWrongContext.

mProviderClassNames

protected java.lang.String[] mProviderClassNames

property: providerClassNames.

mNucleusProviders

protected java.lang.Object[] mNucleusProviders

property: nucleusProviders.

mRestResourceClasses

protected java.lang.Class<?>[] mRestResourceClasses

property: restResourceClasses.

mClassToResourceMap

protected java.util.Map<java.lang.Class<?>,java.util.Map<java.lang.String,java.lang.Object>> mClassToResourceMap

Map from implementation class to corresponding json.

Constructor Detail

RestResourceRegistry

public RestResourceRegistry()

Method Detail

getResourceHolders

public java.util.Map<java.lang.String,RestResourceRegistry.ResourceHolder> getResourceHolders()

Gets the map of all resource holder keyed by resource id.

Returns:

the map of all resource holder keyed by resource id.

setResourceHolders

public void setResourceHolders(java.util.Map<java.lang.String,RestResourceRegistry.ResourceHolder> pResourceHolders)

Sets the map of all resource holder keyed by resource id.

Parameters:

pResourceHolders - map of all resource holder keyed by resource id.

getResourceHolder

public RestResourceRegistry.ResourceHolder getResourceHolder(java.lang.String pResourceId)

Gets the resource holder for the given resource id

Parameters:

pResourceId - id of the resource holder to return

Returns:

the resource holder for the given resource id

addResourceHolder

public void addResourceHolder(RestResourceRegistry.ResourceHolder pResourceHolder)

Adds a new resource holder to the map of all resource holder keyed by resource id.

Parameters:

pResourceHolder - resource holder to add

getRootResourceHolders

public java.util.Set<RestResourceRegistry.ResourceHolder> getRootResourceHolders()

Gets the set of resource holder for the root resources, i.e. those with no parents.

Returns:

set of root resource holder.

addRootResourceHolder

protected void addRootResourceHolder(java.lang.String pResourceId)

Sets a resource holder as a root, i.e. this resource has no parents

Parameters:

pResourceId - id of resource to make a root

getOrCreateResourceSettings

public RestResourceRegistry.ResourceSettings getOrCreateResourceSettings(java.lang.String pResourceId,
                                                                         java.lang.Class<?> pResourceClass)

Get a resource settings by id or create a new entry if needed. This method will also create an encapsulating resource holder if needed.

Parameters:

pResourceId - resource id

Returns:

resource settings

useFullPaths

public boolean useFullPaths()

Getter for the boolean property which is true if full paths should be used rather than absolute paths.

Returns:

true if full paths should be used

setFullPaths

public void setFullPaths(boolean pFullPaths)

Setter for the boolean property which is true if full paths should be used rather than absolute paths.

Parameters:

pFullPaths - true if full paths should be used

getJAXRSApplicationRegistry

public JAXRSApplicationRegistry getJAXRSApplicationRegistry()

Reference to the jaxrs application registry. The JAXRSApplication for this rest resource registry should register with this registry.

Returns:

JAXRSApplicationRegistry to register with

setJAXRSApplicationRegistry

public void setJAXRSApplicationRegistry(JAXRSApplicationRegistry pJAXRSApplicationRegistry)

Reference to the jaxrs application registry. The JAXRSApplication for this rest resource registry should register with this registry.

Parameters:

pJAXRSApplicationRegistry - JAXRSApplicationRegistry to register with

getRestContextClass

public java.lang.Class<? extends RestContext> getRestContextClass()

Class to instantiate to hold the rest context for a request. Defaults to and must extend from the RestContext class.

Returns:

RestContext class or subclass.

setRestContextClass

public void setRestContextClass(java.lang.Class<? extends RestContext> pRestContextClass)

Class to instantiate to hold the rest context for a request. Must extend from the RestContext class.

Parameters:

pRestContextClass - RestContext class or subclass to use.

getLinkUtils

public LinkUtils getLinkUtils()

Reference to a link utils component. LinkUtils provides utility methods for managing links and resource references.

Returns:

LinkUtils to use

setLinkUtils

public void setLinkUtils(LinkUtils pLinkUtils)

Reference to a LinkUtils component. LinkUtils provides utility methods for managing links and resource references.

Parameters:

pLinkUtils - LinkUtils to use

getRestUtils

public RestUtils getRestUtils()

Reference to a RestUtils component. RestUtils provides utility methods for endpoint developers.

Returns:

RestUtils to use

setRestUtils

public void setRestUtils(RestUtils pRestUtils)

Reference to a RestUtils component. RestUtils provides utility methods for endpoint developers.

Parameters:

pRestUtils - RestUtils to use

getWarnForWrongContext

public boolean getWarnForWrongContext()

Flag, true if this registry should output a warning log if public methods are accessed and this registry context root does not match the current rest context registry context root.

Returns:

true if this registry should output a warning log for incorrect context root. Defaults to true.

setWarnForWrongContext

public void setWarnForWrongContext(boolean pWarnForWrongContext)

Flag, true if this registry should output a warning log if public methods are accessed and this registry context root does not match the current rest context registry context root.

Parameters:

pWarnForWrongContext - true if this registry should output a warning log for incorrect context root.

setProviderClassNames

public void setProviderClassNames(java.lang.String[] pProviderClassNames)

Set the provider class names. These are providers that cannot be nucleus components usually because they utilize a JAXRS injected piece of context that is only available to per-request providers.

Parameters:

pProviderClassNames - the provider class names

getProviderClassNames

public java.lang.String[] getProviderClassNames()

Get the provider class names. These are providers that cannot be nucleus components usually because they utilize a JAXRS injected piece of context that is only available to per-request providers.

Returns:

the provider class names

getProviderClasses

protected java.lang.Class<?>[] getProviderClasses()

Get the provider classes. These are providers that cannot be nucleus components usually because they utilize a JAXRS injected piece of context that is only available to per-request providers. Note, this resolves and returns the actual Class objects and not the string class names. It needs to resolve here rather than let nucleus do it due to Jersey class loader issues.

Returns:

the provider classes.

getNucleusProviders

public java.lang.Object[] getNucleusProviders()

Get an array of configured provider nucleus component instances, e.g. filters, interceptors etc.

Returns:

the provider instances to be made available.

setNucleusProviders

public void setNucleusProviders(java.lang.Object[] pNucleusProviders)

Set an array of configured provider component instances, e.g. filters, interceptors etc.

Parameters:

pNucleusProviders - the provider instances to be made available.

setRestResourceClasses

public void setRestResourceClasses(java.lang.Class<?>[] pRestResourceClasses)

Set the classes for rest resources that cannot be nucleus components, usually because they want their scope to be managed by the jaxrs provider instead.

Parameters:

pRestResourceClasses - the array of rest resource classes.

getRestResourceClasses

public java.lang.Class<?>[] getRestResourceClasses()

Get the classes for rest resources that cannot be nucleus components, usually because they want their scope to be managed by the jaxrs provider instead.

Returns:

the array of rest resource classes.

setNucleusRestResources

public void setNucleusRestResources(java.lang.String[] pNucleusRestResources)

Set the component paths for the nucleus rest resources. This includes all nucleus rest resources, global and non-global.

Parameters:

pNucleusRestResources - the array of nucleus paths.

getNucleusRestResources

public java.lang.String[] getNucleusRestResources()

Get the component paths for the nucleus rest resources. This includes all nucleus rest resources, global and non-global.

Returns:

array of string nucleus component paths

setMaxWildcards

public void setMaxWildcards(int pMaxWildcards)

Set MaxWildcards property. The maximum number of wildcards that appear in the endpoint urls. Used to limit the number of permutations of a url when matching using query parameter placeholders.

Parameters:

pMaxWildcards - the MaxWildcards property

getMaxWildcards

public int getMaxWildcards()

Returns MaxWildcards. The maximum number of wildcards that appear in the endpoint urls. Used to limit the number of permutations of a url when matching using query parameter placeholders.

Returns:

the MaxWildcards property

setAddJsonDocSkeletons

public void setAddJsonDocSkeletons(boolean pAddJsonDocSkeletons)

Sets property addJsonDocSkeletons. Whether to add json doc skeletons, if we are validating against our json doc.

Parameters:

pAddJsonDocSkeletons - Whether to add JSON Doc Skeletons

isAddJsonDocSkeletons

public boolean isAddJsonDocSkeletons()

Returns property addJsonDocSkeletons. Whether to add json doc skeletons, if we are validating against our json doc.

Returns:

Whether to add JSON Doc Skeletons.

getClassToResourceMap

protected java.util.Map<java.lang.Class<?>,java.util.Map<java.lang.String,java.lang.Object>> getClassToResourceMap()

Returns the implementation class to corresponding json.

Returns:

The implementation class to corresponding json.

getRestLockService

public atg.service.jaxrs.RestLockService getRestLockService()

Returns the restLockService property.

Returns:

The restLockService property.

setRestLockService

public void setRestLockService(atg.service.jaxrs.RestLockService pRestLockService)

Returns the restLockService property.

Parameters:

pRestLockService - The restLockService property.

getRepresentationCache

public atg.service.jaxrs.cache.RepresentationCache getRepresentationCache()

Returns the representationCache property. The cache component for this registry

Returns:

The representationCache property.

setRepresentationCache

public void setRepresentationCache(atg.service.jaxrs.cache.RepresentationCache pRepresentationCache)

Returns the representationcache property. The cache component for this registry

Parameters:

pRepresentationCache - The restLockService property.

setAuthRequiredAccessTypes

public void setAuthRequiredAccessTypes(java.lang.String[] pAuthRequiredAccessTypes)

set AuthRequiredAccessTypes.

Parameters:

pAuthRequiredAccessTypes - the AuthRequiredAccessTypes

getAuthRequiredAccessTypes

public java.lang.String[] getAuthRequiredAccessTypes()

get AuthRequiredAccessTypes.

Returns:

the AuthRequiredAccessTypes

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

set TransactionManager.

Parameters:

pTransactionManager - the TransactionManager

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Get TransactionManager.

Returns:

the TransactionManager

setContextRoot

public void setContextRoot(java.lang.String pContextRoot)

Set ContextRoot.

Parameters:

pContextRoot - the ContextRoot

getContextRoot

public java.lang.String getContextRoot()

Get ContextRoot.

Returns:

the ContextRoot

getVersion

public java.lang.String getVersion()

Method to try and parse the version from the context root. If the context root is null or the context root has only one path segment (e.g. /public) then this method returns null.

Returns:

the version string from the context root

isActive

public boolean isActive()

Returns true if the api version represented by this registry has not been deprecated and is actively supported.

Returns:

true if supported else false if deprecated

setActive

public void setActive(boolean pActive)

Set to true if the api version represented by this registry has not been deprecated and is actively supported.

Parameters:

pActive - true if supported else false if deprecated

getTerminationDate

public java.lang.String getTerminationDate()

Returns a string describing when the api version represented by this registry will not become deprecated and will not be actively supported.

Returns:

string describing when this api version is not actively supported

setTerminationDate

public void setTerminationDate(java.lang.String pTerminationDate)

Sets a string describing when the api version represented by this registry will not become deprecated and will not be actively supported.

Parameters:

pTerminationDate - string describing when this api version is not actively supported

setResourceMap

protected void setResourceMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> pResourceMap)

Set ResourceMap.

Parameters:

pResourceMap - the ResourceMap

getResourceMap

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> getResourceMap()

Get ResourceMap.

Returns:

the ResourceMap

setEnableCrossDomainRequests

public void setEnableCrossDomainRequests(boolean pEnableCrossDomainRequests)

Set EnableCrossDomainRequests.

Parameters:

pEnableCrossDomainRequests - the EnableCrossDomainRequests

isEnableCrossDomainRequests

public boolean isEnableCrossDomainRequests()

Get EnableCrossDomainRequests.

Returns:

the EnableCrossDomainRequests

setPublicOnlyEndpoints

public void setPublicOnlyEndpoints(boolean pPublicOnlyEndpoints)

Set PublicOnlyEndpoints.

Parameters:

pPublicOnlyEndpoints - the PublicOnlyEndpoints

isPublicOnlyEndpoints

public boolean isPublicOnlyEndpoints()

Get PublicOnlyEndpoints.

Returns:

the PublicOnlyEndpoints

setRelationsRegistry

public void setRelationsRegistry(RelationsRegistry pRelationsRegistry)

Set RelationsRegistry.

Parameters:

pRelationsRegistry - the RelationsRegistry

getRelationsRegistry

public RelationsRegistry getRelationsRegistry()

Get RelationsRegistry.

Returns:

the RelationsRegistry

setResourceLookupService

public void setResourceLookupService(atg.service.jaxrs.ResourceLookupService pResourceLookupService)

Set ResourceLookupService.

Parameters:

pResourceLookupService - the ResourceLookupService

getResourceLookupService

public atg.service.jaxrs.ResourceLookupService getResourceLookupService()

Get ResourceLookupService.

Returns:

the ResourceLookupService

getValidationService

public atg.service.jaxrs.ValidationService getValidationService()

Returns:

the validationService

setValidationService

public void setValidationService(atg.service.jaxrs.ValidationService pValidationService)

Parameters:

pValidationService - the validationService to set

getPublicEndpointsMap

protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> getPublicEndpointsMap()

Get the public endpoints keyed by class/method key. See createKey(Class,Method)

Returns:

The map containing the public endpoints.

getEndpointsMap

protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> getEndpointsMap()

Get all of the endpoints keyed by class/method key. See createKey(Class,Method)

Returns:

The map containing all endpoints.

getEndpointsByIdMap

protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> getEndpointsByIdMap()

Get all the endpoints keyed by endpoint id.

Returns:

The map containing all endpoints keyed by endpoint id.

getEndpointsByPathMap

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings>> getEndpointsByPathMap()

Get all the endpoints keyed and sorted by template path. The value of the map is a child map of the endpoint settings keyed by http method. Note: An endpoint can have more than one path to it and so this map can contain multiple entries for the same endpoint.

Returns:

The map containing all endpoints keyed by template path. The values of the map are a child map of http method to endpoint settings.

getKnownLinkRelations

protected java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> getKnownLinkRelations()

Returns a map of known link relations keyed by relation with value of endpoint settings. Used to track link relations and detect duplicates. Especially where a default link relations is generated from the endpoint method name.

Returns:

the known link relations

doStartService

public void doStartService()
                    throws ServiceException

Executes when the service starts up. The service scans for endpoints and places them in the registry maps.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up

See Also:

doScanEndpoints()

createRestContext

public RestContext createRestContext()

Instantiates a new RestContext for a request. The class that gets instantiated

Returns:

The RestContext instance to use for this request

scanEndpoints

protected void scanEndpoints()

Builds up a number of maps containing endpoint information. It does this by scanning the registered endpoint classes for annotations. Wrap scanEndpoints() in a transaction.

See Also:

doScanEndpoints()

doScanEndpoints

protected void doScanEndpoints()

Builds up a number of maps containing endpoint information. It does this by scanning the registered endpoint classes for annotations

processRestResourceClass

protected RestResourceRegistry.ResourceSettings processRestResourceClass(java.lang.Class pClass,
                                                                         java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> pTempPublicEndpointsMap,
                                                                         java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> pTempEndpointsMap,
                                                                         java.util.Map<java.lang.String,RestResourceRegistry.EndpointSettings> pTempEndpointsByIdMap)
                                                                  throws RestException

Processes each rest resource class to extract endpoint information from them. It's principal function is to create a RestResourceRegistry.ResourceSettings object that describes the endpoint and adds this to the appropriate endpoint maps that the registry holds.

Parameters:

pClass - The class being processed.

pTempPublicEndpointsMap - The map that public endpoints will be added to.

pTempEndpointsMap - The map that all endpoints will be added to keyed by class/method key.

pTempEndpointsByIdMap - The map that all endpoints will be added to keyed by endpoint id.

Throws:

RestException - Should a processing error happen.

See Also:

for information on how the endpoint setting are created.

buildTemplates

protected void buildTemplates(RestResourceRegistry.ResourceHolder pResourceHolder)
                       throws RestException

Build all the endpoint uri templates for the given resource info.

Parameters:

pResourceHolder - resource info for whose endpoints we will build templates

Throws:

RestException

buildResourcePaths

public java.util.Set<java.lang.String> buildResourcePaths(RestResourceRegistry.ResourceHolder pResourceHolder)
                                                   throws RestException

Throws:

RestException

recursePaths

protected java.util.Set<java.lang.String> recursePaths(RestResourceRegistry.ResourceHolder pResource,
                                                       java.util.Set<java.lang.String> pPaths)
                                                throws RestException

Throws:

RestException

createEndpointSettings

protected RestResourceRegistry.EndpointSettings createEndpointSettings(RestResourceRegistry.ResourceSettings pResourceSettings,
                                                                       java.lang.reflect.Method pMethod,
                                                                       java.lang.String pHttpMethod)
                                                                throws RestException

Creates the endpoint settings for an endpoint method. If the method is not one of the supported http methods as defined in #checkForHttpMethod null will be returned. If it is one of the supported http methods the annotations on the method will be scanned and settings returned.

Parameters:

pResourceSettings - The resource settings for the resource this endpoint belongs to

pMethod - The method with the Endpoint annotation to process.

pHttpMethod - The http method of the endpoint, e.g. GET

Returns:

The endpoint settings, otherwise null.

Throws:

RestException

checkForPreMatchMethod

protected java.lang.reflect.Method checkForPreMatchMethod(java.lang.reflect.Method pEndpointMethod,
                                                          java.lang.Class<?> pResourceClass)

Checks for any pre action methods for the endpoint method passed in. A pre action method will be annotated with @PreAction with the value of the annotation being the endpoint method name.

Parameters:

pEndpointMethod - the endpoint method

pResourceClass - the resource class

Returns:

any matching pre action method

checkForPostMatchMethod

protected java.lang.reflect.Method checkForPostMatchMethod(java.lang.reflect.Method pEndpointMethod,
                                                           java.lang.Class<?> pResourceClass)

Checks for any post action methods for the endpoint method passed in. A post action method will be annotated with @PostAction with the value of the annotation being the endpoint method name.

Parameters:

pEndpointMethod - the endpoint method

pResourceClass - the resource class

Returns:

any matching post action method

getSubresource

public java.lang.Object getSubresource(java.lang.String pSubresourceId)
                                throws RestException

Returns an object that can be returned from a subresource locator method for the given subresource id. This method will return the nucleus instance of the subresource if it is global scoped, otherwise the subresource class will be returned. Note, if multiple classes/components make up the resource then this method will only return a reference to the first. If a reference is required to one of the other classes/components then the getSubresourceByEndpointId(String) method should be used.

Parameters:

pSubresourceId - The id of the subresource to be returned from the locator method

Returns:

an object that can be returned from a locator method

Throws:

RestException - for problems obtaining the subresource object or if the id is not a valid subresource id

getSubresourceByEndpointId

public java.lang.Object getSubresourceByEndpointId(java.lang.String pEndpointId)
                                            throws RestException

Returns an object that can be returned from a subresource locator method for the given endpoint method id. This method will return the nucleus instance of the subresource if it is global scoped, otherwise the subresource class will be returned.

Parameters:

pEndpointId - the endpoint id whose resource reference will be returned

Returns:

a reference to the resource that contains the endpoint of the given endpoint id

Throws:

RestException - if the endpoint id is not valid or isn't within a subresource

buildResourceUriTemplatePath

public java.lang.String buildResourceUriTemplatePath(java.lang.String pContextPath,
                                                     java.lang.String pResourceId,
                                                     boolean pSingular,
                                                     java.lang.String... pPathParams)
                                              throws RestException

Constructs a template path for a resource. The resource is determined from the given resource id and the pSingular flag determines whether to return the collection or the singular resource uri. If the resource is a sub-resource then the returned uri will be relative to the given context path. If the resource is not a sub-resource then pContextPath can be null.

Parameters:

pContextPath - The uri for the current request context. Can be null if the target resource is not a sub-resource.

pResourceId - The id of the resource.

pSingular - true to return the singular uri for the given resource id

Returns:

the uri template for the given resource id.

Throws:

RestException - if the uri template could not be determined or the inputs were invalid.

hasAnnotation

protected boolean hasAnnotation(java.lang.Class<?> pClass,
                                java.lang.Class<? extends java.lang.annotation.Annotation> pAnnotation)

Determines whether a class contains an annotation.

Parameters:

pClass - The class to check.

pAnnotation - The annotation to check for.

Returns:

true if the annotation exists.

findAnnotatedClass

protected java.lang.Class findAnnotatedClass(java.lang.Class<?> pClass,
                                             java.lang.Class<? extends java.lang.annotation.Annotation> pAnnotation)

Scans the up the hierarchy of the class specified to find a class with the annotation specified. It uses Java inheritance rules to navigate up through the hierarchy, including interfaces implemented.

Parameters:

pClass - The class to start from.

pAnnotation - The annotation to find.

Returns:

The annotated class otherwise null.

getClassAnnotation

protected java.lang.annotation.Annotation getClassAnnotation(java.lang.Class<?> pClass,
                                                             java.lang.Class<? extends java.lang.annotation.Annotation> pAnnotationClass)

Searches the given class and its super classes/interfaces to find an annotation for the given annotation class.

Parameters:

pClass - Initial class to search through it and its super classes

pAnnotationClass - Annotation class to search for

Returns:

Annotation if found or null

findAnnotatedMethod

protected java.lang.reflect.Method findAnnotatedMethod(java.lang.reflect.Method pMethod,
                                                       java.lang.Class<? extends java.lang.annotation.Annotation> pAnnotation)

Scans the up the hierarchy of the class specified to find a method with the annotation specified. It uses Java inheritance rules to navigate up through the hierarchy.

Parameters:

pMethod - The method to search on.

pAnnotation - The annotation to search for.

Returns:

The method that has the annotation, otherwise null

getInheritance

protected static java.util.Set<java.lang.Class<?>> getInheritance(java.lang.Class<?> pClass)

Utility method to get the inherited classes and implemented interfaces of the specified class.

Parameters:

pClass - The class to start with.

Returns:

The classes being inherited from and interfaces being implemented.

hasJAXRSFieldAnnotation

protected boolean hasJAXRSFieldAnnotation(java.lang.Class pClass)

Determines if the class has an JAXRS specific annotation.

Parameters:

pClass - The class being inspected.

Returns:

true if there are annotations from the JAXRS package.

getMethodPath

protected java.lang.String getMethodPath(java.lang.reflect.Method pMethod)

Determines the uri path for an endpoint method by looking for a Path annotation.

Parameters:

pMethod - The method to determine the path for.

Returns:

The path to the method or an empty string if none found

getTopUrl

protected java.lang.String getTopUrl(java.lang.Class pClass)

Returned the URL as specified by the path annotation on the class.

Parameters:

pClass - The class to get the URL from.

Returns:

The URL from the path annotation. If no annotation on the class null will be returned.

createKey

public java.lang.String createKey(java.lang.Class pClass,
                                  java.lang.reflect.Method pMethod)

Generates a key that can be used to identify an endpoint.

Parameters:

pClass - The name of the class from which the endpoint comes.

pMethod - The method implementing the endpoint.

Returns:

A string that can be used as a key in the registry maps.

createKey

public java.lang.String createKey()

Returns the key to the rest resource in the current rest context.

Returns:

The resource key.

getEndpointSettings

public RestResourceRegistry.EndpointSettings getEndpointSettings()

Gets the current endpoint settings based on the current rest resource in the current rest context.

Returns:

The settings for the current endpoint, otherwise null.

getEndpointSettings

public RestResourceRegistry.EndpointSettings getEndpointSettings(java.lang.String pPath,
                                                                 java.lang.String pHttpMethod)

Gets the endpoint settings for a specific path and http method.

Parameters:

pPath - The endpoint path, e.g. /order/{orderId}

pHttpMethod - The endpoint http method, e.g. GET

Returns:

The settings for the specified endpoint, otherwise null.

checkForWrongContext

protected void checkForWrongContext()

Outputs a warning log message if this registry does not have a context root that matches the current rest context registry. Usually this indicates some piece of code has incorrectly resolved a global registry component through nucleus rather than using the registry stored in the current rest context. The rest context registry will be correct for the context and version for the current request. This warning message can be disabled for this registry by calling setWarnForWrongContext(boolean) with false.

checkForHttpMethod

protected java.lang.String checkForHttpMethod(java.lang.reflect.Method pMethod)

Check that the passed in method is annotated with a http method and returns the String equivalent.

Parameters:

pMethod - The endpoint method to check.

Returns:

String http method. Otherwise null if no annotation.

methodPathPlaceholderParams

protected java.lang.String methodPathPlaceholderParams(java.lang.String pPath)

Get a method path with any param levels turned into generic placeholders. It basically removes the params from the path. e.g. /{orderId}/commerceitems would change to /{}/commerceitems

Parameters:

pPath - The path.

Returns:

The path with the param stripped out.

getNumberOfWildcardsInPath

protected int getNumberOfWildcardsInPath(java.lang.String pPath)

Returns a count of the number of wildcards in the template path.

Parameters:

pPath - the template path

Returns:

the number of wildcards

checkForRequestResponseTypes

protected void checkForRequestResponseTypes(java.lang.reflect.Method pMethod,
                                            RestResourceRegistry.EndpointSettings pEndpoint)

Checks the method for request/response annotations and sets the passed in endpoint setting object appropriately.

Parameters:

pMethod - The endpoint method to check for annotations.

pEndpoint - The endpoint settings object to store the annotation information in.

createAdminServlet

protected javax.servlet.Servlet createAdminServlet()

Creates the admin servlet that can be used to display information about the RestResource registry in dyn/admin.

Overrides:

createAdminServlet in class GenericService

Returns:

The admin servlet

See Also:

RestResourceRegistry.RestResourceRegistryAdminServlet

getResource

protected static java.lang.String getResource(java.lang.String pResourceKey)

Returns a user message from the resource bundle based on the user's locale.

Parameters:

pResourceKey - The key of the resource to look in the bundle for.

Returns:

The localized resource.

See Also:

ResourceUtils

getResource

protected static java.lang.String getResource(java.lang.String pResourceKey,
                                              java.lang.Object... pArgs)

Returns a user message from the resource bundle based on the user's locale.

Parameters:

pResourceKey - The key of the resource to look in the bundle for.

pArgs - The arguments to use in the formatted user message.

Returns:

The localized resource.

See Also:

ResourceUtils

atgJsonToOrgJson

protected java.lang.Object atgJsonToOrgJson(java.lang.Object pObject)

Convert from atgJson to standard JSON.

Parameters:

pObject - The object containing atg JSON.

Returns:

The standard JSON (org.json.JSONObject or org.json.JSONArray)

getGlobalNucleusRestResourceComponents

protected java.util.Map<java.lang.String,java.lang.Object> getGlobalNucleusRestResourceComponents()

Returns references to any global nucleus rest resource components. First retrieves the nucleus rest resource paths and obtains their configuration to check scope.

Returns:

map of global nucleus rest resource components for this registry keyed by nucleus path

getNonGlobalNucleusRestResourceClasses

protected java.lang.Class<?>[] getNonGlobalNucleusRestResourceClasses()

Returns the classes for any configured non global nucleus rest resources. First retrieves the nucleus rest resource paths and obtains their configuration to check scope and obtain the class.

Returns:

array of classes for the non global nucleus rest resources in this registry

getNucleusRestResourceClasses

protected java.util.Map<java.lang.String,java.lang.Class<?>> getNucleusRestResourceClasses()

Gets a map of all nucleus rest resource classes in the registry keyed by component path. These will be scanned on start up.

Returns:

map of all nucleus rest resource classes keyed by nucleus component path.

getAllResourceClasses

public java.util.Set<java.lang.Class<?>> getAllResourceClasses()

Gets a set of all the resource classes in the registry.

Returns:

set of all registered resource classes.