| Interface | Description |
|---|---|
| Api.ApiListener |
Listener that can be registered with an
Api to receive lifecycle,
per request and per error callback notifications. |
| ApiClient.RequestListener | |
| Engine.EngineListener |
Receives
Engine and Api lifecycle,
per request and per error callback notifications. |
| Headers | |
| Status |
Static constants for HTTP status codes.
|
| Uploader |
Implemented by different runtimes, for example a servlet vs a lambda, to enable different file upload mechanisms.
|
| Class | Description |
|---|---|
| Action<A extends Action> |
Actions perform some work when matched to a Request and potentially contribute to the content of the Response.
|
| Api |
Contains the Servers, Dbs, Collections, Endpoints and Actions that make up a REST API.
|
| ApiClient |
An HttpClient wrapper designed specifically to run inside of an Inversion Request Chain with some extra superpowers.
|
| ApiClient.Executor |
An asynchronous thread pool task runner.
|
| Chain | |
| Chain.ActionMatch | |
| Change | |
| Collection |
Represents a REST Collection and maps JSON properties property names and logical cross Collection data relationships to underlying Db tables and column names.
|
| Db<T extends Db> |
An adapter to an underlying data source.
|
| Endpoint |
A single Endpoint, bundling one or more Path match relative Actions, is selected to service a Request.
|
| Engine |
Matches inbound Request Url paths to an Api Endpoint and executes associated Actions.
|
| EngineServlet | |
| Filter<A extends Filter> | |
| Index | |
| Linker | |
| Op | |
| Param | |
| Projection | |
| Property | |
| Relationship | |
| Request | |
| Response |
This class serves as holder for the Response returned from a RestClient call AND as the object
used to construct your own response to an Engine request.
|
| Results<M extends java.util.Map<java.lang.String,?>> |
Results are returned by a Db and transformed by Actions into Response content.
|
| Rule<R extends Rule> |
Matches against an HTTP method and URL path to determine if the object
should be included when processing the associated Request.
|
| Rule.RuleMatcher | |
| Server | |
| Server.ServerMatcher | |
| Upload | |
| Url |
Utility class for parsing and working with HTTP(S) URLs.
|
| User | |
| Validation |
Utility designed to make it easy to validate request properties or request body
json values while you are retrieving them.
|
| Enum | Description |
|---|---|
| Op.OpFunction | |
| Param.In |
| Exception | Description |
|---|---|
| ApiException |
Copyright © 2023 Rocket Partners, LLC. All rights reserved.