A B C D E F G H I L M N P R S T U V
All Classes All Packages

A

accessControlAllowCredentials() - Method in annotation type io.rxmicro.rest.server.feature.EnableCrossOriginResourceSharing

Allows or denies the credentials.

accessControlMaxAge() - Method in annotation type io.rxmicro.rest.server.feature.EnableCrossOriginResourceSharing

Defines access control max age.

addHeader(String, Object) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Adds the HTTP header with the specified name and value to the HTTP response generated by HTTP server.

addHeader(String, String) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Adds the HTTP header with the specified name and value to the HTTP response generated by HTTP server.

addHeader(String, BigDecimal) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Adds the HTTP header with the specified name and value to the HTTP response generated by HTTP server.

addHeader(String, List<?>) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Adds the HTTP header with the specified name and value to the HTTP response generated by HTTP server.

addStaticResponseHeader(StaticResponseHeader) - Method in class io.rxmicro.rest.server.RestServerConfig

Allows customizing static HTTP response headers for all HTTP request handlers.

allowOrigins() - Method in annotation type io.rxmicro.rest.server.feature.EnableCrossOriginResourceSharing

Defines allows origins.

B

build(HttpResponseBuilder, int, String) - Method in interface io.rxmicro.rest.server.local.component.HttpErrorResponseBodyBuilder

build(HttpResponseBuilder, HttpErrorException) - Method in interface io.rxmicro.rest.server.local.component.HttpErrorResponseBodyBuilder

build(HttpResponseBuilder, HttpCallFailedException) - Method in interface io.rxmicro.rest.server.local.component.HttpErrorResponseBodyBuilder

C

clear() - Method in interface io.rxmicro.rest.server.local.component.DynamicRestControllerRegistrar

createFilter(Class<?>) - Static method in interface io.rxmicro.rest.server.local.model.RestControllerRegistrationFilter

createFilter(Class<?>, Class<?>...) - Static method in interface io.rxmicro.rest.server.local.model.RestControllerRegistrationFilter

createFilter(String) - Static method in interface io.rxmicro.rest.server.local.model.RestControllerRegistrationFilter

createFilter(Set<Class<?>>) - Static method in interface io.rxmicro.rest.server.local.model.RestControllerRegistrationFilter

D

DATE - io.rxmicro.rest.server.StandardStaticResponseHeader

`Date` header that returns a date with time of a HTTP response generation.

DEFAULT_CORS_NOT_ALLOWED_ERROR_STATUS_CODE - Static variable in class io.rxmicro.rest.server.RestServerConfig

Default "CORS not allowed" error status code.

DEFAULT_HANDLER_NOT_FOUND_ERROR_STATUS_CODE - Static variable in class io.rxmicro.rest.server.RestServerConfig

Default "Handler not found" error status code.

DynamicRestControllerRegistrar - Interface in io.rxmicro.rest.server.local.component

E

EMPTY_CONTENT - Static variable in interface io.rxmicro.rest.server.detail.model.HttpResponse

Empty content.

EnableCrossOriginResourceSharing - Annotation Type in io.rxmicro.rest.server.feature

Activates the Cross Origin Resource Sharing for all request handlers in the REST controller.

exchangeFormat() - Method in annotation type io.rxmicro.rest.server.RestServerGeneratorConfig

Allows to specify the format for message exchange with a server.

exposedHeaders() - Method in annotation type io.rxmicro.rest.server.feature.EnableCrossOriginResourceSharing

Allows adding HTTP headers to ALL CORS requests.

F

FASTER_BUT_UNSAFE - io.rxmicro.rest.server.RequestIdGeneratorType

Generates unique IDs only within the framework of starting one JVM.

FasterButUnSafeRequestIdGenerator - Class in io.rxmicro.rest.server.local.component.impl

Generates unique IDs only within the framework of starting one JVM.

FasterButUnSafeRequestIdGenerator() - Constructor for class io.rxmicro.rest.server.local.component.impl.FasterButUnSafeRequestIdGenerator

FOR_TESTS_ONLY - io.rxmicro.rest.server.RequestIdGeneratorType

Recommended for test environment only.

G

generateRequestValidators() - Method in annotation type io.rxmicro.rest.server.RestServerGeneratorConfig

Allows enabling/disabling the option of generating HTTP request validators for all HTTP request handlers in the project.

generateResponseValidators() - Method in annotation type io.rxmicro.rest.server.RestServerGeneratorConfig

