Index (rxmicro-rest-client 0.8 API)

A C D E F G H I J L P R S T V
All Classes All Packages

A

AbstractRestClient - Class in io.rxmicro.rest.client.detail: Used by generated code that created by the RxMicro Annotation Processor.
AbstractRestClient() - Constructor for class io.rxmicro.rest.client.detail.AbstractRestClient

C

configClass() - Method in annotation type io.rxmicro.rest.client.RestClient: Allows extending the standard RestClientConfig class.
configNameSpace() - Method in annotation type io.rxmicro.rest.client.RestClient: Allows setting a custom config name space.
create(Class<?>, String, RestClientConfig, Secrets, HttpClientContentConverter) - Method in interface io.rxmicro.rest.client.detail.HttpClientFactory: Creates a new instance of low-level reactive HttpClient.

D

DEFAULT_CONNECT_TIMEOUT - Static variable in class io.rxmicro.rest.client.RestClientConfig: Default connect timeout.
DEFAULT_HTTP_PORT - Static variable in class io.rxmicro.rest.client.RestClientConfig: Default HTTP port.
DEFAULT_POOL_ACQUIRE_TIMEOUT - Static variable in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Default acquisition timeout (milliseconds) before error.
DEFAULT_POOL_LEASING_STRATEGY - Static variable in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Default leasing strategy.
DEFAULT_POOL_MAX_CONNECTIONS - Static variable in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Default max connections.
DEFAULT_REQUEST_TIMEOUT - Static variable in class io.rxmicro.rest.client.RestClientConfig: Default request timeout.

E

EMPTY_HEADERS - Static variable in class io.rxmicro.rest.client.detail.AbstractRestClient: Empty HTTP headers.
EVICT_IN_BACKGROUND_DISABLED - Static variable in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Providing an evictionInterval of zero means the background eviction is disabled.
exchangeFormat() - Method in annotation type io.rxmicro.rest.client.RestClientGeneratorConfig: Allows specifying the format for message exchange with a server.

F

FIFO - io.rxmicro.rest.client.LeasingStrategy: The connection selection is first in, first out.

G

generateRequestValidators() - Method in annotation type io.rxmicro.rest.client.RestClientGeneratorConfig: Allows enabling/disabling the option of generating HTTP request validators for all REST client methods in the project.
generateResponseValidators() - Method in annotation type io.rxmicro.rest.client.RestClientGeneratorConfig: Allows enabling/disabling the option of generating HTTP response validators for all REST client methods in the project.
getAccessKey() - Method in class io.rxmicro.rest.client.RestClientConfig: Returns the set access key or null if access key is not configured.
getConnectTimeout() - Method in class io.rxmicro.rest.client.RestClientConfig: Returns the connect timeout.
getEvictionInterval() - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Returns the options to use for configuring connection provider background eviction.
getLeasingStrategy() - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Returns the configured leasing strategy.
getMaxConnections() - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Returns the options to use for configuring connection provider maximum connections per connection pool.
getMaxIdleTime() - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Returns the options to use for configuring connection provider max idle time (resolution: ms).
getMaxLifeTime() - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Returns the options to use for configuring connection provider max life time (resolution: ms).
getPendingAcquireMaxCount() - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Returns the options to use for configuring connection provider the maximum number of registered requests for acquire to keep in a pending queue.
getPendingAcquireTimeout() - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Returns the options to use for configuring connection provider acquire timeout (resolution: ms).
getRequestTimeout() - Method in class io.rxmicro.rest.client.RestClientConfig: Returns the request timeout.
getRestClient(Class<T>) - Static method in class io.rxmicro.rest.client.RestClientFactory: Returns an instance of the REST client.

H

HttpClientConnectionPoolConfig - Class in io.rxmicro.rest.client: Configures connection pool settings for http client.
HttpClientConnectionPoolConfig() - Constructor for class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: This is basic class designed for extension only.
HttpClientFactory - Interface in io.rxmicro.rest.client.detail: Used by generated code that created by the RxMicro Annotation Processor.
HttpClientTimeoutException - Exception in io.rxmicro.rest.client: A class signaling that the HTTP client didn’t receive a response from the server in given time.
HttpClientTimeoutException(String, Object...) - Constructor for exception io.rxmicro.rest.client.HttpClientTimeoutException: Creates a HTTP error with error message.

I

io.rxmicro.rest.client - package io.rxmicro.rest.client: The root package for the rxmicro.rest.client module.
io.rxmicro.rest.client.detail - package io.rxmicro.rest.client.detail: Used by generated code that created by the RxMicro Annotation Processor.
isEnableAdditionalValidations() - Method in class io.rxmicro.rest.client.RestClientConfig: Returns true if additional validations are enabled.
isFollowRedirects() - Method in class io.rxmicro.rest.client.RestClientConfig: Returns true if current HTTP client must follow redirects.

J

joinPath(String, List<Map.Entry<String, String>>) - Method in class io.rxmicro.rest.client.detail.AbstractRestClient: Joins the path.

L

LeasingStrategy - Enum in io.rxmicro.rest.client: The leasing strategy.
LIFO - io.rxmicro.rest.client.LeasingStrategy: The connection selection is last in, first out.

