atg.service.jaxrs

Class JAXRSApplication

java.lang.Object

Application

atg.service.jaxrs.JAXRSApplication

public class JAXRSApplication
extends Application

The main jersey configuration class. Resolves a nucleus atg.jaxrs.ApplicationService to provide the actual configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_CONTEXT_ATTRIBUTE Constant key used to save application instance in ServletContext
static java.lang.String	CLASS_VERSION Class version string
protected Client	mInternalClient Reference to internal client.
protected atg.service.payloadschema.PayloadSchemaRegistry	mPayloadSchemaRegistry property: paylaodSchemaRegistry
protected JAXRSApplication	mPredecessorApplication property: predecessorApplication - Reference to the jaxrs application that precedes this one by version
protected RestResourceRegistry	mRestResourceRegistry property: restResourceRegistry
protected ServiceLocator	mServiceLocator Reference to the service locator.
protected JAXRSApplication	mSuccessorApplication property: successorApplication - Reference to the jaxrs application that succeeds this one by version
protected static java.lang.String	PAYLOAD_SCHEMA_REGISTRY_PATH_PARAM Constant for init-param path of PayloadSchemaRegistry
protected static java.lang.String	RESOURCE_REGISTRY_PATH_PARAM Constant for init-param path of RestResourceRegistry

Constructor Summary

Constructors

Constructor and Description
JAXRSApplication(javax.servlet.ServletConfig pServletConfig) Constructs an instanceof JAXRSApplication Resolves the correct registries and stores a reference to this instance in the servlet context for use downstream.

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.Class<?>>	getClasses() Get the endpoint classes.
java.lang.String	getContextRoot() Get the context root from our Rest Resource Registry
Client	getInternalClient() Get the internal client.
atg.service.payloadschema.PayloadSchemaRegistry	getPayloadSchemaRegistry() Gets the payload schema registry that is in context for this jersey servlet application instance.
JAXRSApplication	getPredecessorApplication() Getter for the jaxrs application that precedes this one by version.
RestResourceRegistry	getRestResourceRegistry() Gets the rest resource registry that is in context for this jersey servlet application instance.
ServiceLocator	getServiceLocator() Gets back a service locator we can use to find different internal jersey services.
java.util.Set<java.lang.Object>	getSingletons() Get any configured provider instances, e.g.
JAXRSApplication	getSuccessorApplication() Getter for the jaxrs application that succeeds this one by version.
protected void	initialize(javax.servlet.ServletConfig pServletConfig)
boolean	isLatest() Utility method to determine if this jaxrs application represents the latest version of the api.
protected void	setPayloadSchemaRegistry(atg.service.payloadschema.PayloadSchemaRegistry pPayloadSchemaRegistry) Sets the payload schema registry that is in context for this jersey servlet application instance.
void	setPredecessorApplication(JAXRSApplication pPredecessorApplication) Setter for the jaxrs application that precedes this one by version
protected void	setRestResourceRegistry(RestResourceRegistry pRestResourceRegistry) Sets the rest resource registry that is in context for this jersey servlet application instance.
void	setSuccessorApplication(JAXRSApplication pSuccessorApplication) Setter for the jaxrs application that succeeds this one by version

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

RESOURCE_REGISTRY_PATH_PARAM

protected static final java.lang.String RESOURCE_REGISTRY_PATH_PARAM

Constant for init-param path of RestResourceRegistry

See Also:

Constant Field Values

PAYLOAD_SCHEMA_REGISTRY_PATH_PARAM

protected static final java.lang.String PAYLOAD_SCHEMA_REGISTRY_PATH_PARAM

Constant for init-param path of PayloadSchemaRegistry

See Also:

Constant Field Values

APPLICATION_CONTEXT_ATTRIBUTE

public static final java.lang.String APPLICATION_CONTEXT_ATTRIBUTE

Constant key used to save application instance in ServletContext

See Also:

Constant Field Values

mServiceLocator

protected ServiceLocator mServiceLocator

Reference to the service locator.

mInternalClient