Allows enabling/disabling the option of generating HTTP response validators for all HTTP request handlers in the project.

getContent() - Method in interface io.rxmicro.rest.server.detail.model.HttpRequest

Returns the HTTP body as byte array for the current HTTP request.

getCorsNotAllowedErrorMessage() - Method in class io.rxmicro.rest.server.RestServerConfig

Returns the error message if the RxMicro framework does not support CORS feature for the current HTTP request.

getCorsNotAllowedErrorStatusCode() - Method in class io.rxmicro.rest.server.RestServerConfig

Returns the error status code if the RxMicro framework does not support CORS feature for the current HTTP request.

getGeneratorType() - Method in class io.rxmicro.rest.server.RestServerConfig

Returns used RequestIdGeneratorType.

getHandlerNotFoundErrorMessage() - Method in class io.rxmicro.rest.server.RestServerConfig

Returns the error message if the RxMicro framework can't find handler for current HTTP request.

getHandlerNotFoundErrorStatusCode() - Method in class io.rxmicro.rest.server.RestServerConfig

Returns the error status code if the RxMicro framework can't find handler for current HTTP request.

getHeaders() - Method in interface io.rxmicro.rest.server.detail.model.HttpRequest

Returns the HttpHeaders for the current HTTP request.

getMethod() - Method in interface io.rxmicro.rest.server.detail.model.HttpRequest

Returns the HTTP method.

getName() - Method in enum io.rxmicro.rest.server.StandardStaticResponseHeader

getName() - Method in interface io.rxmicro.rest.server.StaticResponseHeader

Returns the static HTTP header name.

getNextId() - Method in class io.rxmicro.rest.server.local.component.impl.FasterButUnSafeRequestIdGenerator

getNextId() - Method in class io.rxmicro.rest.server.local.component.impl.SafeButSlowerRequestIdGenerator

getNextId() - Method in class io.rxmicro.rest.server.local.component.impl.TestRequestIdGenerator

getNextId() - Method in interface io.rxmicro.rest.server.local.component.RequestIdGenerator

getQueryString() - Method in interface io.rxmicro.rest.server.detail.model.HttpRequest

Returns the query string for the current HTTP request.

getRegisteredRestControllers() - Method in interface io.rxmicro.rest.server.local.component.DynamicRestControllerRegistrar

getRegisteredRestControllers() - Method in class io.rxmicro.rest.server.local.model.ServerContainer

getRemoteAddress() - Method in interface io.rxmicro.rest.server.detail.model.HttpRequest

Returns the remote address for the connected HTTP client.

getRequestId() - Method in interface io.rxmicro.rest.server.detail.model.HttpRequest

Returns the "Request-Id" HTTP header.

getRestController() - Method in class io.rxmicro.rest.server.local.model.RestControllerMethod

getServerInstance() - Method in class io.rxmicro.rest.server.local.model.ServerContainer

getStaticResponseHeaders() - Method in class io.rxmicro.rest.server.RestServerConfig

Returns all defined static HTTP response headers for all HTTP request handlers.

getUri() - Method in interface io.rxmicro.rest.server.detail.model.HttpRequest

Returns the request URI

getValue() - Method in enum io.rxmicro.rest.server.StandardStaticResponseHeader

getValue() - Method in interface io.rxmicro.rest.server.StaticResponseHeader

Returns the static HTTP header value.

getVersion() - Method in interface io.rxmicro.rest.server.detail.model.HttpRequest

Returns the HttpVersion for the current HTTP request.

H

handle(HttpRequest) - Method in interface io.rxmicro.rest.server.local.component.RequestHandler

HttpErrorResponseBodyBuilder - Interface in io.rxmicro.rest.server.local.component

HttpRequest - Interface in io.rxmicro.rest.server.detail.model

Used by generated code that created by the RxMicro Annotation Processor.

HttpResponse - Interface in io.rxmicro.rest.server.detail.model

Used by generated code that created by the RxMicro Annotation Processor.

HttpServerConfig - Class in io.rxmicro.rest.server

Allows configuring HTTP server options.

HttpServerConfig() - Constructor for class io.rxmicro.rest.server.HttpServerConfig

Creates a HTTP server config instance with default settings.

I

invoke(PathVariableMapping, HttpRequest) - Method in class io.rxmicro.rest.server.local.model.RestControllerMethod

io.rxmicro.rest.server - package io.rxmicro.rest.server

The root package for the rxmicro.rest.server module.

