This document describes how to develop and deploy plugins that integrate with Oracle REST Data Services (ORDS).
Getting Started
To get started, please consult the Getting Started guide.
Developer Guide
For a more detailed reference, please consult the Developer Guide
Route Patterns
The syntax used by @PathTemplate to determine what set of URLs a Servlet dispatches is defined in the Route Patterns Specification.
| Package | Description |
|---|---|
| oracle.dbtools.plugin.api |
Enumerates the
ExtensionPoints that plugins can extend. |
| oracle.dbtools.plugin.api.cmdline |
Extension point for plugins that contribute command line commands.
|
| oracle.dbtools.plugin.api.cmdline.annotations |
Annotations to express the arguments and options of a
CommandProvider. |
| oracle.dbtools.plugin.api.collections |
Provides the
MultiMap collection type. |
| oracle.dbtools.plugin.api.conf |
Services for defining and introspecting Configuration Settings
|
| oracle.dbtools.plugin.api.di |
A
javax.inject compatible Dependency Injection (D.I.) framework. |
| oracle.dbtools.plugin.api.di.annotations |
Annotations used to make types discoverable by the dependency injection (D.I.) framework.
|
| oracle.dbtools.plugin.api.errors | |
| oracle.dbtools.plugin.api.http.annotations |
Annotations to describe what URL patterns and HTTP methods a
HttpServlet support. |
| oracle.dbtools.plugin.api.i18n |
Internationaliztion APIs for plugins.
|
| oracle.dbtools.plugin.api.i18n.annotations |
Internationalization Annotations
|
| oracle.dbtools.plugin.api.io |
Services for manipulating input and output streams
|
| oracle.dbtools.plugin.api.jdbc | |
| oracle.dbtools.plugin.api.json |
JavaScript Object Notation (JSON) APIs for reading and writing JSON character streams.
|
| oracle.dbtools.plugin.api.json.objects |
API for creating in memory representations of JSON object graphs (
JSONObjects) and for serializing object graphs to JSON representations. |
| oracle.dbtools.plugin.api.logging |
Provides a logging service.
|
| oracle.dbtools.plugin.api.pagination |
Provides facilities for consistent handling of
Pagination |
| oracle.dbtools.plugin.api.routes |
PathTemplateMatch services |
| oracle.dbtools.plugin.api.security |
Resource authorization APIs
|
| oracle.dbtools.plugin.api.security.annotations |
Annotations describing the security constraints of a service.
|
| oracle.dbtools.plugin.api.servlet |
Extensions to the Servlet API.
|
| oracle.dbtools.plugin.api.types |
Provides a layer atop
java.lang.reflect package to aid dependency resolution and injection. |