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 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 theX-Frame-Options
header.FunctionalSchemaPolicy Defines whether or not the annotated Servlet should be available for the APEX REST-Enabled functional schema (/r) Only Servlets annotated with ELIGIBLE will return return a score other than CANNOT_DISPATCH if /r is in the request url i.e.HTTPAuthenticationScheme Describes a specific Authentication Scheme.NodeMappingPolicy Determine if aDispatchableServlet
is allowed to be bound directly to a node.PathSyntaxPolicy Determines what validation is performed on the path portion of a request URI.PreHookPolicy -
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 aServlet
with a particular plugin API.CORS DefinesCrossOriginSharingPolicy
default policy for all annotated types or packages.DeprecatedSince Denotes the version the annotated resource was deprecated in.DisabledBy Provides the means to disable aServlet
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.DispatchesFunctionalSchema DefinesFunctionalSchemaPolicy
default policy for all annotated types.Documentation Defines default documentation policy for annotated type, method or packageEnabledBy Provides the means to enable aServlet
based on specified configuration properties.FrameOptions Defines what value the resource should emit for theX-Frame-Options
headerIntroducedSince Denotes the version the annotated resource was introduced in.NodeMappingSupport DefinesNodeMappingPolicy
default policy for all annotated types.PageSize Defines the default page size for the annotated type, method or packagePathTemplate Describes the URI pattern of resources that a typeDispatches
.PreHookSupport DefinesPreHookPolicy
default policy for all annotated types.RemovedSince Denotes the version the annotated resource was removed from.RequiresPrivilege Identifies the name of a logicalPrivilege
that protects this type, method, or package.