RestResourceRegistry.EndpointSettings (ATG Java API)

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

Enclosing class:

RestResourceRegistry
```
public static class RestResourceRegistry.EndpointSettings
extends java.lang.Object
```
A container for storing the settings of an endpoint method. These objects are generated during the scanning process for endpoints.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<java.lang.String,java.lang.String>`	`mAccessControllerId` The map of url path to access control id on the endpoint.
`protected boolean`	`mAuthRequired` Whether access to the endpoint requires the user to be authenticated.
`protected boolean`	`mCachingEnabled` Whether caching is enabled on the endpoint.
`protected boolean`	`mChangeTrackingDisabled` Whether the endpoint has change tracking disabled.
`protected java.util.Set<java.lang.String>`	`mConsumes` Set of media types this endpoint consumes
`protected int`	`mFilterDepth` The filter depth, -1 indicates to limit.
`protected java.lang.String`	`mFilterId` The id of the filter used with the endpoint.
`protected boolean`	`mHasDoc` Not currently used.
`protected boolean`	`mHasJAXRSAnnotatedFields` Whether the endpoint has JAXRS annotations.
`protected boolean`	`mHasPathParams` Whether the URL of the endpoint has params.
`protected java.lang.String`	`mHttpMethod` The http method of the endpoint.
`protected boolean`	`mHttpsRequired` Whether access to the endpoint requires https.
`protected java.lang.String`	`mId` The id of the the endpoint.
`protected java.lang.String`	`mLinkRelation` The link relation for the endpoint.
`protected java.lang.String`	`mLocaleHint` The locale hint of the the endpoint.
`protected atg.service.jaxrs.RestLockService.LockType`	`mLockType` Requires lock read or write?
`protected java.lang.reflect.Method`	`mMethodObject` The actual endpoint method in the endpoint class.
`protected java.lang.String`	`mPath` The path for the endpoint as returned via `RestResourceRegistry.getMethodPath(Method)`.
`protected java.lang.String`	`mPostActionMethod` Method name of a post action to be called after the endpoint is invoked.
`protected java.lang.String`	`mPreActionMethod` Method name of a pre action to be called before the endpoint is invoked.
`protected boolean`	`mPrivate` Whether the endpoint is private.
`protected java.util.Set<java.lang.String>`	`mProduces` Set of media types this endpoint produces
`protected java.lang.String`	`mRequestType` The content type the endpoint consumes.
`protected RestResourceRegistry.ResourceSettings`	`mResourceSettings` Resource settings that this endpoint belongs to.
`protected java.lang.String`	`mResourceURL` The URL of the resource that the endpoint is part of.
`protected java.lang.String`	`mResponseType` The content type the endpoint produces.
`protected boolean`	`mSingular` Whether the endpoint resource type is singular.
`protected java.util.Map<java.lang.String,java.lang.String>`	`mTemplatePaths` The map of all absolute template paths that lead to this endpoint, e.g.
`protected boolean`	`mTransactional` Whether the endpoint is transactional.
`protected boolean`	`mUpdateTarget` Whether the endpoint creates and/or updates a target bean/repository item during input validation
`protected java.lang.String`	`mUrl`
`protected boolean`	`mValidatedByFramework` Whether validation of endpoint input is validated by the framework
`protected java.lang.String`	`mValidatorId` The id of the validator used with the endpoint.

Constructor Summary

Constructors
Constructor and Description

EndpointSettings(RestResourceRegistry.ResourceSettings pResourceSettings, java.lang.String pId)
Constructor.

Constructors
Constructor and Description
`EndpointSettings(RestResourceRegistry.ResourceSettings pResourceSettings, java.lang.String pId)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAccessControllerId(java.lang.String pKey, java.lang.String pAccessControllerId)` Adds a map of url path to access controller id on the endpoint.
`java.util.Map<java.lang.String,java.lang.String>`	`getAccessControllerId()` Gets the map of access controller ids for the endpoint.
`boolean`	`getCachingEnabled()` Gets whether caching is enabled on the endpoint.
`java.util.Set<java.lang.String>`	`getConsumes()` Getter for the media types this endpoint consumes.
`int`	`getFilterDepth()` Gets the filter depth, -1 indicates to limit.
`java.lang.String`	`getFilterId()` Gets the id of the filter used with the endpoint.
`java.lang.String`	`getHttpMethod()` Gets the http method of the endpoint.
`java.lang.String`	`getId()` Gets the id of the the endpoint.
`java.lang.String`	`getLinkRelation()` Gets the link relation for the endpoint.
`java.lang.String`	`getLocaleHint()` Gets the locale hint of the the endpoint.
`atg.service.jaxrs.RestLockService.LockType`	`getLockType()` Returns the Lock Type.
`java.lang.reflect.Method`	`getMethodObject()` Gets the actual endpoint method in the endpoint class.
`java.lang.String`	`getPath()` Gets the path for the endpoint.
`java.lang.String`	`getPostActionMethod()` Returns the name of the post action method for this endpoint.
`java.lang.String`	`getPreActionMethod()` Returns the name of the pre action method for this endpoint.
`java.util.Set<java.lang.String>`	`getProduces()` Getter for the media types this endpoint produces.
`java.lang.String`	`getRequestType()` Gets the content type the endpoint consumes.
`RestResourceRegistry.ResourceSettings`	`getResourceSettings()` Get the Resource settings that this endpoint belongs to.
`java.lang.String`	`getResourceURI()` Gets the URI of the resource that the endpoint is part of.
`java.lang.String`	`getResourceURL()` Gets the URL of the resource that the endpoint is part of.
`java.lang.String`	`getResponseType()` Gets the content type the endpoint produces.
`java.util.Map<java.lang.String,java.lang.String>`	`getTemplatePaths()`
`java.lang.String`	`getUrl()`
`java.lang.String`	`getValidatorId()` Gets the id of the validator used with the endpoint.
`boolean`	`isAuthRequired()` Gets whether access to the endpoint requires the user to be authenticated.
`boolean`	`isChangeTrackingDisabled()` Gets whether the endpoint has change tracking disabled
`boolean`	`isHasDoc()` Gets the 'has documentation' flag.
`boolean`	`isHasJAXRSAnnotatedFields()` Gets whether the endpoint has JAXRS annotations.
`boolean`	`isHasPathParams()` Gets whether the URL of the endpoint has params.
`boolean`	`isHttpsRequired()` Gets whether access to the endpoint requires https.
`boolean`	`isPrivate()` Gets whether the endpoint is private.
`boolean`	`isSingular()` Gets whether the endpoint resource type is singular.
`boolean`	`isTransactional()` Gets whether the endpoint is transactional.
`boolean`	`isUpdateTarget()` Gets whether the endpoint creates and/or updates a target bean/repository item during input validation
`boolean`	`isUseImportableResourceLock()` Gets whether the endpoint uses importable resource locking.
`boolean`	`isUseOptimisticLock()` Gets whether the endpoint uses optimistic locking.
`boolean`	`isValidatedByFramework()` Gets whether validation of endpoint input is validated by the framework
`void`	`setAuthRequired(boolean pAuthRequired)` Set whether access to the endpoint requires the user to be authenticated.
`protected void`	`setCachingEnabled(boolean pCachingEnabled)` Sets whether caching is enabled on the endpoint.
`protected void`	`setChangeTrackingDisabled(boolean pChangeTrackingDisabled)` Sets whether the endpoint has change tracking disabled
`protected void`	`setConsumes(java.util.Set<java.lang.String> pConsumes)` Setter for the media types this endpoint consumes.
`protected void`	`setFilterDepth(int pFilterDepth)` Sets the filter depth, -1 indicates to limit.
`protected void`	`setFilterId(java.lang.String pFilterId)` Sets the id of the filter used with the endpoint.
`void`	`setHasDoc(boolean pHasDoc)` Sets the 'has documentation' flag.
`protected void`	`setHasJAXRSAnnotatedFields(boolean pHasJAXRSAnnotatedFields)` Sets whether the endpoint has JAXRS annotations.
`protected void`	`setHasPathParams(boolean pHasPathParams)` Sets whether the URL of the endpoint has params.
`protected void`	`setHttpMethod(java.lang.String pHttpMethod)` Set the http method of the endpoint.
`void`	`setHttpsRequired(boolean pHttpsRequired)` Sets whether access to the endpoint requires https.
`protected void`	`setId(java.lang.String pId)` Set the id of the the endpoint.
`protected void`	`setLinkRelation(java.lang.String pLinkRelation)` Sets the link relation for the endpoint.
`void`	`setLocaleHint(java.lang.String pLocaleHint)` Set the locale hint of the the endpoint.
`protected void`	`setLockType(atg.service.jaxrs.RestLockService.LockType pLockType)` Sets the lock type.
`protected void`	`setMethodObject(java.lang.reflect.Method pMethodObject)` Sets the actual endpoint method in the endpoint class.
`protected void`	`setPath(java.lang.String pPath)` Sets the path for the endpoint.
`protected void`	`setPostActionMethod(java.lang.String pPostActionMethod)` Sets the name of the post action method for this endpoint.
`protected void`	`setPreActionMethod(java.lang.String pPreActionMethod)` Sets the name of the pre action method for this endpoint.
`protected void`	`setPrivate(boolean pPrivate)` Sets whether the endpoint is private.
`protected void`	`setProduces(java.util.Set<java.lang.String> pProduces)` Setter for the media types this endpoint produces.
`protected void`	`setRequestType(java.lang.String pRequestType)` Sets the content type the endpoint consumes.
`protected void`	`setResourceSettings(RestResourceRegistry.ResourceSettings pResourceSettings)` Set the Resource settings that this endpoint belongs to.
`void`	`setResourceURI(java.lang.String pResourceURI)` Sets the URL of the resource that the endpoint is part of.
`protected void`	`setResourceURL(java.lang.String pResourceURL)` Sets the URL of the resource that the endpoint is part of.
`protected void`	`setResponseType(java.lang.String pResponseType)` Sets the content type the endpoint produces.
`protected void`	`setSingular(boolean pSingular)` Sets whether the endpoint resource type is singular.
`protected void`	`setTemplatePaths(java.util.Map<java.lang.String,java.lang.String> pTemplatePaths)`
`protected void`	`setTransactional(boolean pTransactional)` Sets whether the endpoint is transactional.
`protected void`	`setUpdateTarget(boolean pUpdateTarget)` Sets whether the endpoint creates and/or updates a target bean/repository item during input validation
`void`	`setUrl(java.lang.String pUrl)`
`void`	`setUseImportableResourceLock(boolean pUseImportableResourceLock)` Sets whether the endpoint uses the importable resource lock.
`void`	`setUseOptimisticLock(boolean pUseOptimisticLock)` Sets whether the endpoint uses optimistic locking.
`protected void`	`setValidatedByFramework(boolean pValidatedByFramework)` Sets whether validation of endpoint input is validated by the framework
`protected void`	`setValidatorId(java.lang.String pValidatorId)` Sets the id of the validator used with the endpoint.
`java.lang.String`	`toString()`

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

- Field Detail
  - mId
```
protected java.lang.String mId
```
    The id of the the endpoint.
  - mResourceSettings
```
protected RestResourceRegistry.ResourceSettings mResourceSettings
```
    Resource settings that this endpoint belongs to.
  - mTemplatePaths
```
protected java.util.Map<java.lang.String,java.lang.String> mTemplatePaths
```
    The map of all absolute template paths that lead to this endpoint, e.g. '/cart/commerceItems/{itemId}' and '/orders/{orderId}/commerceItems/{itemId}' The map is keyed by the parent resource path, e.g. for the above cart and orders example the keys would be '/cart/commerceItems' and '/orders/{orderId}/commerceItems' respectively
  - mLockType
```
protected atg.service.jaxrs.RestLockService.LockType mLockType
```
    Requires lock read or write?
  - mTransactional
```
protected boolean mTransactional
```
    Whether the endpoint is transactional.
  - mPrivate
```
protected boolean mPrivate
```
    Whether the endpoint is private.
  - mFilterDepth
```
protected int mFilterDepth
```
    The filter depth, -1 indicates to limit.
  - mValidatorId
```
protected java.lang.String mValidatorId
```
    The id of the validator used with the endpoint.
  - mFilterId
```
protected java.lang.String mFilterId
```
    The id of the filter used with the endpoint.
  - mConsumes
```
protected java.util.Set<java.lang.String> mConsumes
```
    Set of media types this endpoint consumes
  - mProduces
```
protected java.util.Set<java.lang.String> mProduces
```
    Set of media types this endpoint produces
  - mLocaleHint
```
protected java.lang.String mLocaleHint
```
    The locale hint of the the endpoint.
  - mHasPathParams
```
protected boolean mHasPathParams
```
    Whether the URL of the endpoint has params.
  - mPath
```
protected java.lang.String mPath
```
    The path for the endpoint as returned via RestResourceRegistry.getMethodPath(Method). The path is relative to the containing resource and may be a template, e.g. {itemId}
  - mAuthRequired
```
protected boolean mAuthRequired
```
    Whether access to the endpoint requires the user to be authenticated.
  - mHttpsRequired
```
protected boolean mHttpsRequired
```
    Whether access to the endpoint requires https.
  - mHttpMethod
```
protected java.lang.String mHttpMethod
```
    The http method of the endpoint.
  - mSingular
```
protected boolean mSingular
```
    Whether the endpoint resource type is singular.
  - mMethodObject
```
protected java.lang.reflect.Method mMethodObject
```
    The actual endpoint method in the endpoint class.
  - mAccessControllerId
```
protected java.util.Map<java.lang.String,java.lang.String> mAccessControllerId
```
    The map of url path to access control id on the endpoint.
  - mHasDoc
```
protected boolean mHasDoc
```
    Not currently used. Has documentation.
  - mRequestType
```
protected java.lang.String mRequestType
```
    The content type the endpoint consumes.
  - mResponseType
```
protected java.lang.String mResponseType
```
    The content type the endpoint produces.
  - mCachingEnabled
```
protected boolean mCachingEnabled
```
    Whether caching is enabled on the endpoint.
  - mHasJAXRSAnnotatedFields
```
protected boolean mHasJAXRSAnnotatedFields
```
    Whether the endpoint has JAXRS annotations.
  - mLinkRelation
```
protected java.lang.String mLinkRelation
```
    The link relation for the endpoint.
  - mResourceURL
```
protected java.lang.String mResourceURL
```
    The URL of the resource that the endpoint is part of.
  - mChangeTrackingDisabled
```
protected boolean mChangeTrackingDisabled
```
    Whether the endpoint has change tracking disabled. Only relevant for PATCH updates
  - mUpdateTarget
```
protected boolean mUpdateTarget
```
    Whether the endpoint creates and/or updates a target bean/repository item during input validation
  - mValidatedByFramework
```
protected boolean mValidatedByFramework
```
    Whether validation of endpoint input is validated by the framework
  - mPreActionMethod
```
protected java.lang.String mPreActionMethod
```
    Method name of a pre action to be called before the endpoint is invoked.
  - mPostActionMethod
```
protected java.lang.String mPostActionMethod
```
    Method name of a post action to be called after the endpoint is invoked.
  - mUrl
```
protected java.lang.String mUrl
```
- Constructor Detail
  - EndpointSettings
```
public EndpointSettings(RestResourceRegistry.ResourceSettings pResourceSettings,
                        java.lang.String pId)
