atg.service.jaxrs

Class LinkUtils

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.jaxrs.LinkUtils

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

Utility class for creating links to embedded resources. Uses a singleton pattern to allow for static instance usage.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AMPERSAND The AMPERSAND constant.
static java.lang.String	ARRAY_KEY The ARRAY_KEY constant.
static java.lang.String	AUTO_WRAP_KEY The AUTO_WRAP_KEY constant.
static java.lang.String	CANONICAL_KEY The CANONICAL constant.
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	COLLECTION_REL IANA relation name for a link to an owner collection
static java.lang.String	COLON The COLON constant.
static java.lang.String	COMMA The COMMA constant.
static java.lang.String	COUNT The COUNT property constant.
static java.lang.String	CURIES The CURIES constant.
static java.lang.String	DEFAULT_LINK_UTILS_PATH A default configuration of an instance of this service
static java.lang.String	DOT The DOT constant.
static java.lang.String	DOT_ESC The DOT_ESC constant.
static java.lang.String	EMPTY_STRING The EMPTY_STRING constant.
static java.lang.String	EQUALS The EQUALS constant.
static java.lang.String	FIELDS_PARAM_KEY The FIELDS_PARAM_KEY constant.
static java.lang.String	FIRST_KEY The FIRST_KEY constant.
static java.lang.String	HAS_MORE The HAS_MORE property constant.
static java.lang.String	HREF The HREF constant.
static java.lang.String	HREF_KEY The HREF_KEY constant.
static java.lang.String	LAST_KEY The LAST_KEY constant.
static java.lang.String	LEFT_CURLY The LEFT_CURLY constant.
static java.lang.String	LEFT_PAREN The LEFT_PAREN constant.
static java.lang.String	LEFT_PAREN_ESC The LEFT_PAREN_ESC constant.
static java.lang.String	LIMIT The LIMIT property constant.
static java.lang.String	LINKS The LINKS constant.
static java.lang.String	MEDIA_TYPE The MEDIA_TYPE constant.
static java.lang.String	METHOD The METHOD constant.
static java.lang.String	NAME The NAME constant.
static java.lang.String	NEXT_KEY The NEXT_KEY constant.
static java.lang.String	NEXT_LIMIT The NEXT_LIMIT constant.
static java.lang.String	NEXT_OFFSET The NEXT_OFFSET constant.
static java.lang.String	NEXT_TOTAL The NEXT_TOTAL constant.
static java.lang.String	OFFSET The OFFSET property constant.
static java.lang.String	PREV_KEY The PREV_KEY constant.
static java.lang.String	PROFILE The PROFILE constant.
static java.lang.String	QUESTION_MARK The QUESTION_MARK constant.
static java.lang.String	REL The REL constant.
static java.lang.String	REL_SELF The REL_SELF constant.
static java.lang.String	RIGHT_CURLY The RIGHT_CURLY constant.
static java.lang.String	RIGHT_PAREN The RIGHT_PAREN constant.
protected static LinkUtils	sDefaultLinkUtils
static java.lang.String	SELF_KEY The SELF_KEY constant.
static java.lang.String	SLASH The SLASH constant.
static java.lang.String	TEMPLATE_ID The TEMPLATE_ID constant.
static java.lang.String	TEMPLATED The TEMPLATED constant.
static java.lang.String	TOTAL_RESULTS The TOTAL_RESULTS property constant.

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

Method Summary