protected Client mInternalClient

Reference to internal client.

mPredecessorApplication

protected JAXRSApplication mPredecessorApplication

property: predecessorApplication - Reference to the jaxrs application that precedes this one by version

mSuccessorApplication

protected JAXRSApplication mSuccessorApplication

property: successorApplication - Reference to the jaxrs application that succeeds this one by version

mRestResourceRegistry

protected RestResourceRegistry mRestResourceRegistry

property: restResourceRegistry

mPayloadSchemaRegistry

protected atg.service.payloadschema.PayloadSchemaRegistry mPayloadSchemaRegistry

property: paylaodSchemaRegistry

Constructor Detail

JAXRSApplication

public JAXRSApplication(javax.servlet.ServletConfig pServletConfig)

Constructs an instanceof JAXRSApplication Resolves the correct registries and stores a reference to this instance in the servlet context for use downstream.

Parameters:

pServletConfig - the servlet config to provide our web.xml init param registry path.

Method Detail

getPredecessorApplication

public JAXRSApplication getPredecessorApplication()

Getter for the jaxrs application that precedes this one by version.

Returns:

predecessor application or null if this is the first version.

setPredecessorApplication

public void setPredecessorApplication(JAXRSApplication pPredecessorApplication)

Setter for the jaxrs application that precedes this one by version

Parameters:

pPredecessorApplication - predecessor application

getSuccessorApplication

public JAXRSApplication getSuccessorApplication()

Getter for the jaxrs application that succeeds this one by version.

Returns:

successor application or null if this is the latest (current) version.

setSuccessorApplication

public void setSuccessorApplication(JAXRSApplication pSuccessorApplication)

Setter for the jaxrs application that succeeds this one by version

Parameters:

pSuccessorApplication - successor application

isLatest

public boolean isLatest()

Utility method to determine if this jaxrs application represents the latest version of the api.

Returns:

true if this is the latest version

setRestResourceRegistry

protected void setRestResourceRegistry(RestResourceRegistry pRestResourceRegistry)

Sets the rest resource registry that is in context for this jersey servlet application instance. There is a registry per context/version, e.g. /public/v1 or /agent/v2 etc.

Parameters:

pRestResourceRegistry - the rest resource registry currently in context

getRestResourceRegistry

public RestResourceRegistry getRestResourceRegistry()

Gets the rest resource registry that is in context for this jersey servlet application instance. There is a registry per context/version, e.g. /public/v1 or /agent/v2 etc.

Returns:

the rest resource registry that is in context

setPayloadSchemaRegistry

protected void setPayloadSchemaRegistry(atg.service.payloadschema.PayloadSchemaRegistry pPayloadSchemaRegistry)

Sets the payload schema registry that is in context for this jersey servlet application instance. There may be a registry per context/version, e.g. /public/v1 or /agent/v2 etc.

Parameters:

pPayloadSchemaRegistry - the payload schema registry currently in context

getPayloadSchemaRegistry

public atg.service.payloadschema.PayloadSchemaRegistry getPayloadSchemaRegistry()

Gets the payload schema registry that is in context for this jersey servlet application instance. There may be a registry per context/version, e.g. /public/v1 or /agent/v2 etc.

Returns:

the payload schema registry that is in context

initialize

protected void initialize(javax.servlet.ServletConfig pServletConfig)

getClasses

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

Get the endpoint classes. Uses the rest resource registry to get the list of classes.

Returns:

the resource classes

getSingletons

public java.util.Set<java.lang.Object> getSingletons()

Get any configured provider instances, e.g. filters, interceptors etc.

Returns:

the provider instances to be used by Jersey

getServiceLocator

public ServiceLocator getServiceLocator()

Gets back a service locator we can use to find different internal jersey services.

Returns:

the service locator for this application

getInternalClient

public Client getInternalClient()

Get the internal client. The internal client is intended to be used for internal calls for embedded resources.

Returns:

the internal client

getContextRoot

public java.lang.String getContextRoot()

Get the context root from our Rest Resource Registry

Returns:

the context root