```
    Constructor.
- Method Detail
  - setId
```
protected void setId(java.lang.String pId)
```
    Set the id of the the endpoint.
    
    Parameters:
    
    pId - The id of the the endpoint.
  - getId
```
public java.lang.String getId()
```
    Gets the id of the the endpoint.
    
    Returns:
    
    The id of the the endpoint.
  - getResourceSettings
```
public RestResourceRegistry.ResourceSettings getResourceSettings()
```
    Get the Resource settings that this endpoint belongs to.
    
    Returns:
    
    The Resource settings that this endpoint belongs to.
  - setResourceSettings
```
protected void setResourceSettings(RestResourceRegistry.ResourceSettings pResourceSettings)
```
    Set the Resource settings that this endpoint belongs to.
    
    Parameters:
    
    pResourceSettings - the Resource settings that this endpoint belongs to.
  - getTemplatePaths
```
public java.util.Map<java.lang.String,java.lang.String> getTemplatePaths()
```
  - setTemplatePaths
```
protected void setTemplatePaths(java.util.Map<java.lang.String,java.lang.String> pTemplatePaths)
```
  - getUrl
```
public java.lang.String getUrl()
```
  - setUrl
```
public void setUrl(java.lang.String pUrl)
```
  - setLockType
```
protected void setLockType(atg.service.jaxrs.RestLockService.LockType pLockType)
```
    Sets the lock type.
    
    Parameters:
    
    pLockType - The lock type.
  - getLockType
```
public atg.service.jaxrs.RestLockService.LockType getLockType()
```
    Returns the Lock Type.
    
    Returns:
    
    The lock type
  - setTransactional
```
protected void setTransactional(boolean pTransactional)
```
    Sets whether the endpoint is transactional.
    
    Parameters:
    
    pTransactional - Whether the endpoint is transactional.
  - isTransactional
```
public boolean isTransactional()
```
    Gets whether the endpoint is transactional.
    
    Returns:
    
    whether the endpoint is transactional.
  - setPrivate
```
protected void setPrivate(boolean pPrivate)
```
    Sets whether the endpoint is private.
    
    Parameters:
    
    pPrivate - Whether the endpoint is private.
  - isPrivate
```
public boolean isPrivate()
```
    Gets whether the endpoint is private.
    
    Returns:
    
    Whether the endpoint is private.
  - setFilterDepth
```
protected void setFilterDepth(int pFilterDepth)
```
    Sets the filter depth, -1 indicates to limit.
    
    Parameters:
    
    pFilterDepth - the filter depth, -1 indicates to limit.
  - getFilterDepth
```
public int getFilterDepth()
```
    Gets the filter depth, -1 indicates to limit.
    
    Returns:
    
    the filter depth, -1 indicates to limit.
  - setValidatorId
```
protected void setValidatorId(java.lang.String pValidatorId)
```
    Sets the id of the validator used with the endpoint.
    
    Parameters:
    
    pValidatorId - The id of the validator used with the endpoint.
  - getValidatorId
```
public java.lang.String getValidatorId()
```
    Gets the id of the validator used with the endpoint.
    
    Returns:
    
    The id of the validator used with the endpoint.
  - setFilterId
```
protected void setFilterId(java.lang.String pFilterId)
```
    Sets the id of the filter used with the endpoint.
    
    Parameters:
    
    pFilterId - The id of the filter used with the endpoint.
  - getFilterId
```
public java.lang.String getFilterId()
```
    Gets the id of the filter used with the endpoint.
    
    Returns:
    
    The id of the filter used with the endpoint.
  - setConsumes
```
protected void setConsumes(java.util.Set<java.lang.String> pConsumes)
```
    Setter for the media types this endpoint consumes. Populated via the @Consumes annotation.
    
    Parameters:
    
    pConsumes - Set of string media types
  - getConsumes
```
public java.util.Set<java.lang.String> getConsumes()
```
    Getter for the media types this endpoint consumes.
    
    Returns:
    
    Set of string media types
  - setProduces
```
protected void setProduces(java.util.Set<java.lang.String> pProduces)
```
    Setter for the media types this endpoint produces. Populated via the @Produces annotation.
    
    Parameters:
    
    pProduces - Set of string media types
  - getProduces
```
public java.util.Set<java.lang.String> getProduces()
```
    Getter for the media types this endpoint produces.
    
    Returns:
    
    Set of string media types
  - setLocaleHint
```
public void setLocaleHint(java.lang.String pLocaleHint)
```
    Set the locale hint of the the endpoint.
    
    Parameters:
    
    pLocaleHint - The locale hint of the the endpoint.
  - getLocaleHint
```
public java.lang.String getLocaleHint()
```
    Gets the locale hint of the the endpoint.
    
    Returns:
    
    The locale hint of the the endpoint.
  - setPath
```
protected void setPath(java.lang.String pPath)
```
    Sets the path for the endpoint. The path is relative to the containing resource and may be a template, e.g. commerceItems/{itemId}
    
    Parameters:
    
    pPath - The path for the endpoint.
  - getPath
```
public java.lang.String getPath()
```
    Gets the path for the endpoint. The path is relative to the containing resource and may be a template, e.g. commerceItems/{itemId}
    
    Returns:
    
    The path for the endpoint.
  - setHasPathParams
```
protected void setHasPathParams(boolean pHasPathParams)
```
    Sets whether the URL of the endpoint has params.
    
    Parameters:
    
    pHasPathParams - Whether the URL of the endpoint has params.
  - isHasPathParams
```
public boolean isHasPathParams()
```
    Gets whether the URL of the endpoint has params.
    
    Returns:
    
    Whether the URL of the endpoint has params.
  - setAuthRequired
```
public void setAuthRequired(boolean pAuthRequired)
```
    Set whether access to the endpoint requires the user to be authenticated.
    
    Parameters:
    
    pAuthRequired - Whether access to the endpoint requires the user to be authenticated.
  - isAuthRequired
```
public boolean isAuthRequired()
```
    Gets whether access to the endpoint requires the user to be authenticated.
    
    Returns:
    
    Whether access to the endpoint requires the user to be authenticated.
  - setHttpsRequired
```
public void setHttpsRequired(boolean pHttpsRequired)
```
    Sets whether access to the endpoint requires https.
    
    Parameters:
    
    pHttpsRequired - Whether access to the endpoint requires https.
  - isHttpsRequired
```
public boolean isHttpsRequired()
```
    Gets whether access to the endpoint requires https.
    
    Returns:
    
    Whether access to the endpoint requires https.
  - setHttpMethod
```
protected void setHttpMethod(java.lang.String pHttpMethod)
```
    Set the http method of the endpoint.
    
    Parameters:
    
    pHttpMethod - The http method of the endpoint.
  - getHttpMethod
```
public java.lang.String getHttpMethod()
```
    Gets the http method of the endpoint.
    
    Returns:
    
    The http method of the endpoint.
  - setSingular
```
protected void setSingular(boolean pSingular)
```
    Sets whether the endpoint resource type is singular.
    
    Parameters:
    
    pSingular - Whether the endpoint resource type is singular.
  - isSingular
```
public boolean isSingular()
```
    Gets whether the endpoint resource type is singular.
    
    Returns:
    
    Whether the endpoint resource type is singular.
  - setUseOptimisticLock
```
public void setUseOptimisticLock(boolean pUseOptimisticLock)
```
    Sets whether the endpoint uses optimistic locking.
    
    Parameters:
    
    pUseOptimisticLock - Whether the endpoint uses optimistic locking.
  - isUseOptimisticLock
```
public boolean isUseOptimisticLock()
```
    Gets whether the endpoint uses optimistic locking.
    
    Returns:
    
    Whether the endpoint uses optimistic locking.
  - setUseImportableResourceLock
```
public void setUseImportableResourceLock(boolean pUseImportableResourceLock)
```
    Sets whether the endpoint uses the importable resource lock.
    
    Parameters:
    
    pUseOptimisticLock - Whether the endpoint uses the importable resource lock.
  - isUseImportableResourceLock
```
public boolean isUseImportableResourceLock()
```
    Gets whether the endpoint uses importable resource locking.
    
    Returns:
    
    Whether the endpoint uses importable resource locking.
  - setMethodObject
```
protected void setMethodObject(java.lang.reflect.Method pMethodObject)
```
    Sets the actual endpoint method in the endpoint class.
    
    Parameters:
    
    pMethodObject - The actual endpoint method in the endpoint class.
  - getMethodObject
```
public java.lang.reflect.Method getMethodObject()
```
    Gets the actual endpoint method in the endpoint class.
    
    Returns:
    
    The actual endpoint method in the endpoint class.
  - addAccessControllerId
```
public void addAccessControllerId(java.lang.String pKey,
                                  java.lang.String pAccessControllerId)