Modifier and Type	Method and Description
protected void	addLimit(java.lang.StringBuilder pBuilder, int pLimit) Add limit to a string builder
protected void	addLinkIfNotNull(RepresentationModel pModel, java.lang.String pHref, java.lang.String pRel, java.lang.String pMethod) Add the link to the model if the href is not null
protected void	addOffset(java.lang.StringBuilder pBuilder, int pOffset) Add offset to a string builder.
void	addPaginationLinks(RepresentationModel pModel) Add pagination links and properties to response model object
protected java.lang.String	addQueryParamsToPath(java.lang.String pPath, <any> pQueryParams, boolean pIncludeCurrentQueryParams, boolean pAllowDuplicateQueryParams) Adds the given map of query params to the given uri path, optionally merging with the current request query parameters.
void	addResourceLink(java.lang.String pRelation, java.lang.String pLinkPath, java.lang.String[] pTemplateVariables, java.lang.String pHttpMethod, java.util.Set<Link> pLinks) Adds a link for the given path and relation name to the given set of links.
java.lang.String	buildAbsolutePath(java.lang.String pPath, java.lang.Object... pVars) Ensures a given path is returned as an absolute path and with template variables populated
java.lang.String	buildLink(java.lang.String pPathTemplateString, java.lang.String pPath, java.lang.String pId) Build the embedded link from the supplied path and id.
java.lang.String[]	buildMemberUris(<any> pQueryParams, java.lang.String... pMemberIds) Returns string uri(s) for a member(s) of a collection resource.
java.lang.String[]	buildMemberUris(java.lang.String... pMemberIds) Returns string uri(s) for a member(s) of a collection resource.
java.lang.String[]	buildMemberUris(java.lang.String pResourceId, <any> pQueryParams, java.lang.String... pMemberIds) Returns string uri(s) for a member(s) of a collection resource.
java.lang.String[]	buildMemberUris(java.lang.String pResourceId, <any> pQueryParams, java.lang.String pIdPropertyName, java.util.Collection pMembers) Returns string uri(s) for member(s) of the given collection.
java.lang.String[]	buildMemberUris(java.lang.String pResourceId, <any> pQueryParams, java.lang.String pIdPropertyName, java.util.Collection pMembers, java.lang.Integer pStartIndex, java.lang.Integer pEndIndex) Returns string uri(s) for a page of member(s) of a collection resource.
java.lang.String	buildResourceUri(java.lang.String pResourceId, boolean pSingular, boolean pSubResource, <any> pQueryParams, boolean pIncludeCurrentQueryParams, boolean pAllowDuplicateQueryParams, java.lang.String... pPathParams) Returns a string uri of a resource for the given resource id.
java.lang.String	buildResourceUri(java.lang.String pResourceId, boolean pSingular, boolean pSubResource, java.util.Map<java.lang.String,java.lang.String> pQueryParams, java.lang.String... pPathParams) Returns a string uri of a resource for the given resource id.
protected java.lang.String	createListingLink(int pOffset, int pLimit) Create a link with listing/sorting params.
java.lang.String	expandRelationDefinition(java.lang.String pRel) Expand curie definition in the relation name to support self documentation
java.lang.String	firstUriFromContext(ListingResponse pListingResponse) Get the first uri for the current context.
protected java.lang.String	fixSlashes(java.lang.String pPath) Returns the given path string uri ensuring it starts with a slash and doesn't end with one.
java.lang.String	formatUriPath(java.lang.String pUriPath) Utility method to get the string path to render for a given uri path.
java.lang.String	formatUriPath(java.net.URI pUri) Utility method to get the string path to render for a given uri.
RestContext	getCurrentContext() Utility method to get the current rest context.
<any>	getCurrentQueryParameters() Utility method to get the current request query parameters.
UriInfo	getCurrentUriInfo() Utility method to get the current uri info.
java.lang.String	getEndpointTemplateUriPath(RestResourceRegistry.EndpointSettings pEndpoint, java.lang.String pUri) Utility method to go through the possible template uris for an endpoint and find one that is associated with the given uri.
static LinkUtils	getLinkUtils() Static utility method to get a nucleus instance of this component.
RestResourceRegistry	getRegistry() Utility method to get the current rest context resource registry.
java.net.URI	getRelativeUri(java.net.URI pUri) Gets the uri that is relative to the rest resource registry context.
Link[]	getResourceLinks(RestResourceRegistry.EndpointSettings pEndpoint, boolean pSingularLinks, java.lang.String[] pTemplateVariables) Retrieves the links associated with the resource
protected java.lang.String[]	getTemplateVariables(java.lang.String pTemplatedUri, java.lang.String pUri) Method to get the variable parts of a uri.
protected UriInfo	getUriInfo() Gets the UriInfo for the current request
java.lang.String	getUriPath(java.lang.String pResourceId) Get the URI path.
java.lang.String	getUriPrefix(UriInfo pContext) Get the uri prefix portion from a context.
boolean	isTemplatedPath(java.lang.String pPath) Utility method to determine if the given path string has any templated parts, e.g.
java.lang.String	joinPaths(java.lang.String... pPaths) Joins multiple uri path strings together into a single uri path string.
java.lang.String	lastUriFromContext(ListingResponse pListingResponse) Get the last uri for the current context.
protected java.lang.String	matchTemplatePath(java.lang.String pTemplatePath, java.lang.String pPath, boolean pPartialMatch) Matches a given path against a given path template.
java.lang.String	nextUriFromContext(ListingResponse pListingResponse) Get the 'next' uri for the current context.
java.lang.String	prevUriFromContext(ListingResponse pListingResponse) Get the prev uri for the current context.
java.lang.String	removeContextRoot(java.lang.String pUri) Utility method to return a uri path after the current context root.
Link	selfLinkFromContext() Creates a self link to be used in the response resource representation.
Link	selfLinkFromContext(java.lang.Boolean pSingular, java.lang.String... pPathParams) Creates a self link for the current resource response in context.

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, 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 java.lang.String CLASS_VERSION

