atg.rest

Class RestConfiguration

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.rest.RestConfiguration

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 RestConfiguration
extends GenericService

A class to hold configuration properties for REST web services.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

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
RestConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
ComponentResolver	getDefaultComponentResolver() Returns the default ComponentResolver
RestInputCustomizer	getDefaultInputCustomizer() Returns the default rest input customizer
RestOutputCustomizer	getDefaultOutputCustomizer() Returns the default rest output customizer
FilteringManager	getFilteringManager()
ServiceMap	getInputCustomizers() Returns a Map of all input customizers
int	getMaxDepthAllowed() Property which defines what the maximum allowable value for the depth is.
ServiceMap	getOutputCustomizers() Returns a map of all output customizers
static RestConfiguration	getRestConfiguration() Return an instance of this class
RestSecurityManager	getRestSecurityManager() Returns the RestSecurityManager
javax.transaction.TransactionManager	getTransactionManager()
void	setDefaultComponentResolver(ComponentResolver pDefaultComponentResolver) Sets the default ComponentResolver
void	setDefaultInputCustomizer(RestInputCustomizer pDefaultInputCustomizer) Sets the default input customizer
void	setDefaultOutputCustomizer(RestOutputCustomizer pDefaultOutputCustomizer) Set the default rest output customizer.
void	setFilteringManager(FilteringManager pFilteringManager)
void	setInputCustomizers(ServiceMap pInputCustomizers) Sets the Map of input customizers
void	setMaxDepthAllowed(int pMaxDepthAllowed)
void	setOutputCustomizers(ServiceMap pOutputCustomizers) Sets the map of outputCustomizers
void	setRestSecurityManager(RestSecurityManager pRestSecurityManager) Sets the RestSecurityManager
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, 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

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

RestConfiguration

public RestConfiguration()

Method Detail

getRestConfiguration

public static RestConfiguration getRestConfiguration()

Return an instance of this class

Returns:

an instance of this class

getDefaultOutputCustomizer

public RestOutputCustomizer getDefaultOutputCustomizer()

Returns the default rest output customizer

Returns:

returns the default rest output customizer

setDefaultOutputCustomizer

public void setDefaultOutputCustomizer(RestOutputCustomizer pDefaultOutputCustomizer)

Set the default rest output customizer.

Parameters:

pDefaultOutputCustomizer - the default output customizer to set

getOutputCustomizers

public ServiceMap getOutputCustomizers()

Returns a map of all output customizers

Returns:

a map of all outputCustomizers

setOutputCustomizers

public void setOutputCustomizers(ServiceMap pOutputCustomizers)

Sets the map of outputCustomizers

Parameters:

pOutputCustomizers - the outputCustomizers to set

getDefaultInputCustomizer

public RestInputCustomizer getDefaultInputCustomizer()

Returns the default rest input customizer

Returns:

the default rest input customizer

setDefaultInputCustomizer

public void setDefaultInputCustomizer(RestInputCustomizer pDefaultInputCustomizer)

Sets the default input customizer

Parameters:

pDefaultInputCustomizer - the defaultInputCustomizer to set

getInputCustomizers

public ServiceMap getInputCustomizers()

Returns a Map of all input customizers

Returns:

a Map of all input customizers

setInputCustomizers

public void setInputCustomizers(ServiceMap pInputCustomizers)

Sets the Map of input customizers

Parameters:

pInputCustomizers - the inputCustomizers to set

getDefaultComponentResolver

public ComponentResolver getDefaultComponentResolver()

Returns the default ComponentResolver

Returns:

returns the default ComponentResolver

setDefaultComponentResolver

public void setDefaultComponentResolver(ComponentResolver pDefaultComponentResolver)

Sets the default ComponentResolver

Parameters:

pDefaultComponentResolver - the defaultComponentResolver to set

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Returns:

a reference to the transactionManager

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Parameters:

pTransactionManager - sets the transactionManager

getFilteringManager

public FilteringManager getFilteringManager()

Returns:

a reference to the filteringManager

setFilteringManager

public void setFilteringManager(FilteringManager pFilteringManager)

Parameters:

pFilteringManager - sets the filteringManager

getMaxDepthAllowed

public int getMaxDepthAllowed()

Property which defines what the maximum allowable value for the depth is. Any value less than 0 means no maximum.

Returns:

the maxDepthAllowed property

setMaxDepthAllowed

public void setMaxDepthAllowed(int pMaxDepthAllowed)

Parameters:

pMaxDepthAllowed - the value of maxDepthAllowed to set

getRestSecurityManager

public RestSecurityManager getRestSecurityManager()

Returns the RestSecurityManager

Returns:

returns the RestSecurityManager

setRestSecurityManager

public void setRestSecurityManager(RestSecurityManager pRestSecurityManager)

Sets the RestSecurityManager

Parameters:

pRestSecurityManager - the RestSecurityManager to set