Annotation Interface PathTemplate
Describes the URI pattern of resources that a type
Dispatches. The
syntax of the pattern MUST conform to the syntax of
Route Patterns.- Author:
- cdivilly
-
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionString[]Enumerates the sets of media types that this resource can accept for requests that may contain a resource body (e.g.String[]The set of Web Origins that can access this resource viaCORSOptionally specify the HTTP Authentication Schemes that this pattern can dispatch.Identifies if the resource can be accessed viaCORSor not.The version that this resource was deprecated in.Describes how this resource is documented.Defines if the resource can be framedThe version that this resource was introduced in.String[]Optionally specify the HTTP methods that this pattern can dispatchOptionally assign a mnemonic name to the path templatebooleanSet this attribute to true if this resource may overlap with other (possibly user defined resources)intFor resources that may be paginated indicates the number of items to display per page.Describes how a resource is paginated.Describes how path portion of the request URI should be validated.The version that this resource was removed from.Identifies the name of thePrivilegethat protects this URI patternDescribes the transport level security requirements for this URI pattern -
Field Summary
Fields
-
Field Details
-
DEFAULT_PRIORITY
static final int DEFAULT_PRIORITYDefault priority value- See Also:
-
-
Element Details
-
value
String valueThe Route pattern- Returns:
- Route Pattern
-
-
-
accepts
String[] acceptsEnumerates the sets of media types that this resource can accept for requests that may contain a resource body (e.g. PUT, POST). The media type specification MAY contain wildcards An empty array (the default) indicates that the resource accepts any media type- Returns:
- The acceptable media types
- Default:
- {}
-
cors
Identifies if the resource can be accessed viaCORSor not. Note the default isCrossOriginSharingPolicy.ALLOW.- Returns:
- The
CrossOriginSharingPolicy
- Default:
- INHERIT
-
allowedOrigins
String[] allowedOriginsThe set of Web Origins that can access this resource viaCORS- Returns:
- Array of Web Origins
- Default:
- {}
-
documentation
DocumentationPolicy documentationDescribes how this resource is documented.- Returns:
DocumentationPolicyinstance
- Default:
- AUTHORIZED
-
pathValidation
PathSyntaxPolicy pathValidationDescribes how path portion of the request URI should be validated.- Returns:
PathSyntaxPolicyinstance
- Default:
- CHECK
-
frameOptions
FramePolicy frameOptionsDefines if the resource can be framed- Returns:
FramePolicyinstance
- Default:
- SAME_ORIGIN
-
methods
String[] methodsOptionally specify the HTTP methods that this pattern can dispatch- Returns:
- supported HTTP methods
- Default:
- {}
-
authSchemes
HTTPAuthenticationScheme[] authSchemesOptionally specify the HTTP Authentication Schemes that this pattern can dispatch. Currently only one explicit HTTPAuthenticationScheme is defined (HTTPAuthenticationScheme.BASIC). It is imagined that in the future we will support more defined HTTPAuthenticationSchemes so an Array is used here.- Returns:
- supported Auth Schemes
- Default:
- {ANY}
-
name
String nameOptionally assign a mnemonic name to the path template- Returns:
- mnemonic that uniquely identifies this
PathTemplate - See Also:
- Default:
- ""
-
pageSize
int pageSizeFor resources that may be paginated indicates the number of items to display per page.- Returns:
- number of items per page
- Default:
- -1
-
pagination
PaginationStrategy paginationDescribes how a resource is paginated.- Returns:
PaginationStrategyinstance
- Default:
- NONE
-
requiresPrivilege
String requiresPrivilegeIdentifies the name of thePrivilegethat protects this URI pattern- Returns:
- privilege name
- Default:
- ""
-
transport
TransportPolicy transportDescribes the transport level security requirements for this URI pattern- Returns:
TransportPolicyinstance
- Default:
- ANY
-
introducedSince
String introducedSinceThe version that this resource was introduced in. If not specified then it's value is inherited from theHttpServlet'sIntroducedSinceannotation or the plugin identified byBelongsTo'sIntroducedSinceannotation- Returns:
- Version number string
- See Also:
- Default:
- ""
-
deprecatedSince
String deprecatedSinceThe version that this resource was deprecated in. If not specified then it's value is inherited from theHttpServlet'sIntroducedSinceannotation or the plugin identified byBelongsTo'sIntroducedSinceannotation. If no value is inherited then the resource is not deprecated- Returns:
- Version number string
- See Also:
- Default:
- ""
-
removedSince
String removedSinceThe version that this resource was removed from. If not specified then it's value is inherited from theHttpServlet'sRemovedSinceannotation. If no value is inherited then the resource has not been removed.- Returns:
- Version number string
- See Also:
- Default:
- ""
-
overlaps
boolean overlapsSet this attribute to true if this resource may overlap with other (possibly user defined resources)- Returns:
- true if this resource path may overlap with other resources
- Default:
- false
-