Class version string

DEFAULT_LINK_UTILS_PATH

public static final java.lang.String DEFAULT_LINK_UTILS_PATH

A default configuration of an instance of this service

See Also:

Constant Field Values

TOTAL_RESULTS

public static final java.lang.String TOTAL_RESULTS

The TOTAL_RESULTS property constant.

See Also:

Constant Field Values

LIMIT

public static final java.lang.String LIMIT

The LIMIT property constant.

See Also:

Constant Field Values

COUNT

public static final java.lang.String COUNT

The COUNT property constant.

See Also:

Constant Field Values

HAS_MORE

public static final java.lang.String HAS_MORE

The HAS_MORE property constant.

See Also:

Constant Field Values

OFFSET

public static final java.lang.String OFFSET

The OFFSET property constant.

See Also:

Constant Field Values

NEXT_TOTAL

public static final java.lang.String NEXT_TOTAL

The NEXT_TOTAL constant.

See Also:

Constant Field Values

NEXT_OFFSET

public static final java.lang.String NEXT_OFFSET

The NEXT_OFFSET constant.

See Also:

Constant Field Values

NEXT_LIMIT

public static final java.lang.String NEXT_LIMIT

The NEXT_LIMIT constant.

See Also:

Constant Field Values

REL_SELF

public static final java.lang.String REL_SELF

The REL_SELF constant.

See Also:

Constant Field Values

HREF

public static final java.lang.String HREF

The HREF constant.

See Also:

Constant Field Values

TEMPLATED

public static final java.lang.String TEMPLATED

The TEMPLATED constant.

See Also:

Constant Field Values

REL

public static final java.lang.String REL

The REL constant.

See Also:

Constant Field Values

PROFILE

public static final java.lang.String PROFILE

The PROFILE constant.

See Also:

Constant Field Values

MEDIA_TYPE

public static final java.lang.String MEDIA_TYPE

The MEDIA_TYPE constant.

See Also:

Constant Field Values

METHOD

public static final java.lang.String METHOD

The METHOD constant.

See Also:

Constant Field Values

LINKS

public static final java.lang.String LINKS

The LINKS constant.

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

The NAME constant.

See Also:

Constant Field Values

CURIES

public static final java.lang.String CURIES

The CURIES constant.

See Also:

Constant Field Values

ARRAY_KEY

public static final java.lang.String ARRAY_KEY

The ARRAY_KEY constant.

See Also:

Constant Field Values

AUTO_WRAP_KEY

public static final java.lang.String AUTO_WRAP_KEY

The AUTO_WRAP_KEY constant.

See Also:

Constant Field Values

CANONICAL_KEY

public static final java.lang.String CANONICAL_KEY

The CANONICAL constant.

See Also:

Constant Field Values

SELF_KEY

public static final java.lang.String SELF_KEY

The SELF_KEY constant.

See Also:

Constant Field Values

NEXT_KEY

public static final java.lang.String NEXT_KEY

The NEXT_KEY constant.

See Also:

Constant Field Values

PREV_KEY

public static final java.lang.String PREV_KEY

The PREV_KEY constant.

See Also:

Constant Field Values

HREF_KEY

public static final java.lang.String HREF_KEY

The HREF_KEY constant.

See Also:

Constant Field Values

FIRST_KEY

public static final java.lang.String FIRST_KEY

The FIRST_KEY constant.

See Also:

Constant Field Values

LAST_KEY

