Skip navigation links
A B C D E F G H I J L M N O P R S T U V W 

A

ACCEPT - Static variable in class ws.osiris.core.HttpHeaders
 
Api<T extends ComponentsProvider> - Class in ws.osiris.core
A model describing an API; it contains the routes to the API endpoints and the code executed when the API receives requests.
Api(routes, filters, componentsClass, staticFiles) - Constructor for class ws.osiris.core.Api
A model describing an API; it contains the routes to the API endpoints and the code executed when the API receives requests.
Api.Companion - Class in ws.osiris.core
 
ApiBuilder<T extends ComponentsProvider> - Class in ws.osiris.core
This is an internal class that is part of the DSL implementation and should not be used by user code.
ApiBuilder.Companion - Class in ws.osiris.core
 
ApiKt - Class in ws.osiris.core
 
APPLICATION_JSON - Static variable in class ws.osiris.core.MimeTypes
 
APPLICATION_XHTML - Static variable in class ws.osiris.core.MimeTypes
 
APPLICATION_XML - Static variable in class ws.osiris.core.MimeTypes
 
auth(auth, body) - Method in class ws.osiris.core.ApiBuilder
 
Auth - Interface in ws.osiris.core
The authorisation strategy that should be applied to an endpoint in the API.
AUTHORIZATION - Static variable in class ws.osiris.core.HttpHeaders
 

B

build(body) - Method in class ws.osiris.core.ResponseBuilder
Builds a response from the data in this builder.
buildApi(builder) - Static method in class ws.osiris.core.ApiKt
Builds the API defined by the builder.

C

Companion - Static variable in class ws.osiris.core.Api
 
Companion - Static variable in class ws.osiris.core.ApiBuilder
 
Companion - Static variable in class ws.osiris.core.ContentType
 
Companion - Static variable in class ws.osiris.core.Filter
 
Companion - Static variable in class ws.osiris.core.Params
 
Companion - Static variable in interface ws.osiris.core.RequestContextFactory
 
Companion - Static variable in class ws.osiris.core.Response
 
Companion - Static variable in class ws.osiris.core.Route
 
Companion - Static variable in class ws.osiris.core.RouteNode
 
Companion - Static variable in class ws.osiris.core.Segment
 
component1() - Method in class ws.osiris.core.Api
The routes defined by the API.
component1() - Method in class ws.osiris.core.ContentType
The MIME type of the content.
component1() - Method in class ws.osiris.core.ErrorInfo
 
component1() - Method in class ws.osiris.core.FixedSegment
 
component1() - Method in class ws.osiris.core.Headers
 
component1() - Method in class ws.osiris.core.LambdaRoute
 
component1() - Method in class ws.osiris.core.Request
 
component1() - Method in class ws.osiris.core.Response
 
component1() - Method in class ws.osiris.core.RouteMatch
 
component1() - Method in class ws.osiris.core.StaticFiles
 
component1() - Method in class ws.osiris.core.StaticRoute
 
component1() - Method in class ws.osiris.core.VariableSegment
 
component2() - Method in class ws.osiris.core.Api
Filters applied to requests before they are passed to a handler.
component2() - Method in class ws.osiris.core.ContentType
The charset of the content.
component2() - Method in class ws.osiris.core.ErrorInfo
 
component2() - Method in class ws.osiris.core.LambdaRoute
 
component2() - Method in class ws.osiris.core.Request
 
component2() - Method in class ws.osiris.core.Response
 
component2() - Method in class ws.osiris.core.RouteMatch
 
component2() - Method in class ws.osiris.core.StaticFiles
 
component2() - Method in class ws.osiris.core.StaticRoute
 
component3() - Method in class ws.osiris.core.Api
The type of the object available to the code in the API definition that handles the HTTP requests.
component3() - Method in class ws.osiris.core.LambdaRoute
 
component3() - Method in class ws.osiris.core.Request
 
component3() - Method in class ws.osiris.core.Response
 
component3() - Method in class ws.osiris.core.StaticFiles
 
component3() - Method in class ws.osiris.core.StaticRoute
 
component4() - Method in class ws.osiris.core.Api
True if this API serves static files.
component4() - Method in class ws.osiris.core.LambdaRoute
 
component4() - Method in class ws.osiris.core.Request
 
component5() - Method in class ws.osiris.core.Request
 