P

PartialImplementation - Annotation Type in io.rxmicro.rest.client: If the REST client generated by the RxMicro Annotation Processor contains errors, incorrect or non-optimized logic, the developer can use the Partial Implementation feature.

R

requestValidationMode() - Method in annotation type io.rxmicro.rest.client.RestClientGeneratorConfig: Specifies how the HTTP request parameters should be checked.
REST_CLIENT_FACTORY_IMPL_CLASS_NAME - Static variable in class io.rxmicro.rest.client.RestClientFactory: Default name of the REST client factory implementation class.
RestClient - Annotation Type in io.rxmicro.rest.client: Denotes that an interface is a dynamic generated REST client.
RestClientConfig - Class in io.rxmicro.rest.client: Allows configuring a REST client options.
RestClientConfig() - Constructor for class io.rxmicro.rest.client.RestClientConfig: Creates a rest client config instance with default settings.
RestClientFactory - Class in io.rxmicro.rest.client: Utility class that must be used to get an instance of the REST client.
RestClientFactory() - Constructor for class io.rxmicro.rest.client.RestClientFactory
RestClientGeneratorConfig - Annotation Type in io.rxmicro.rest.client: Allows configuring the process of code generation by the RxMicro Annotation Processor for REST clients.
RestClientGeneratorConfig.RequestValidationMode - Enum in io.rxmicro.rest.client: Provides supported request validation modes for REST clients.
RETURN_ERROR_SIGNAL - io.rxmicro.rest.client.RestClientGeneratorConfig.RequestValidationMode: error handling should be performed in reactive style.
rxmicro.rest.client - module rxmicro.rest.client: The basic module used to create and run REST clients.

S

setAccessKey(String) - Method in class io.rxmicro.rest.client.RestClientConfig: Sets the access key that can be used for authentication on the server side.
setConnectionString(String) - Method in class io.rxmicro.rest.client.RestClientConfig
setConnectTimeout(Duration) - Method in class io.rxmicro.rest.client.RestClientConfig: Sets the connect timeout.
setEnableAdditionalValidations(boolean) - Method in class io.rxmicro.rest.client.RestClientConfig: Sets true if additional validations must be activated.
setEvictionInterval(Duration) - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Set the options to use for configuring connection provider background eviction.
setEvictionInterval(Duration) - Method in class io.rxmicro.rest.client.RestClientConfig
setFollowRedirects(boolean) - Method in class io.rxmicro.rest.client.RestClientConfig: Sets that current HTTP client must follow redirects or not.
setHost(String) - Method in class io.rxmicro.rest.client.RestClientConfig
setLeasingStrategy(LeasingStrategy) - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Sets the custom leasing strategy.
setLeasingStrategy(LeasingStrategy) - Method in class io.rxmicro.rest.client.RestClientConfig
setMaxConnections(int) - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Set the options to use for configuring connection provider maximum connections per connection pool.
setMaxConnections(int) - Method in class io.rxmicro.rest.client.RestClientConfig
setMaxIdleTime(Duration) - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Set the options to use for configuring connection provider max idle time (resolution: ms).
setMaxIdleTime(Duration) - Method in class io.rxmicro.rest.client.RestClientConfig
setMaxLifeTime(Duration) - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Set the options to use for configuring connection provider max life time (resolution: ms).
setMaxLifeTime(Duration) - Method in class io.rxmicro.rest.client.RestClientConfig
setPendingAcquireMaxCount(int) - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Set the options to use for configuring connection provider the maximum number of registered requests for acquire to keep in a pending queue.
setPendingAcquireMaxCount(int) - Method in class io.rxmicro.rest.client.RestClientConfig
setPendingAcquireTimeout(Duration) - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig: Set the options to use for configuring connection provider acquire timeout (resolution: ms).
setPendingAcquireTimeout(Duration) - Method in class io.rxmicro.rest.client.RestClientConfig
setPort(int) - Method in class io.rxmicro.rest.client.RestClientConfig
setRequestTimeout(Duration) - Method in class io.rxmicro.rest.client.RestClientConfig: Sets the request timeout.
setSchema(ProtocolSchema) - Method in class io.rxmicro.rest.client.RestClientConfig
STATUS_CODE - Static variable in exception io.rxmicro.rest.client.HttpClientTimeoutException: Status code for the all instances of the current exception type.

T

THROW_EXCEPTION - io.rxmicro.rest.client.RestClientGeneratorConfig.RequestValidationMode: it is necessary to catch the exception.
toString() - Method in class io.rxmicro.rest.client.HttpClientConnectionPoolConfig
toString() - Method in class io.rxmicro.rest.client.RestClientConfig

V

value() - Method in annotation type io.rxmicro.rest.client.PartialImplementation: Returns the abstract rest client class, which contains a partial or a full implementation of the rest client logic.
valueOf(String) - Static method in enum io.rxmicro.rest.client.LeasingStrategy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.rxmicro.rest.client.RestClientGeneratorConfig.RequestValidationMode: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.rxmicro.rest.client.LeasingStrategy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.rxmicro.rest.client.RestClientGeneratorConfig.RequestValidationMode: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I J L P R S T V
All Classes All Packages