public static final java.lang.String LAST_KEY

The LAST_KEY constant.

See Also:

Constant Field Values

FIELDS_PARAM_KEY

public static final java.lang.String FIELDS_PARAM_KEY

The FIELDS_PARAM_KEY constant.

See Also:

Constant Field Values

COLON

public static final java.lang.String COLON

The COLON constant.

See Also:

Constant Field Values

SLASH

public static final java.lang.String SLASH

The SLASH constant.

See Also:

Constant Field Values

EQUALS

public static final java.lang.String EQUALS

The EQUALS constant.

See Also:

Constant Field Values

AMPERSAND

public static final java.lang.String AMPERSAND

The AMPERSAND constant.

See Also:

Constant Field Values

QUESTION_MARK

public static final java.lang.String QUESTION_MARK

The QUESTION_MARK constant.

See Also:

Constant Field Values

COMMA

public static final java.lang.String COMMA

The COMMA constant.

See Also:

Constant Field Values

DOT

public static final java.lang.String DOT

The DOT constant.

See Also:

Constant Field Values

DOT_ESC

public static final java.lang.String DOT_ESC

The DOT_ESC constant.

See Also:

Constant Field Values

LEFT_PAREN

public static final java.lang.String LEFT_PAREN

The LEFT_PAREN constant.

See Also:

Constant Field Values

RIGHT_PAREN

public static final java.lang.String RIGHT_PAREN

The RIGHT_PAREN constant.

See Also:

Constant Field Values

LEFT_PAREN_ESC

public static final java.lang.String LEFT_PAREN_ESC

The LEFT_PAREN_ESC constant.

See Also:

Constant Field Values

EMPTY_STRING

public static final java.lang.String EMPTY_STRING

The EMPTY_STRING constant.

See Also:

Constant Field Values

LEFT_CURLY

public static final java.lang.String LEFT_CURLY

The LEFT_CURLY constant.

See Also:

Constant Field Values

RIGHT_CURLY

public static final java.lang.String RIGHT_CURLY

The RIGHT_CURLY constant.

See Also:

Constant Field Values

TEMPLATE_ID

public static final java.lang.String TEMPLATE_ID

The TEMPLATE_ID constant.

See Also:

Constant Field Values

COLLECTION_REL

public static final java.lang.String COLLECTION_REL

IANA relation name for a link to an owner collection

See Also:

Constant Field Values

sDefaultLinkUtils

protected static LinkUtils sDefaultLinkUtils

Constructor Detail

LinkUtils

public LinkUtils()

Method Detail

getLinkUtils

public static LinkUtils getLinkUtils()

Static utility method to get a nucleus instance of this component. The current rest resource registry in context is used to obtain the link utils reference.

Returns:

nucleus instance of this component

selfLinkFromContext

public Link selfLinkFromContext()

Creates a self link to be used in the response resource representation. The self link needs to correspond to the response representation model if available. I.e. if the response model is the collection resource then the self link should be for the collection. Usually the endpoint and response models match, i.e. a collection endpoint responds with the collection resource. However occasionally this may not be the case if the model is available then we need to determine if it is singular.

Returns:

the self link to use

selfLinkFromContext

public Link selfLinkFromContext(java.lang.Boolean pSingular,
                                java.lang.String... pPathParams)

Creates a self link for the current resource response in context. If pSingular is true and the current endpoint in context is a collection endpoint then it is important for the path params to include the singular resource id.

Parameters:

pSingular - true if the response is singular, false for a collection and null to use the endpoint type.

pPathParams - additional path params to include the singular resource id if needed.

Returns:

Link self link.

getUriInfo

protected UriInfo getUriInfo()

Gets the UriInfo for the current request

Returns:

UriInfo for the current request

addPaginationLinks

public void addPaginationLinks(RepresentationModel pModel)
                        throws java.io.UnsupportedEncodingException,
                               RestException

Add pagination links and properties to response model object

Parameters:

pModel - the response object

Throws:

java.io.UnsupportedEncodingException - if there was an error encoding a query param or RestException for other errors

RestException

nextUriFromContext

public java.lang.String nextUriFromContext(ListingResponse pListingResponse)
                                    throws RestException

Get the 'next' uri for the current context.

Parameters:

pListingResponse - the listing response to use

Returns:

the 'next' string URI from the context object.

Throws:

RestException

prevUriFromContext

public java.lang.String prevUriFromContext(ListingResponse pListingResponse)
                                    throws RestException

Get the prev uri for the current context.

Parameters:

pListingResponse - listing response to use

Returns:

the prev uri from a context object.

Throws:

RestException

firstUriFromContext

public java.lang.String firstUriFromContext(ListingResponse pListingResponse)
                                     throws RestException

Get the first uri for the current context.

Parameters:

pListingResponse - listing response to use

Returns:

the first uri from a context object.

Throws:

RestException

lastUriFromContext

public java.lang.String lastUriFromContext(ListingResponse pListingResponse)
                                    throws RestException

Get the last uri for the current context.

Parameters:

pListingResponse - listing response to use

Returns:

the last uri from a context object.

Throws:

RestException

addLinkIfNotNull

protected void addLinkIfNotNull(RepresentationModel pModel,
                                java.lang.String pHref,
                                java.lang.String pRel,
                                java.lang.String pMethod)

Add the link to the model if the href is not null

Parameters:

pModel - the response representation model

pHref - the href for the uri

pRel - the link relation name

getUriPrefix

public java.lang.String getUriPrefix(UriInfo pContext)

Get the uri prefix portion from a context.

Parameters:

pContext - contains the request UriInfo

Returns:

the uri prefix portion from a context.

createListingLink

protected java.lang.String createListingLink(int pOffset,
                                             int pLimit)
                                      throws RestException

Create a link with listing/sorting params.

Parameters:

pOffset - offset

pLimit - limit

Returns:

the link with listing/sorting params.

Throws:

RestException

addOffset

protected void addOffset(java.lang.StringBuilder pBuilder,
                         int pOffset)

Add offset to a string builder.

Parameters:

pBuilder - the string builder.

pOffset - the offset value.

addLimit

protected void addLimit(java.lang.StringBuilder pBuilder,
                        int pLimit)

Add limit to a string builder

Parameters:

pBuilder - the string builder.

pLimit - the limit value.

getRelativeUri

public java.net.URI getRelativeUri(java.net.URI pUri)
                            throws RestException

Gets the uri that is relative to the rest resource registry context.

Parameters:

pUri - uri to relativize.

Returns:

uri for the given uri that is relative to the rest resource registry context.

Throws:

RestException - if uri cannot be relativized

getResourceLinks

public Link[] getResourceLinks(RestResourceRegistry.EndpointSettings pEndpoint,
                               boolean pSingularLinks,
                               java.lang.String[] pTemplateVariables)

Retrieves the links associated with the resource

Parameters:

pEndpoint - endpoint settings generating links for a response

pSingularLinks - true to return links for the singular endpoints or false for the collection links

pTemplateVariables - values for any path parameters in the links to be generated.

Returns:

links[] the array of links for the resource

getEndpointTemplateUriPath

public java.lang.String getEndpointTemplateUriPath(RestResourceRegistry.EndpointSettings pEndpoint,
                                                   java.lang.String pUri)

Utility method to go through the possible template uris for an endpoint and find one that is associated with the given uri.

Parameters:

pEndpoint - Endpoint to match against

pUri - Uri to match against

Returns:

Templated uri path that matched or null if none

removeContextRoot

public java.lang.String removeContextRoot(java.lang.String pUri)

Utility method to return a uri path after the current context root. E.g. /public/v1/cart would return /cart.

Parameters:

pUri - uri path to trim

Returns:

uri path after the context root

addResourceLink

public void addResourceLink(java.lang.String pRelation,
                            java.lang.String pLinkPath,
                            java.lang.String[] pTemplateVariables,
                            java.lang.String pHttpMethod,
                            java.util.Set<Link> pLinks)

Adds a link for the given path and relation name to the given set of links.

Parameters:

pRelation - relation name to use for the link

pLinkPath - path for the link (may be templated)

pTemplateVariables - if the path is templated then these are the value to use

pHttpMethod - http method for the link reference

pLinks - set of links to populate

isTemplatedPath

public boolean isTemplatedPath(java.lang.String pPath)

Utility method to determine if the given path string has any templated parts, e.g. '/orders/{orderId}' would return true but '/cart' would return false.

Parameters:

pPath - String path that may or may not have template variable parts.