component6() - Method in class ws.osiris.core.Request
 
component7() - Method in class ws.osiris.core.Request
 
component8() - Method in class ws.osiris.core.Request
 
ComponentsProvider - Interface in ws.osiris.core
Provides all the components used by the implementation of the API.
CONTENT_LENGTH - Static variable in class ws.osiris.core.HttpHeaders
 
CONTENT_TYPE - Static variable in class ws.osiris.core.HttpHeaders
 
ContentType - Class in ws.osiris.core
Represents the data in a Content-Type header; includes the MIME type and an optional charset.
ContentType(mimeType, charset) - Constructor for class ws.osiris.core.ContentType
Represents the data in a Content-Type header; includes the MIME type and an optional charset.
ContentType(mimeType) - Constructor for class ws.osiris.core.ContentType
Creates an instance with the specified MIME type and not charset.
ContentType.Companion - Class in ws.osiris.core
 
copy(routes, filters, componentsClass, staticFiles) - Method in class ws.osiris.core.Api
A model describing an API; it contains the routes to the API endpoints and the code executed when the API receives requests.
copy(mimeType, charset) - Method in class ws.osiris.core.ContentType
Represents the data in a Content-Type header; includes the MIME type and an optional charset.
copy(status, message) - Method in class ws.osiris.core.ErrorInfo
The information describing an error.
copy(pathPart) - Method in class ws.osiris.core.FixedSegment
 
copy(headerMap) - Method in class ws.osiris.core.Headers
A map of HTTP headers that looks up values in a case-insensitive fashion (in accordance with the HTTP spec).
copy(method, path, handler, auth) - Method in class ws.osiris.core.LambdaRoute
Describes an endpoint in a REST API whose requests are handled by a lambda.
copy(method, path, headers, queryParams, pathParams, context, body, attributes, defaultResponseHeaders) - Method in class ws.osiris.core.Request
Contains the details of an HTTP request received by the API.
copy(status, headers, body) - Method in class ws.osiris.core.Response
The details of the HTTP response returned from the code handling a request.
copy(handler, vars) - Method in class ws.osiris.core.RouteMatch
 
copy(path, indexFile, auth) - Method in class ws.osiris.core.StaticFiles
 
copy(path, indexFile, auth) - Method in class ws.osiris.core.StaticRoute
Describes an endpoint in a REST API that serves static files.
copy(variableName) - Method in class ws.osiris.core.VariableSegment
 
create(api) - Method in class ws.osiris.core.RouteNode.Companion
Creates a tree of RouteNode instances representing the routes in the API.
create(pathPart) - Method in class ws.osiris.core.Segment.Companion
 
create() - Method in class ws.osiris.core.StandardFilters
 
createContext(httpMethod, path, headers, queryParams, pathParams, body) - Method in interface ws.osiris.core.RequestContextFactory
 

D

DataNotFoundException - Exception in ws.osiris.core
Exception indicating that data could not be found at the specified location.
DataNotFoundException(message) - Constructor for exception ws.osiris.core.DataNotFoundException
Exception indicating that data could not be found at the specified location.
DataNotFoundException() - Constructor for exception ws.osiris.core.DataNotFoundException
Exception indicating that data could not be found at the specified location.
defaultContentTypeFilter(contentType) - Static method in class ws.osiris.core.FiltersKt
Filter that sets the default content type of the response.
defaultExceptionMappingFilter() - Static method in class ws.osiris.core.FiltersKt
Returns a filter that catches any exceptions thrown by the handler and builds a response containing the error status and message.
defineFilter(handler) - Static method in class ws.osiris.core.FiltersKt
Creates a filter that is applied to all endpoints.
delete(path, handler) - Method in class ws.osiris.core.ApiBuilder
Defines an endpoint that handles DELETE requests to the path.
DeployMojo - Class in ws.osiris.maven
Mojo defining the deployment goal; deploys an API and lambda function to AWS.
DeployMojo() - Constructor for class ws.osiris.maven.DeployMojo
Mojo defining the deployment goal; deploys an API and lambda function to AWS.

E

empty() - Method in class ws.osiris.core.RequestContextFactory.Companion
Returns a factory that returns an empty context; used by default if no other factory is provided.
equals(p) - Method in class ws.osiris.core.Api
 