io.rxmicro.rest.server.detail.model - package io.rxmicro.rest.server.detail.model

Used by generated code that created by the RxMicro Annotation Processor.

io.rxmicro.rest.server.feature - package io.rxmicro.rest.server.feature

The package for the rxmicro.rest.server module that provides additional HTTP server features.

io.rxmicro.rest.server.local.component - package io.rxmicro.rest.server.local.component

io.rxmicro.rest.server.local.component.impl - package io.rxmicro.rest.server.local.component.impl

io.rxmicro.rest.server.local.model - package io.rxmicro.rest.server.local.model

isContentPresent() - Method in interface io.rxmicro.rest.server.detail.model.HttpRequest

Returns true if the current HTTP request contains a HTTP body.

isDisableLoggerMessagesForHttpHealthChecks() - Method in class io.rxmicro.rest.server.RestServerConfig

Returns true if the RxMicro framework must disable logger for http health checks.

isHideInternalErrorMessage() - Method in class io.rxmicro.rest.server.RestServerConfig

Returns true if the RxMicro framework hides a cause of internal error from client.

isHumanReadableOutput() - Method in class io.rxmicro.rest.server.RestServerConfig

Returns true if the RxMicro framework returns HTTP response body in human readable format.

isLogNotServerErrors() - Method in class io.rxmicro.rest.server.RestServerConfig