Returns:

true if the path has template variables.

getTemplateVariables

protected java.lang.String[] getTemplateVariables(java.lang.String pTemplatedUri,
                                                  java.lang.String pUri)

Method to get the variable parts of a uri. The variable parts are those parts of the uri template that are wrapped in curly braces.

Parameters:

pTemplatedUri - The templated uri String with curly braced variable names

pUri - The actual uri to use to get the variable values

Returns:

Array of variable values pulled from the uri

expandRelationDefinition

public java.lang.String expandRelationDefinition(java.lang.String pRel)

Expand curie definition in the relation name to support self documentation

Parameters:

pRel - the relation name

Returns:

the relation name with absolte uri

buildLink

public java.lang.String buildLink(java.lang.String pPathTemplateString,
                                  java.lang.String pPath,
                                  java.lang.String pId)

Build the embedded link from the supplied path and id. The path produced will be used as a relative path, e.g. using the template "{path}/{id}" and values /foo and o12345 will product the path /foo/o1234.

Parameters:

pPathTemplateString - the path template representing the path with its placeholders

pPath - the path on which to build the resource

pId - the id of the resource

Returns:

the embedded link

buildResourceUri

public java.lang.String buildResourceUri(java.lang.String pResourceId,
                                         boolean pSingular,
                                         boolean pSubResource,
                                         java.util.Map<java.lang.String,java.lang.String> pQueryParams,
                                         java.lang.String... pPathParams)
                                  throws RestException

Returns a string uri of a resource for the given resource id. If the given resource is a subresource of the current context (determined by the pSubResource flag) then the uri is resolved based on the current context uri. E.g. If the current context uri is /order/o123 and the resource id is the commerceItems subresource then the returned uri would be /order/o123/commerceItems. If the given resource is not a subresource of the current context then the uri is resolved based on the uri template of the given resource. E.g. If the current context uri is /currentUser/getAllOrders and the resource id is the orders resource then the returned uri would be /order/{orderId} (with {orderId} replaced by pPathParams) Optionally a map of query params can also be passed in which will then be appended to any built uris. In addition if the uri has path params then the caller should pass in the path param values to use. The param values must be in the same order as they appear in the uri. The pSingular flag determines whether the singular or the collection uri for the given resource id will be used

Parameters:

pResourceId - resource id for the collection resource

pSingular - true if the singular of the given resource should be used

pSubResource - true if uri being built is sub resource of current context

pQueryParams - Optional map of query param key/value pairs to be added to any built uris, null if none

pPathParams - array of path param values needed to populate the uri or null if none.

Returns:

uri path for the given resource.

Throws:

RestException - should an error occur in processing.

buildResourceUri

public java.lang.String buildResourceUri(java.lang.String pResourceId,
                                         boolean pSingular,
                                         boolean pSubResource,
                                         <any> pQueryParams,
                                         boolean pIncludeCurrentQueryParams,
                                         boolean pAllowDuplicateQueryParams,
                                         java.lang.String... pPathParams)
                                  throws RestException

Returns a string uri of a resource for the given resource id. If the given resource is a subresource of the current context (determined by the pSubResource flag) then the uri is resolved based on the current context uri. E.g. If the current context uri is /order/o123 and the resource id is the commerceItems subresource then the returned uri would be /order/o123/commerceItems. If the given resource is not a subresource of the current context then the uri is resolved based on the uri template of the given resource. E.g. If the current context uri is /currentUser/getAllOrders and the resource id is the orders resource then the returned uri would be /order/{orderId} (with {orderId} replaced by pPathParams) Optionally a map of query params can also be passed in which will then be appended to any built uris. In addition if the uri has path params then the caller should pass in the path param values to use. The param values must be in the same order as they appear in the uri. The pSingular flag determines whether the singular or the collection uri for the given resource id will be used

Parameters:

pResourceId - resource id for the collection resource

pSingular - true if the singular of the given resource should be used

pSubResource - true if uri being built is sub resource of current context

pQueryParams - Optional map of query param key/value pairs to be added to any built uris, null if none

pIncludeCurrentQueryParams - boolean, true to also include query parameters in the current request on the build uri.

pAllowDuplicateQueryParams - boolean, false to prevent a merge of query params values with the same key.

pPathParams - array of path param values needed to populate the uri or null if none.