equals(p) - Method in class ws.osiris.core.ContentType
 
equals(p) - Method in class ws.osiris.core.ErrorInfo
 
equals(p) - Method in class ws.osiris.core.FixedSegment
 
equals(p) - Method in class ws.osiris.core.Headers
 
equals(p) - Method in class ws.osiris.core.LambdaRoute
 
equals(p) - Method in class ws.osiris.core.Request
 
equals(p) - Method in class ws.osiris.core.Response
 
equals(p) - Method in class ws.osiris.core.RouteMatch
 
equals(p) - Method in class ws.osiris.core.StaticFiles
 
equals(p) - Method in class ws.osiris.core.StaticRoute
 
equals(p) - Method in class ws.osiris.core.VariableSegment
 
ErrorInfo - Class in ws.osiris.core
The information describing an error.
ErrorInfo(status, message) - Constructor for class ws.osiris.core.ErrorInfo
The information describing an error.
ExceptionHandler<T extends Exception> - Class in ws.osiris.core
Receives notification when an exception occurs and returns an object containing the HTTP status and message used to build the response.
ExceptionHandler(exceptionType, handlerFn) - Constructor for class ws.osiris.core.ExceptionHandler
Receives notification when an exception occurs and returns an object containing the HTTP status and message used to build the response.
exceptionMappingFilter(exceptionHandlers) - Static method in class ws.osiris.core.FiltersKt
Returns a filter that catches any exceptions thrown by the handler and builds a response containing the error status and message.
execute() - Method in class ws.osiris.maven.DeployMojo
 
execute() - Method in class ws.osiris.maven.GenerateCloudFormationMojo
 

F

filter(path, handler) - Method in class ws.osiris.core.ApiBuilder
 
filter(handler) - Method in class ws.osiris.core.ApiBuilder
 
Filter<T extends ComponentsProvider> - Class in ws.osiris.core
 
Filter.Companion - Class in ws.osiris.core
 
FiltersKt - Class in ws.osiris.core
 
fixed(values) - Method in class ws.osiris.core.RequestContextFactory.Companion
Returns a factory that returns the same context every time, built from values.
FixedRouteNode<T extends ComponentsProvider> - Class in ws.osiris.core
Node representing an endpoint ending with a fixed segment, e.g. /foo/bar.
FixedRouteNode(name, handlers, fixedChildren, variableChild) - Constructor for class ws.osiris.core.FixedRouteNode
Node representing an endpoint ending with a fixed segment, e.g. /foo/bar.
FixedSegment - Class in ws.osiris.core
 
FixedSegment(pathPart) - Constructor for class ws.osiris.core.FixedSegment
 
ForbiddenException - Exception in ws.osiris.core
Exception indicating the caller is not authorised to access the resource.
ForbiddenException(message) - Constructor for exception ws.osiris.core.ForbiddenException
Exception indicating the caller is not authorised to access the resource.
ForbiddenException() - Constructor for exception ws.osiris.core.ForbiddenException
Exception indicating the caller is not authorised to access the resource.
fromQueryString(queryString) - Method in class ws.osiris.core.Params.Companion
Creates a set of parameters by parsing an HTTP query string.

G

GenerateCloudFormationMojo - Class in ws.osiris.maven
Mojo defining a goal to generate a CloudFormation template using the API definition and additional configuration.
GenerateCloudFormationMojo() - Constructor for class ws.osiris.maven.GenerateCloudFormationMojo
Mojo defining a goal to generate a CloudFormation template using the API definition and additional configuration.
get(path, handler) - Method in class ws.osiris.core.ApiBuilder
Defines an endpoint that handles GET requests to the path.
get(header) - Method in class ws.osiris.core.Headers
Returns the value for the specified header; lookup is case-insensitive in accordance with the HTTP spec.
get(name) - Method in class ws.osiris.core.Params
Returns the named parameter or throws IllegalArgumentException if there is no parameter with the name.
getAttributes() - Method in class ws.osiris.core.Request
 
getAuth() - Method in class ws.osiris.core.LambdaRoute
 
getAuth() - Method in class ws.osiris.core.Route
 
getAuth() - Method in class ws.osiris.core.StaticFiles
 
getAuth() - Method in class ws.osiris.core.StaticRoute
 
getAuth() - Method in class ws.osiris.core.StaticRouteNode
 
