@Retention(value=RUNTIME) @Target(value=TYPE) @Documented public @interface PathTemplate
Dispatches
. The syntax of the pattern MUST conform to the syntax of Route Patterns.Modifier and Type | Fields and Description |
---|---|
static int |
DEFAULT_PRIORITY
Default priority value
|
Modifier and Type | Required Element and Description |
---|---|
String |
value
The Route pattern
|
Modifier and Type | Optional Element and Description |
---|---|
String[] |
accepts
Enumerates the sets of media types that this resource can accept for requests that may contain a resource body (e.g.
|
String[] |
allowedOrigins
The set of Web Origins that can access this resource via
CORS |
HTTPAuthenticationScheme[] |
authSchemes
Optionally specify the HTTP Authentication Schemes that this pattern can dispatch.
|
CrossOriginSharingPolicy |
cors
Identifies if the resource can be accessed via
CORS or not. |
String |
deprecatedSince
The version that this resource was deprecated in.
|
DocumentationPolicy |
documentation
Describes how this resource is documented.
|
FramePolicy |
frameOptions
Defines if the resource can be framed
|
String |
introducedSince
The version that this resource was introduced in.
|
String[] |
methods
Optionally specify the HTTP methods that this pattern can dispatch
|
String |
name
Optionally assign a mnemonic name to the path template
|
boolean |
overlaps
Set this attribute to true if this resource may overlap with other (possibly user defined resources)
|
int |
pageSize
For resources that may be paginated indicates the number of items to display per page.
|
PaginationStrategy |
pagination
Describes how a resource is paginated.
|
PathSyntaxPolicy |
pathValidation
Describes how path portion of the request URI should be validated.
|
String |
removedSince
The version that this resource was removed from.
|
String |
requiresPrivilege
Identifies the name of the
Privilege that protects this URI pattern |
TransportPolicy |
transport
Describes the transport level security requirements for this URI pattern
|
public abstract String value
public abstract String[] accepts
public abstract CrossOriginSharingPolicy cors
CORS
or not. Note the default is CrossOriginSharingPolicy.ALLOW
.CrossOriginSharingPolicy
public abstract DocumentationPolicy documentation
DocumentationPolicy
instancepublic abstract PathSyntaxPolicy pathValidation
PathSyntaxPolicy
instancepublic abstract FramePolicy frameOptions
FramePolicy
instancepublic abstract String[] methods
public abstract HTTPAuthenticationScheme[] authSchemes
public abstract String name
PathTemplate
PathTemplateMatch.name()
public abstract int pageSize
public abstract PaginationStrategy pagination
PaginationStrategy
instancepublic abstract TransportPolicy transport
TransportPolicy
instancepublic abstract String introducedSince
HttpServlet
's IntroducedSince
annotation or the plugin identified by BelongsTo
's IntroducedSince
annotationIntroducedSince
public abstract String deprecatedSince
HttpServlet
's IntroducedSince
annotation or the plugin identified by BelongsTo
's IntroducedSince
annotation. If no value is inherited then the resource is not deprecatedDeprecatedSince
public abstract String removedSince
HttpServlet
's RemovedSince
annotation. If no value is inherited then the resource has not been removed.RemovedSince