Returns:

uri path for the given resource.

Throws:

RestException - should an error occur in processing.

addQueryParamsToPath

protected java.lang.String addQueryParamsToPath(java.lang.String pPath,
                                                <any> pQueryParams,
                                                boolean pIncludeCurrentQueryParams,
                                                boolean pAllowDuplicateQueryParams)

Adds the given map of query params to the given uri path, optionally merging with the current request query parameters.

Parameters:

pPath - String uri path

pQueryParams - query parameters to add

pIncludeCurrentQueryParams - boolean, true to also add current request query parameters to the path

pAllowDuplicateQueryParams - boolean, false to prevent a merge of entries with the same key

Returns:

updated path with query parameters on it

fixSlashes

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

Returns the given path string uri ensuring it starts with a slash and doesn't end with one. An empty or null path will be returned as just slash.

Parameters:

pPath - the path to fix

Returns:

the fixed path

matchTemplatePath

protected java.lang.String matchTemplatePath(java.lang.String pTemplatePath,
                                             java.lang.String pPath,
                                             boolean pPartialMatch)

Matches a given path against a given path template. If pPartialMatch is true then the minimum path segments will be matched against each other.

Parameters:

pTemplatePath - template path pattern to match

pPath - path to match

pPartialMatch - if true then the minimum number of segments are matched.

Returns:

the path that actually matched the template path or null if there was no match

buildMemberUris

public java.lang.String[] buildMemberUris(java.lang.String... pMemberIds)
                                   throws RestException

Returns string uri(s) for a member(s) of a collection resource. The members are identified by the given string ids. NOTE: this method makes the assumption that the given member id strings are the correct values to plug into the member uri template. The member uri(s) are always resolved based on the current context uri. E.g. If the current context uri is /cart/commerceItems and a member id is ci00001 then the resolve member uri might be /cart/commerceItems/ci000001

Parameters:

pMemberIds - One or more string member instance ids

Returns:

array of string uris for the given member ids.

Throws:

RestException - should an error occur in processing.

buildMemberUris

public java.lang.String[] buildMemberUris(<any> pQueryParams,
                                          java.lang.String... pMemberIds)
                                   throws RestException

Returns string uri(s) for a member(s) of a collection resource. The members are identified by the given string ids. NOTE: this method makes the assumption that the given member id strings are the correct values to plug into the member uri template. The member uri(s) are always resolved based on the current context uri. E.g. If the current context uri is /cart/commerceItems and a member id is ci00001 then the resolve member uri might be /cart/commerceItems/ci000001 Optionally a map of query params can also be passed in which will then be appended to any built uris.

Parameters:

pQueryParams - Optional map of query param key/value pairs to be added to any built uris, null if none

pMemberIds - One or more string member instance ids

Returns:

array of string uris for the given member ids.

Throws:

RestException - should an error occur in processing.

buildMemberUris

public java.lang.String[] buildMemberUris(java.lang.String pResourceId,
                                          <any> pQueryParams,
                                          java.lang.String... pMemberIds)
                                   throws RestException

Returns string uri(s) for a member(s) of a collection resource. The members are identified by the given string ids. NOTE: this method makes the assumption that the given member id strings are the correct values to plug into the member uri template. If passed resource id is non-null the member uri(s) are resolved based on the uri of the endpoint with given resource id, otherwise the member uri(s) are resolved based on the current context uri. Optionally a map of query params can also be passed in which will then be appended to any built uris.

Parameters:

pResourceId - resource id for the singular resource to build members from

pQueryParams - Optional map of query param key/value pairs to be added to any built uris, null if none

pMemberIds - One or more string member instance ids

Returns:

array of string uris for the given member ids.

Throws:

RestException

buildMemberUris

public java.lang.String[] buildMemberUris(java.lang.String pResourceId,
                                          <any> pQueryParams,
                                          java.lang.String pIdPropertyName,
                                          java.util.Collection pMembers,
                                          java.lang.Integer pStartIndex,
                                          java.lang.Integer pEndIndex)
                                   throws RestException

Returns string uri(s) for a page of member(s) of a collection resource. The members are identified by the collection given, the page of items between the start and end index. If the indexes are null use the full collection.