getAwsProfile() - Method in class ws.osiris.maven.MavenDeployableProject
 
getAwsProfile() - Method in class ws.osiris.maven.OsirisMojo
 
getBody() - Method in class ws.osiris.core.Request
 
getBody() - Method in class ws.osiris.core.Response
 
getBuildDir() - Method in class ws.osiris.maven.MavenDeployableProject
 
getCharset() - Method in class ws.osiris.core.ContentType
The charset of the content.
getComponentsClass() - Method in class ws.osiris.core.Api
The type of the object available to the code in the API definition that handles the HTTP requests.
getContext() - Method in class ws.osiris.core.Request
 
getEnvironmentName() - Method in class ws.osiris.maven.MavenDeployableProject
 
getEnvironmentName() - Method in class ws.osiris.maven.OsirisMojo
 
getFilters() - Method in class ws.osiris.core.Api
Filters applied to requests before they are passed to a handler.
getFixedChildren() - Method in class ws.osiris.core.RouteNode
The fixed node children of this node,
getGlobalFilters() - Method in class ws.osiris.core.RootApiBuilder
 
getHandler() - Method in class ws.osiris.core.Filter
 
getHandler() - Method in class ws.osiris.core.LambdaRoute
 
getHandler() - Method in class ws.osiris.core.RouteMatch
 
getHandlers() - Method in class ws.osiris.core.RouteNode
Handlers
getHeader() - Method in class ws.osiris.core.ContentType
The string representation of this content type used in a Content-Type header.
getHeaderMap() - Method in class ws.osiris.core.Headers
 
getHeaders() - Method in class ws.osiris.core.Request
 
getHeaders() - Method in class ws.osiris.core.Response
 
getHeaders() - Method in class ws.osiris.core.ResponseBuilder
 
getHttpStatus() - Method in exception ws.osiris.core.HttpException
 
getIndexFile() - Method in class ws.osiris.core.StaticFiles
 
getIndexFile() - Method in class ws.osiris.core.StaticFilesBuilder
 
getIndexFile() - Method in class ws.osiris.core.StaticRoute
 
getIndexFile() - Method in class ws.osiris.core.StaticRouteNode
 
getJarBuildDir() - Method in class ws.osiris.maven.MavenDeployableProject
 
getJSON_CONTENT_TYPE() - Static method in class ws.osiris.core.HttpKt
The default content type in API Gateway; everything is assumed to return JSON unless it states otherwise.
getLog() - Static method in class ws.osiris.core.FiltersKt
 
getMessage() - Method in class ws.osiris.core.ErrorInfo
 
getMethod() - Method in class ws.osiris.core.LambdaRoute
 
getMethod() - Method in class ws.osiris.core.Request
 
getMimeType() - Method in class ws.osiris.core.ContentType
The MIME type of the content.
getName() - Method in interface ws.osiris.core.Auth
The name of the authorisation strategy.
getName() - Method in class ws.osiris.core.NoAuth
The name of the authorisation strategy.
getName() - Method in class ws.osiris.core.RouteNode
The name of the node;
getName() - Method in class ws.osiris.maven.MavenDeployableProject
 
getParams() - Method in class ws.osiris.core.Params
 
getPath() - Method in class ws.osiris.core.LambdaRoute
 
getPath() - Method in class ws.osiris.core.Request
 
getPath() - Method in class ws.osiris.core.Route
 
getPath() - Method in class ws.osiris.core.StaticFiles
 
getPath() - Method in class ws.osiris.core.StaticFilesBuilder
 
getPath() - Method in class ws.osiris.core.StaticRoute
 
getPathParams() - Method in class ws.osiris.core.Request
 
getPathPart() - Method in class ws.osiris.core.FixedSegment
 
getProject() - Method in class ws.osiris.maven.OsirisMojo
 
getQueryParams() - Method in class ws.osiris.core.Request
 
getRootPackage() - Method in class ws.osiris.maven.MavenDeployableProject
 
getRootPackage() - Method in class ws.osiris.maven.OsirisMojo
 
getRoutes() - Method in class ws.osiris.core.Api
The routes defined by the API.
getSourceDir() - Method in class ws.osiris.maven.MavenDeployableProject
 
