# Package oracle.dbtools.plugin.api.http.annotations

Annotations to describe what URL patterns and HTTP methods a `HttpServlet` support.

The annotations in this package provide capabilities analagous to those provided by the `web.xml` in a conventional JEE web application. In contrast to `web.xml` these annotations facilitate the discovery of what URL patterns are available at run-time.

Author:
  cdivilly
See Also:
  `Dispatches`

- Enum Summary
  Enum | Description
  --- | ---
  CrossOriginSharingPolicy | About Cross Origin Requests
  DocumentationPolicy | Describes how a resource should be documented.
  EnabledBy.Condition |
  FramePolicy | Defines how this resource wishes to restrict user-agents from framing the resource in a <frame> or <iframe> via the `X-Frame-Options` header.
  HTTPAuthenticationScheme | Describes a specific Authentication Scheme.
  PathSyntaxPolicy | Determines what validation is performed on the path portion of a request URI.

- Annotation Types Summary
  Annotation Type | Description
  --- | ---
  Accepts | Defines the range of media-types that can be accepted by a resource for an update operation (e.g.
  BelongsTo | Provides the means to associate a `Servlet` with a particular plugin API.
  CORS | Defines `CrossOriginSharingPolicy` default policy for all annotated types or packages.
  DeprecatedSince | Denotes the version the annotated resource was deprecated in.
  DisabledBy | Provides the means to disable a `Servlet` based on specified configuration properties.
  Dispatches | Annotation that should be applied to sub-types of HttpServlet to describe the URI patterns that the servlet can dispatch.
  Documentation | Defines default documentation policy for annotated type, method or package
  EnabledBy | Provides the means to enable a `Servlet` based on specified configuration properties.
  FrameOptions | Defines what value the resource should emit for the `X-Frame-Options` header
  IntroducedSince | Denotes the version the annotated resource was introduced in.
  PageSize | Defines the default page size for the annotated type, method or package
  PathTemplate | Describes the URI pattern of resources that a type `Dispatches`.
  RemovedSince | Denotes the version the annotated resource was removed from.
  RequiresPrivilege | Identifies the name of a logical `Privilege` that protects this type, method, or package.