oracle.dbtools.plugin.api.http.annotations

Annotation Type PathTemplate

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
public @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

Field Summary

Fields

Modifier and Type	Fields and Description
static int	DEFAULT_PRIORITY Default priority value

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The Route pattern

Optional Element Summary

Optional Elements

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
CrossOriginSharingPolicy	cors Identifies if the resource can be accessed via CORS or not.
DocumentationPolicy	documentation Describes how this resource is documented.
FramePolicy	frameOptions Defines if the resource can be framed
String[]	methods Optionally specify the HTTP methods that this pattern can dispatch
String	name Optionally assign a mnemonic name to the path template
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	requiresPrivilege Identifies the name of the Privilege that protects this URI pattern
TransportPolicy	transport Describes the transport level security requirements for this URI pattern

Field Detail

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

Default priority value

Element Detail

value

public abstract String value

The Route pattern

Returns:

Route Pattern

accepts

public abstract String[] accepts

Enumerates 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

public abstract CrossOriginSharingPolicy cors

Identifies if the resource can be accessed via CORS or not. Note the default is CrossOriginSharingPolicy.ALLOW.

Returns:

The CrossOriginSharingPolicy

Default:

oracle.dbtools.plugin.api.http.annotations.CrossOriginSharingPolicy.INHERIT

allowedOrigins

public abstract String[] allowedOrigins

The set of Web Origins that can access this resource via CORS

Returns:

Array of Web Origins

Default:

{}

documentation

public abstract DocumentationPolicy documentation

Describes how this resource is documented.

Returns:

DocumentationPolicy instance

Default:

oracle.dbtools.plugin.api.http.annotations.DocumentationPolicy.AUTHORIZED

pathValidation

public abstract PathSyntaxPolicy pathValidation

Describes how path portion of the request URI should be validated.

Returns:

PathSyntaxPolicy instance

Default:

oracle.dbtools.plugin.api.http.annotations.PathSyntaxPolicy.CHECK

frameOptions

public abstract FramePolicy frameOptions

Defines if the resource can be framed

Returns:

FramePolicy instance

Default:

oracle.dbtools.plugin.api.http.annotations.FramePolicy.SAME_ORIGIN

methods

public abstract String[] methods

Optionally specify the HTTP methods that this pattern can dispatch

Returns:

supported HTTP methods

Default:

{}

name

public abstract String name

Optionally assign a mnemonic name to the path template

Returns:

mnemonic that uniquely identifies this PathTemplate

See Also:

PathTemplateMatch.name()

Default:

""

pageSize

public abstract int pageSize

For resources that may be paginated indicates the number of items to display per page.

Returns:

number of items per page

Default:

-1

pagination

public abstract PaginationStrategy pagination

Describes how a resource is paginated.

Returns:

PaginationStrategy instance

Default:

oracle.dbtools.plugin.api.pagination.PaginationStrategy.NONE

requiresPrivilege

public abstract String requiresPrivilege

Identifies the name of the Privilege that protects this URI pattern

Returns:

privilege name

Default:

""

transport

public abstract TransportPolicy transport

Describes the transport level security requirements for this URI pattern

Returns:

TransportPolicy instance

Default:

oracle.dbtools.plugin.api.security.annotations.TransportPolicy.ANY