getStaticFiles() - Method in class ws.osiris.core.Api
True if this API serves static files.
getStaticFilesDirectory() - Method in class ws.osiris.maven.MavenDeployableProject
 
getStaticFilesDirectory() - Method in class ws.osiris.maven.OsirisMojo
 
getStatus() - Method in class ws.osiris.core.ErrorInfo
 
getStatus() - Method in class ws.osiris.core.Response
 
getVariableChild() - Method in class ws.osiris.core.RouteNode
The variable node that is a child of this node;
getVariableName() - Method in class ws.osiris.core.VariableSegment
 
getVars() - Method in class ws.osiris.core.RouteMatch
 
getVersion() - Method in class ws.osiris.maven.MavenDeployableProject
 

H

handle(exception) - Method in class ws.osiris.core.ExceptionHandler
 
hashCode() - Method in class ws.osiris.core.Api
 
hashCode() - Method in class ws.osiris.core.ContentType
 
hashCode() - Method in class ws.osiris.core.ErrorInfo
 
hashCode() - Method in class ws.osiris.core.FixedSegment
 
hashCode() - Method in class ws.osiris.core.Headers
 
hashCode() - Method in class ws.osiris.core.LambdaRoute
 
hashCode() - Method in class ws.osiris.core.Request
 
hashCode() - Method in class ws.osiris.core.Response
 
hashCode() - Method in class ws.osiris.core.RouteMatch
 
hashCode() - Method in class ws.osiris.core.StaticFiles
 
hashCode() - Method in class ws.osiris.core.StaticRoute
 
hashCode() - Method in class ws.osiris.core.VariableSegment
 
header(name, value) - Method in class ws.osiris.core.ResponseBuilder
Sets the value of the named header and returns this builder.
Headers - Class in ws.osiris.core
A map of HTTP headers that looks up values in a case-insensitive fashion (in accordance with the HTTP spec).
Headers(headerMap) - Constructor for class ws.osiris.core.Headers
A map of HTTP headers that looks up values in a case-insensitive fashion (in accordance with the HTTP spec).
Headers() - Constructor for class ws.osiris.core.Headers
A map of HTTP headers that looks up values in a case-insensitive fashion (in accordance with the HTTP spec).
Headers(headers) - Constructor for class ws.osiris.core.Headers
 
HttpException - Exception in ws.osiris.core
Base class for exceptions that should be automatically mapped to HTTP status codes.
HttpException(httpStatus, message) - Constructor for exception ws.osiris.core.HttpException
Base class for exceptions that should be automatically mapped to HTTP status codes.
HttpHeaders - Class in ws.osiris.core
Standard HTTP header names.
HttpKt - Class in ws.osiris.core
 
HttpMethod - Enum in ws.osiris.core
 
HttpMethod() - Constructor for enum ws.osiris.core.HttpMethod
 

I

INSTANCE - Static variable in class ws.osiris.core.HttpHeaders
Standard HTTP header names.
INSTANCE - Static variable in class ws.osiris.core.MimeTypes
Standard MIME types.
INSTANCE - Static variable in class ws.osiris.core.NoAuth
Authorisation strategy that allows anyone to call an endpoint in the API without authenticating.
INSTANCE - Static variable in class ws.osiris.core.StandardFilters
The standard set of filters applied to every endpoint in an API by default.

J

jsonSerialisingFilter() - Static method in class ws.osiris.core.FiltersKt
Filter that serialises the response body to JSON so it can be written to the response.

L

LambdaRoute<T extends ComponentsProvider> - Class in ws.osiris.core
Describes an endpoint in a REST API whose requests are handled by a lambda.
LambdaRoute(method, path, handler, auth) - Constructor for class ws.osiris.core.LambdaRoute
Describes an endpoint in a REST API whose requests are handled by a lambda.
LOCATION - Static variable in class ws.osiris.core.HttpHeaders
 

M

match($receiver, method, path) - Static method in class ws.osiris.core.ModelKt
 
MavenDeployableProject - Class in ws.osiris.maven
 
MavenDeployableProject(rootPackage, environmentName, staticFilesDirectory, awsProfile, project) - Constructor for class ws.osiris.maven.MavenDeployableProject
 
MimeTypes - Class in ws.osiris.core
Standard MIME types.
minus(name) - Method in class ws.osiris.core.Params
Returns copy of these parameters with the named parameter removed.
ModelKt - Class in ws.osiris.core
 