The collection passed will support a set/list of Repository items; Beans or Strings. A dynamic bean retrieval will be performed for pIdPropertyName on the collection item. If the property is not found or is not a string then toString will be used instead to identify the member id for the collection's singular resource. This will work for a collection of strings; a collection of beans as lomg as the bean contains the pIdPropertyName property passed in; or a collection of Repository items when idPropertyName is set to 'id'.

If passed resource id is non-null the member uri(s) are resolved based on the uri of the endpoint with given resource id, otherwise the member uri(s) are resolved based on the current context uri.

Optionally a map of query params can also be passed in which will then be appended to any built uris.

Parameters:

pResourceId - resource id for the singular resource to build members uri from

pQueryParams - Optional map of query param key/value pairs to be added to any built uris, null if none

pIdPropertyName - identifies the collection item's property to use as the member's id

pMembers - a collection (list/set) of resource members

pStartIndex - start index for page of members

pEndIndex - end index for page of members

Returns:

array of string uris for a page of the members collection

Throws:

RestException

buildMemberUris

public java.lang.String[] buildMemberUris(java.lang.String pResourceId,
                                          <any> pQueryParams,
                                          java.lang.String pIdPropertyName,
                                          java.util.Collection pMembers)
                                   throws RestException

Returns string uri(s) for member(s) of the given collection.

The collection passed will support a set/list of Repository items; Beans or Strings. A dynamic bean retrieval will be performed for pIdPropertyName on the collection item. If the property is not found or is not a string then toString will be used instead to identify the member id for the collection's singular resource. This will work for a collection of strings; a collection of beans as lomg as the bean contains the pIdPropertyName property passed in; or a collection of Repository items when idPropertyName is set to 'id'.

If passed resource id is non-null the member uri(s) are resolved based on the uri of the endpoint with given resource id, otherwise the member uri(s) are resolved based on the current context uri.

Optionally a map of query params can also be passed in which will then be appended to any built uris.

Parameters:

pResourceId - resource id for the singular resource to build members from

pQueryParams - Optional map of query param key/value pairs to be added to any built uris, null if none

pIdPropertyName - identifies the collection item's property to use as the member's id

pMembers - a collection (list/set) of resource members

Returns:

array of string uris for the given members collection.

Throws:

RestException

getUriPath

public java.lang.String getUriPath(java.lang.String pResourceId)

Get the URI path. If passed in resource id is non-null the path is resolved based on the uri of the endpoint with given resource id, otherwise the path is resolved based on the current context uri.

Parameters:

pResourceId - resource to generate the path for

Returns:

uri path

buildAbsolutePath

public java.lang.String buildAbsolutePath(java.lang.String pPath,
                                          java.lang.Object... pVars)

Ensures a given path is returned as an absolute path and with template variables populated

Parameters:

pPath - path to resolve as absolute

pVars - template values to use

Returns:

absolute path

formatUriPath

public java.lang.String formatUriPath(java.lang.String pUriPath)

Utility method to get the string path to render for a given uri path. Checks whether the registry wants full http paths or only absolute paths.

Parameters:

pUriPath - URI path to format

Returns:

string path for the given uri path

formatUriPath

public java.lang.String formatUriPath(java.net.URI pUri)

Utility method to get the string path to render for a given uri. Checks whether the registry wants full http paths or only absolute paths.

Parameters:

pUri - URI to format

Returns:

string path for the given uri

getRegistry

public RestResourceRegistry getRegistry()

Utility method to get the current rest context resource registry.

Returns:

the rest resource registry from the current rest context

getCurrentContext

public RestContext getCurrentContext()

Utility method to get the current rest context.

Returns:

the current rest context

getCurrentUriInfo

public UriInfo getCurrentUriInfo()
                          throws RestException

Utility method to get the current uri info.

Returns:

the current uri info

Throws:

RestException - if the current rest context, request context or uri info is null

getCurrentQueryParameters

public <any> getCurrentQueryParameters()
                                throws RestException

Utility method to get the current request query parameters.

Returns:

the query parameters

Throws:

RestException - if the current rest context, request context or uri info is null

joinPaths

public java.lang.String joinPaths(java.lang.String... pPaths)

Joins multiple uri path strings together into a single uri path string. The returned string will begin with a '/' and will not end with one.

Parameters:

pPaths - array of string paths to join

Returns:

the joined strings into a single path