Returns true if the RxMicro framework must log all not server errors (i.e.

isQueryStringPresent() - Method in interface io.rxmicro.rest.server.detail.model.HttpRequest

Returns true if the current HTTP request contains a query string

isReturnGeneratedRequestId() - Method in class io.rxmicro.rest.server.RestServerConfig

Returns true if the RxMicro framework must returns generated request id for each HTTP request.

isRxMicroError(HttpCallFailedException) - Method in interface io.rxmicro.rest.server.local.component.HttpErrorResponseBodyBuilder

isShowRuntimeEnv() - Method in class io.rxmicro.rest.server.RestServerConfig

Returns true if the RxMicro framework must print current runtime env after HTTP server is started successful.

isStartTimeTrackerEnabled() - Method in class io.rxmicro.rest.server.HttpServerConfig

Returns true if start time tracking is enabled.

L

launchWithFilter(RestControllerRegistrationFilter) - Static method in class io.rxmicro.rest.server.local.component.RestServerLauncher

launchWithoutRestControllers(Map<String, Config>) - Static method in class io.rxmicro.rest.server.local.component.RestServerLauncher

M

matches(String) - Method in class io.rxmicro.rest.server.local.component.PathMatcher

N

NotFoundMessage - Annotation Type in io.rxmicro.rest.server

Declares a message returned by the HTTP request handler in case of no result.

P

PathMatcher - Class in io.rxmicro.rest.server.local.component

PathMatcher(UrlSegments) - Constructor for class io.rxmicro.rest.server.local.component.PathMatcher

R

register(Set<Class<?>>) - Method in class io.rxmicro.rest.server.local.model.ServerContainer

RequestHandler - Interface in io.rxmicro.rest.server.local.component

RequestIdGenerator - Interface in io.rxmicro.rest.server.local.component

RequestIdGeneratorType - Enum in io.rxmicro.rest.server

Defines supported HTTP request id generator types.

RestControllerMethod - Class in io.rxmicro.rest.server.local.model

RestControllerMethod(String, AbstractRestController, String, BiFunction<PathVariableMapping, HttpRequest, CompletionStage<HttpResponse>>, boolean) - Constructor for class io.rxmicro.rest.server.local.model.RestControllerMethod

RestControllerRegistrationFilter - Interface in io.rxmicro.rest.server.local.model

RestServerConfig - Class in io.rxmicro.rest.server

Allows to configure a REST server options.

RestServerConfig() - Constructor for class io.rxmicro.rest.server.RestServerConfig

RestServerGeneratorConfig - Annotation Type in io.rxmicro.rest.server

Allows configuring the process of code generation by the RxMicro Annotation Processor for REST controllers.

RestServerLauncher - Class in io.rxmicro.rest.server.local.component

RxMicro - Class in io.rxmicro.rest.server

Utility class that helps to start a HTTP server with REST controllers.

rxmicro.rest.server - module rxmicro.rest.server

The basic HTTP server module used to create REST controllers and run REST-based microservices.

S

SAFE_BUT_SLOWER - io.rxmicro.rest.server.RequestIdGeneratorType

Generates unique IDs independently of starting the JVM.

SafeButSlowerRequestIdGenerator - Class in io.rxmicro.rest.server.local.component.impl

Generates unique IDs independently of starting the JVM.

SafeButSlowerRequestIdGenerator() - Constructor for class io.rxmicro.rest.server.local.component.impl.SafeButSlowerRequestIdGenerator

SERVER - io.rxmicro.rest.server.StandardStaticResponseHeader

`Server` header that returns a server name.

ServerContainer - Class in io.rxmicro.rest.server.local.model

ServerContainer(ServerInstance, DynamicRestControllerRegistrar, RestControllerAggregator) - Constructor for class io.rxmicro.rest.server.local.model.ServerContainer

ServerFactory - Interface in io.rxmicro.rest.server.local.component

ServerInstance - Interface in io.rxmicro.rest.server

Represents a HTTP server with common manage functions.

setConnectionString(String) - Method in class io.rxmicro.rest.server.HttpServerConfig

setContent(byte[]) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Sets the HTTP body as byte array.

setContent(String) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Sets the HTTP body as UTF8 string.

setCorsNotAllowedErrorMessage(String) - Method in class io.rxmicro.rest.server.RestServerConfig

Sets the error message if the RxMicro framework does not support CORS feature for the current HTTP request.

setCorsNotAllowedErrorStatusCode(int) - Method in class io.rxmicro.rest.server.RestServerConfig

Sets the error status code if the RxMicro framework does not support CORS feature for the current HTTP request.

setDevelopmentMode() - Method in class io.rxmicro.rest.server.RestServerConfig

Configures REST server for development environment.

setDisableLoggerMessagesForHttpHealthChecks(boolean) - Method in class io.rxmicro.rest.server.RestServerConfig

Activates or disables logger messages for http health checks.

setGeneratorType(RequestIdGeneratorType) - Method in class io.rxmicro.rest.server.RestServerConfig

Allows changing a RequestIdGeneratorType.

setHandlerNotFoundErrorMessage(String) - Method in class io.rxmicro.rest.server.RestServerConfig

Sets the error message if the RxMicro framework can't find handler for current HTTP request.

setHandlerNotFoundErrorStatusCode(int) - Method in class io.rxmicro.rest.server.RestServerConfig

Sets the error status code if the RxMicro framework can't find handler for current HTTP request.

setHeader(String, Object) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Sets the HTTP header with the specified name and value to the HTTP response generated by HTTP server.

setHeader(String, String) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Sets the HTTP header with the specified name and value to the HTTP response generated by HTTP server.

setHeader(String, BigDecimal) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Sets the HTTP header with the specified name and value to the HTTP response generated by HTTP server.

setHeader(String, List<?>) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Sets the HTTP header with the specified name and value to the HTTP response generated by HTTP server.

setHideInternalErrorMessage(boolean) - Method in class io.rxmicro.rest.server.RestServerConfig

Activates or disables the displaying of cause of internal error if it occur.

setHost(String) - Method in class io.rxmicro.rest.server.HttpServerConfig

setHumanReadableOutput(boolean) - Method in class io.rxmicro.rest.server.RestServerConfig

Activates or disables the human readable of response.

setLogNotServerErrors(boolean) - Method in class io.rxmicro.rest.server.RestServerConfig

Activates or disables the logging of not server errors.

setOrAddHeaders(HttpHeaders) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Sets or adds the HttpHeaders

setPort(int) - Method in class io.rxmicro.rest.server.HttpServerConfig

setReturnGeneratedRequestId(boolean) - Method in class io.rxmicro.rest.server.RestServerConfig

Activates or disables the returning of generated request id for each HTTP request.

setSchema(ProtocolSchema) - Method in class io.rxmicro.rest.server.HttpServerConfig

setShowRuntimeEnv(boolean) - Method in class io.rxmicro.rest.server.RestServerConfig

If this variable is set and HTTP server is started, the RxMicro framework will print the short info about the current runtime: available processor cores and memory usage.

setStartTimeTrackerEnabled(boolean) - Method in class io.rxmicro.rest.server.HttpServerConfig

Allows enabling/disabling a start time tracking.

setStaticResponseHeaders(Set<StaticResponseHeader>) - Method in class io.rxmicro.rest.server.RestServerConfig

Allows customizing static HTTP response headers for all HTTP request handlers.

setStatus(int) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Sets the status code.

SetStatusCode - Annotation Type in io.rxmicro.rest.server

Declares a status code, which should be sent to the client in case of successful execution of the HTTP request handler.

setVersion(HttpVersion) - Method in interface io.rxmicro.rest.server.detail.model.HttpResponse

Sets the HttpVersion

shutdown() - Method in interface io.rxmicro.rest.server.ServerInstance

Sends an async shutdown request.

shutdownAndWait() - Method in interface io.rxmicro.rest.server.ServerInstance

Sends an async shutdown request and waits for HTTP server stopped.

StandardStaticResponseHeader - Enum in io.rxmicro.rest.server

Standard static HTTP headers.

startNewServer(RequestHandler) - Method in interface io.rxmicro.rest.server.local.component.ServerFactory

startRestServer(Class<?>) - Static method in class io.rxmicro.rest.server.RxMicro

Starts only one REST controller on HTTP server.

startRestServer(Class<?>, Class<?>...) - Static method in class io.rxmicro.rest.server.RxMicro

Starts an array of REST controllers on HTTP server.

startRestServer(String) - Static method in class io.rxmicro.rest.server.RxMicro

Starts all REST controllers that are located inside the rootPackage on HTTP server.

startRestServer(Set<Class<?>>) - Static method in class io.rxmicro.rest.server.RxMicro

Starts a set of REST controllers on HTTP server.

startRESTServer(Class<?>) - Static method in class io.rxmicro.rest.server.RxMicro

Starts only one REST controller on HTTP server.

startRESTServer(Class<?>, Class<?>...) - Static method in class io.rxmicro.rest.server.RxMicro

Starts an array of REST controllers on HTTP server.

startRESTServer(String) - Static method in class io.rxmicro.rest.server.RxMicro

Starts all REST controllers that are located inside the rootPackage on HTTP server.

startRESTServer(Set<Class<?>>) - Static method in class io.rxmicro.rest.server.RxMicro

Starts a set of REST controllers on HTTP server.

startRestServerInteractive(Class<?>) - Static method in class io.rxmicro.rest.server.RxMicro

Starts only one REST controller on HTTP server.

startRestServerInteractive(Class<?>, Class<?>...) - Static method in class io.rxmicro.rest.server.RxMicro

Starts an array of REST controllers on HTTP server.

startRestServerInteractive(String) - Static method in class io.rxmicro.rest.server.RxMicro

Starts all REST controllers that are located inside the rootPackage on HTTP server.

startRestServerInteractive(Set<Class<?>>) - Static method in class io.rxmicro.rest.server.RxMicro

Starts a set of REST controllers on HTTP server.

startRESTServerInteractive(Class<?>) - Static method in class io.rxmicro.rest.server.RxMicro

Starts only one REST controller on HTTP server.

startRESTServerInteractive(Class<?>, Class<?>...) - Static method in class io.rxmicro.rest.server.RxMicro

Starts an array of REST controllers on HTTP server.

startRESTServerInteractive(String) - Static method in class io.rxmicro.rest.server.RxMicro

Starts all REST controllers that are located inside the rootPackage on HTTP server.

startRESTServerInteractive(Set<Class<?>>) - Static method in class io.rxmicro.rest.server.RxMicro

Starts a set of REST controllers on HTTP server.

StaticResponseHeader - Interface in io.rxmicro.rest.server

Defines the static HTTP response headers that must be returned by HTTP server for all HTTP responses.

T

TestRequestIdGenerator - Class in io.rxmicro.rest.server.local.component.impl

Request id generator used for test environment only.

TestRequestIdGenerator() - Constructor for class io.rxmicro.rest.server.local.component.impl.TestRequestIdGenerator

toString() - Method in class io.rxmicro.rest.server.local.model.RestControllerMethod

toString() - Method in class io.rxmicro.rest.server.RestServerConfig

U

unregisterAllRestControllers() - Method in class io.rxmicro.rest.server.local.model.ServerContainer

V

value() - Method in annotation type io.rxmicro.rest.server.NotFoundMessage

Returns custom not found message.

value() - Method in annotation type io.rxmicro.rest.server.SetStatusCode

Returns the HTTP response status code.

valueOf(String) - Static method in enum io.rxmicro.rest.server.RequestIdGeneratorType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.rxmicro.rest.server.StandardStaticResponseHeader

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.rxmicro.rest.server.RequestIdGeneratorType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.rxmicro.rest.server.StandardStaticResponseHeader

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L M N P R S T U V
All Classes All Packages