N

NoAuth - Class in ws.osiris.core
Authorisation strategy that allows anyone to call an endpoint in the API without authenticating.

O

optional(name) - Method in class ws.osiris.core.Params
Returns the named parameter.
options(path, handler) - Method in class ws.osiris.core.ApiBuilder
Defines an endpoint that handles OPTIONS requests to the path.
OsirisMojo - Class in ws.osiris.maven
Parent of the Osiris Mojo classes; contains common configuration parameters used by all subclasses.
OsirisMojo() - Constructor for class ws.osiris.maven.OsirisMojo
Parent of the Osiris Mojo classes; contains common configuration parameters used by all subclasses.

P

Params - Class in ws.osiris.core
A set of HTTP parameters provided as part of request; can represent headers, path parameters or query string parameters.
Params(params) - Constructor for class ws.osiris.core.Params
A set of HTTP parameters provided as part of request; can represent headers, path parameters or query string parameters.
Params() - Constructor for class ws.osiris.core.Params
 
Params.Companion - Class in ws.osiris.core
 
parse(header) - Method in class ws.osiris.core.ContentType.Companion
Parses a Content-Type header into a class ContentType instance.
patch(path, handler) - Method in class ws.osiris.core.ApiBuilder
Defines an endpoint that handles PATCH requests to the path.
path(path, body) - Method in class ws.osiris.core.ApiBuilder
 
plus(headerValue) - Method in class ws.osiris.core.Headers
Returns a copy of these headers with a new header added.
plus(other) - Method in class ws.osiris.core.Headers
Returns a copy of these headers with new headers added.
plus(other) - Method in class ws.osiris.core.Headers
Returns a copy of these headers with new headers added.
plus(nameValue) - Method in class ws.osiris.core.Params
Returns copy of these parameters with the value added.
post(path, handler) - Method in class ws.osiris.core.ApiBuilder
Defines an endpoint that handles POST requests to the path.
prettyPrint($receiver) - Static method in class ws.osiris.core.ModelKt
Returns a pretty-printed string showing the node and its children in a tree structure.
put(path, handler) - Method in class ws.osiris.core.ApiBuilder
Defines an endpoint that handles PUT requests to the path.

R

Request - Class in ws.osiris.core
Contains the details of an HTTP request received by the API.
Request(method, path, headers, queryParams, pathParams, context, body, attributes) - Constructor for class ws.osiris.core.Request
Contains the details of an HTTP request received by the API.
RequestContextFactory - Interface in ws.osiris.core
Creates a class Params instance representing the request context; only used in testing.
RequestContextFactory.Companion - Class in ws.osiris.core
 
requireBinaryBody() - Method in class ws.osiris.core.Request
Returns the body as a byte array or throws IllegalArgumentException if there is no body or it isn't binary.
requireBody() - Method in class ws.osiris.core.Request
Returns the body or throws IllegalArgumentException if it is null.
requireBody(expectedType) - Method in class ws.osiris.core.Request
Returns the body or throws IllegalArgumentException if it is null or not of the expected type.
Response - Class in ws.osiris.core
The details of the HTTP response returned from the code handling a request.
Response.Companion - Class in ws.osiris.core
 
responseBuilder() - Method in class ws.osiris.core.Request
Returns a builder for building a response.
ResponseBuilder - Class in ws.osiris.core
Builder for building custom responses.
RootApiBuilder<T extends ComponentsProvider> - Class in ws.osiris.core
 
RootApiBuilder(componentsType) - Constructor for class ws.osiris.core.RootApiBuilder
 
rootPackage - Variable in class ws.osiris.maven.OsirisMojo
 
Route<T extends ComponentsProvider> - Class in ws.osiris.core
A route describes one endpoint in a REST API.
Route.Companion - Class in ws.osiris.core
 
RouteMatch<T extends ComponentsProvider> - Class in ws.osiris.core
 
RouteMatch(handler, vars) - Constructor for class ws.osiris.core.RouteMatch
 
RouteNode<T extends ComponentsProvider> - Class in ws.osiris.core
A node in the tree of routes that make up an API.
RouteNode.Companion - Class in ws.osiris.core
 

S

Segment - Class in ws.osiris.core
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.Companion - Class in ws.osiris.core
 