```
    Adds a map of url path to access controller id on the endpoint. Sub resource endpoints may have different access controllers for each path to the sub resource, in this case the key will be the template path to the sub resource.
    
    Parameters:
    
    pKey - the url path for this access control id
    
    pAccessControllerId - The access controller id on the endpoint.
  - getAccessControllerId
```
public java.util.Map<java.lang.String,java.lang.String> getAccessControllerId()
```
    Gets the map of access controller ids for the endpoint. For sub resource endpoints the key to the map will be the template path to the sub resource.
    
    Returns:
    
    map of access controller ids
  - setHasDoc
```
public void setHasDoc(boolean pHasDoc)
```
    Sets the 'has documentation' flag. Currently unused.
    
    Parameters:
    
    pHasDoc - The 'has documentation' flag.
  - isHasDoc
```
public boolean isHasDoc()
```
    Gets the 'has documentation' flag. Currently unused.
    
    Returns:
    
    The 'has documentation' flag.
  - setRequestType
```
protected void setRequestType(java.lang.String pRequestType)
```
    Sets the content type the endpoint consumes.
    
    Parameters:
    
    pRequestType - The content type the endpoint consumes.
  - getRequestType
```
public java.lang.String getRequestType()
```
    Gets the content type the endpoint consumes.
    
    Returns:
    
    The content type the endpoint consumes.
  - setResponseType
```
protected void setResponseType(java.lang.String pResponseType)
```
    Sets the content type the endpoint produces.
    
    Parameters:
    
    pResponseType - The content type the endpoint produces.
  - getResponseType
```
public java.lang.String getResponseType()
```
    Gets the content type the endpoint produces.
    
    Returns:
    
    The content type the endpoint produces.
  - setCachingEnabled
```
protected void setCachingEnabled(boolean pCachingEnabled)
```
    Sets whether caching is enabled on the endpoint.
    
    Parameters:
    
    pCachingEnabled - Whether caching is enabled on the endpoint.
  - getCachingEnabled
```
public boolean getCachingEnabled()
```
    Gets whether caching is enabled on the endpoint.
    
    Returns:
    
    Whether caching is enabled on the endpoint.
  - setHasJAXRSAnnotatedFields
```
protected void setHasJAXRSAnnotatedFields(boolean pHasJAXRSAnnotatedFields)
```
    Sets whether the endpoint has JAXRS annotations.
    
    Parameters:
    
    pHasJAXRSAnnotatedFields - Whether the endpoint has JAXRS annotations.
  - isHasJAXRSAnnotatedFields
```
public boolean isHasJAXRSAnnotatedFields()
```
    Gets whether the endpoint has JAXRS annotations.
    
    Returns:
    
    Whether the endpoint has JAXRS annotations.
  - setLinkRelation
```
protected void setLinkRelation(java.lang.String pLinkRelation)
```
    Sets the link relation for the endpoint.
    
    Parameters:
    
    pLinkRelation - The link relation for the endpoint.
  - getLinkRelation
```
public java.lang.String getLinkRelation()
```
    Gets the link relation for the endpoint.
    
    Returns:
    
    The link relation for the endpoint.
  - setResourceURL
```
protected void setResourceURL(java.lang.String pResourceURL)
```
    Sets the URL of the resource that the endpoint is part of.
    
    Parameters:
    
    pResourceURL - The URL of the resource that the endpoint is part of.
  - getResourceURL
```
public java.lang.String getResourceURL()
```
    Gets the URL of the resource that the endpoint is part of.
    
    Returns:
    
    The URL of the resource that the endpoint is part of.
  - setResourceURI
```
public void setResourceURI(java.lang.String pResourceURI)
```
    Sets the URL of the resource that the endpoint is part of.
    
    Parameters:
    
    pResourceURI - The URI of the resource that the endpoint is part of.
  - getResourceURI
```
public java.lang.String getResourceURI()
```
    Gets the URI of the resource that the endpoint is part of.
    
    Returns:
    
    The URI of the resource that the endpoint is part of.
  - isChangeTrackingDisabled
```
public boolean isChangeTrackingDisabled()
```
    Gets whether the endpoint has change tracking disabled
    
    Returns:
    
    whether the endpoint has change tracking disabled
  - setChangeTrackingDisabled
```
protected void setChangeTrackingDisabled(boolean pChangeTrackingDisabled)
```
    Sets whether the endpoint has change tracking disabled
    
    Parameters:
    
    pChangeTrackingDisabled - - whether the endpoint has change tracking disabled
  - isUpdateTarget
```
public boolean isUpdateTarget()
```
    Gets whether the endpoint creates and/or updates a target bean/repository item during input validation
    
    Returns:
    
    whether the endpoint
  - setUpdateTarget
```
protected void setUpdateTarget(boolean pUpdateTarget)
```
    Sets whether the endpoint creates and/or updates a target bean/repository item during input validation
    
    Parameters:
    
    pUpdateTarget - - whether the endpoint creates and/or updates a target bean/repository item during input validation
  - isValidatedByFramework
```
public boolean isValidatedByFramework()
```
    Gets whether validation of endpoint input is validated by the framework
    
    Returns:
    
    whether validation of endpoint input is validated by the framework
  - setValidatedByFramework
```
protected void setValidatedByFramework(boolean pValidatedByFramework)
```
    Sets whether validation of endpoint input is validated by the framework
    
    Parameters:
    
    pValidatedByFramework - - whether validation of endpoint input is validated by the framework
  - getPreActionMethod
```
public java.lang.String getPreActionMethod()
```
    Returns the name of the pre action method for this endpoint.
    
    Returns:
    
    the pre aciton method name.
  - setPreActionMethod
```
protected void setPreActionMethod(java.lang.String pPreActionMethod)
```
    Sets the name of the pre action method for this endpoint.
    
    Parameters:
    
    pPreActionMethod - the pre action method name to set.
  - getPostActionMethod
```
public java.lang.String getPostActionMethod()
```
    Returns the name of the post action method for this endpoint.
    
    Returns:
    
    the post action method name.
  - setPostActionMethod
```
protected void setPostActionMethod(java.lang.String pPostActionMethod)
```
    Sets the name of the post action method for this endpoint.
    
    Parameters:
    
    pPostActionMethod - the post action method name to set.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class RestResourceRegistry.EndpointSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mId

mResourceSettings

mTemplatePaths

mLockType

mTransactional

mPrivate

mFilterDepth

mValidatorId

mFilterId

mConsumes

mProduces

mLocaleHint

mHasPathParams

mPath

mAuthRequired

mHttpsRequired

mHttpMethod

mSingular

mMethodObject

mAccessControllerId

mHasDoc

mRequestType

mResponseType

mCachingEnabled

mHasJAXRSAnnotatedFields

mLinkRelation

mResourceURL

mChangeTrackingDisabled

mUpdateTarget

mValidatedByFramework

mPreActionMethod

mPostActionMethod

mUrl

Constructor Detail

EndpointSettings

Method Detail

setId

getId

getResourceSettings

setResourceSettings

getTemplatePaths

setTemplatePaths

getUrl

setUrl

setLockType

getLockType

setTransactional

isTransactional

setPrivate

isPrivate

setFilterDepth

getFilterDepth

setValidatorId

getValidatorId

setFilterId

getFilterId

setConsumes

getConsumes

setProduces

getProduces

setLocaleHint

getLocaleHint

setPath

getPath

setHasPathParams

isHasPathParams

setAuthRequired

isAuthRequired

setHttpsRequired

isHttpsRequired

setHttpMethod

getHttpMethod

setSingular

isSingular