Package ws.osiris.core

Interface Summary

Interface	Description
Auth	The authorisation strategy that should be applied to an endpoint in the API.
Auth	The authorisation strategy that should be applied to an endpoint in the API.
ComponentsProvider	Provides all the components used by the implementation of the API.
ComponentsProvider	Provides all the components used by the implementation of the API.
RequestContextFactory	Creates a class Params instance representing the request context; only used in testing.
RequestContextFactory	Creates a class Params instance representing the request context; only used in testing.

Class Summary

Class	Description
Api<T extends ComponentsProvider>	A model describing an API; it contains the routes to the API endpoints and the code executed when the API receives requests.
Api<T extends ComponentsProvider>	A model describing an API; it contains the routes to the API endpoints and the code executed when the API receives requests.
ApiBuilder<T extends ComponentsProvider>	This is an internal class that is part of the DSL implementation and should not be used by user code.
ApiBuilder<T extends ComponentsProvider>	This is an internal class that is part of the DSL implementation and should not be used by user code.
ApiKt
ApiKt
ContentType	Represents the data in a Content-Type header; includes the MIME type and an optional charset.
ContentType	Represents the data in a Content-Type header; includes the MIME type and an optional charset.
ErrorInfo	The information describing an error.
ErrorInfo	The information describing an error.
ExceptionHandler<T extends Exception>	Receives notification when an exception occurs and returns an object containing the HTTP status and message used to build the response.
ExceptionHandler<T extends Exception>	Receives notification when an exception occurs and returns an object containing the HTTP status and message used to build the response.
Filter<T extends ComponentsProvider>
Filter<T extends ComponentsProvider>
FiltersKt
FiltersKt
FixedRouteNode<T extends ComponentsProvider>	Node representing an endpoint ending with a fixed segment, e.g. /foo/bar.
FixedRouteNode<T extends ComponentsProvider>	Node representing an endpoint ending with a fixed segment, e.g. /foo/bar.
FixedSegment
FixedSegment
Headers	A map of HTTP headers that looks up values in a case-insensitive fashion (in accordance with the HTTP spec).
Headers	A map of HTTP headers that looks up values in a case-insensitive fashion (in accordance with the HTTP spec).
HttpHeaders	Standard HTTP header names.
HttpHeaders	Standard HTTP header names.
HttpKt
HttpKt
LambdaRoute<T extends ComponentsProvider>	Describes an endpoint in a REST API whose requests are handled by a lambda.
LambdaRoute<T extends ComponentsProvider>	Describes an endpoint in a REST API whose requests are handled by a lambda.
MimeTypes	Standard MIME types.
MimeTypes	Standard MIME types.
ModelKt
ModelKt
NoAuth	Authorisation strategy that allows anyone to call an endpoint in the API without authenticating.
NoAuth	Authorisation strategy that allows anyone to call an endpoint in the API without authenticating.
Params	A set of HTTP parameters provided as part of request; can represent headers, path parameters or query string parameters.
Params	A set of HTTP parameters provided as part of request; can represent headers, path parameters or query string parameters.
Request	Contains the details of an HTTP request received by the API.
Request	Contains the details of an HTTP request received by the API.
Response	The details of the HTTP response returned from the code handling a request.
Response	The details of the HTTP response returned from the code handling a request.
ResponseBuilder	Builder for building custom responses.
ResponseBuilder	Builder for building custom responses.
RootApiBuilder<T extends ComponentsProvider>
RootApiBuilder<T extends ComponentsProvider>
Route<T extends ComponentsProvider>	A route describes one endpoint in a REST API.
Route<T extends ComponentsProvider>	A route describes one endpoint in a REST API.
RouteMatch<T extends ComponentsProvider>
RouteMatch<T extends ComponentsProvider>
RouteNode<T extends ComponentsProvider>	A node in the tree of routes that make up an API.
RouteNode<T extends ComponentsProvider>	A node in the tree of routes that make up an API.
Segment	A segment in an HTTP route; a segment represents the part of a route between two slashes, for example the route /foo/bar contains two segments, one for foo and one for bar.
Segment	A segment in an HTTP route; a segment represents the part of a route between two slashes, for example the route /foo/bar contains two segments, one for foo and one for bar.
StandardFilters	The standard set of filters applied to every endpoint in an API by default.
StandardFilters	The standard set of filters applied to every endpoint in an API by default.
StaticFiles
StaticFiles
StaticFilesBuilder
StaticFilesBuilder
StaticRoute<T extends ComponentsProvider>	Describes an endpoint in a REST API that serves static files.
StaticRoute<T extends ComponentsProvider>	Describes an endpoint in a REST API that serves static files.
StaticRouteNode<T extends ComponentsProvider>	Node representing an endpoint serving static files from S3.
StaticRouteNode<T extends ComponentsProvider>	Node representing an endpoint serving static files from S3.
VariableRouteNode<T extends ComponentsProvider>	Node representing an endpoint ending with a variable segment, e.g. /foo/{bar}.
VariableRouteNode<T extends ComponentsProvider>	Node representing an endpoint ending with a variable segment, e.g. /foo/{bar}.
VariableSegment
VariableSegment

Enum Summary

Enum	Description
HttpMethod
HttpMethod

Exception Summary

Exception	Description
DataNotFoundException	Exception indicating that data could not be found at the specified location.
DataNotFoundException	Exception indicating that data could not be found at the specified location.
ForbiddenException	Exception indicating the caller is not authorised to access the resource.
ForbiddenException	Exception indicating the caller is not authorised to access the resource.
HttpException	Base class for exceptions that should be automatically mapped to HTTP status codes.
HttpException	Base class for exceptions that should be automatically mapped to HTTP status codes.