setAwsProfile(p) - Method in class ws.osiris.maven.OsirisMojo
 
setEnvironmentName(p) - Method in class ws.osiris.maven.OsirisMojo
 
setGlobalFilters(p) - Method in class ws.osiris.core.RootApiBuilder
 
setIndexFile(p) - Method in class ws.osiris.core.StaticFilesBuilder
 
setPath(p) - Method in class ws.osiris.core.StaticFilesBuilder
 
setRootPackage(p) - Method in class ws.osiris.maven.OsirisMojo
 
setStaticFilesDirectory(p) - Method in class ws.osiris.maven.OsirisMojo
 
StandardFilters - Class in ws.osiris.core
The standard set of filters applied to every endpoint in an API by default.
staticFiles(body) - Method in class ws.osiris.core.ApiBuilder
 
StaticFiles - Class in ws.osiris.core
 
StaticFilesBuilder - Class in ws.osiris.core
 
StaticFilesBuilder(prefix, auth) - Constructor for class ws.osiris.core.StaticFilesBuilder
 
StaticRoute<T extends ComponentsProvider> - Class in ws.osiris.core
Describes an endpoint in a REST API that serves static files.
StaticRoute(path, indexFile, auth) - Constructor for class ws.osiris.core.StaticRoute
Describes an endpoint in a REST API that serves static files.
StaticRouteNode<T extends ComponentsProvider> - Class in ws.osiris.core
Node representing an endpoint serving static files from S3.
StaticRouteNode(name, fixedChildren, auth, indexFile) - Constructor for class ws.osiris.core.StaticRouteNode
Node representing an endpoint serving static files from S3.
status(status) - Method in class ws.osiris.core.ResponseBuilder
Sets the status code of the response and returns this builder.

T

TEXT_HTML - Static variable in class ws.osiris.core.MimeTypes
 
TEXT_PLAIN - Static variable in class ws.osiris.core.MimeTypes
 
toString() - Method in class ws.osiris.core.Api
 
toString() - Method in class ws.osiris.core.ContentType
 
toString() - Method in class ws.osiris.core.ErrorInfo
 
toString() - Method in class ws.osiris.core.FixedSegment
 
toString() - Method in class ws.osiris.core.Headers
 
toString() - Method in class ws.osiris.core.LambdaRoute
 
toString() - Method in class ws.osiris.core.Request
 
toString() - Method in class ws.osiris.core.Response
 
toString() - Method in class ws.osiris.core.RouteMatch
 
toString() - Method in class ws.osiris.core.StaticFiles
 
toString() - Method in class ws.osiris.core.StaticRoute
 
toString() - Method in class ws.osiris.core.VariableSegment
 

U

update(path, handler) - Method in class ws.osiris.core.ApiBuilder
Defines an endpoint that handles UPDATE requests to the path.

V

VariableRouteNode<T extends ComponentsProvider> - Class in ws.osiris.core
Node representing an endpoint ending with a variable segment, e.g. /foo/{bar}.
VariableRouteNode(name, handlers, fixedChildren, variableChild) - Constructor for class ws.osiris.core.VariableRouteNode
Node representing an endpoint ending with a variable segment, e.g. /foo/{bar}.
VariableSegment - Class in ws.osiris.core
 
VariableSegment(variableName) - Constructor for class ws.osiris.core.VariableSegment
 

W

withAttribute(name, value) - Method in class ws.osiris.core.Request
Returns a copy of this request with the value added to its attributes, keyed by the name.
withHeader(header, value) - Method in class ws.osiris.core.Headers
Returns a copy of these headers with a new header added.
withHeader(header, value) - Method in class ws.osiris.core.Response
Returns a copy of these headers with a new header added.
withHeaders(headers) - Method in class ws.osiris.core.Headers
Returns a copy of these headers with new headers added.
withHeaders(headerValue) - Method in class ws.osiris.core.Response
Returns a copy of these headers with new headers added.
withHeaders(headersMap) - Method in class ws.osiris.core.Response
Returns a copy of these headers with new headers added.
withHeaders(headers) - Method in class ws.osiris.core.Response
Returns a copy of these headers with new headers added.
ws.osiris.core - package ws.osiris.core
 
ws.osiris.maven - package ws.osiris.maven
 
A B C D E F G H I J L M N O P R S T U V W 
Skip navigation links