RxRestDatastoreClient (RxGORM REST Client)

org.grails.datastore.rx.rest.RxRestDatastoreClient

All Implemented Interfaces and Traits:

org.grails.datastore.rx.bson.CodecsRxDatastoreClient, Settings
```
@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
class RxRestDatastoreClient
extends AbstractRxDatastoreClient
```
An RxGORM implementation that backs onto a backend REST server
Authors:
Graeme Rocher
Since:
6.0

Field Summary

Fields
Modifiers	Name	Description
`protected boolean`	`allowBlockingOperations`

Inherited fields
Fields inherited from class	Fields
`class AbstractRxDatastoreClient`	`mappingContext`

Properties Summary

Properties
Type	Name and description
`java.nio.charset.Charset`	`charset` The encoding to use
`org.bson.codecs.configuration.CodecRegistry`	`codecRegistry` The org.bson.codecs.configuration.CodecRegistry
`io.reactivex.netty.client.ConnectionProviderFactory`	`connectionProviderFactory` The io.reactivex.netty.client.ConnectionProviderFactory to use to create connections
`java.util.Set<java.lang.String>`	`defaultParameterNames` The default allowable set of parameter names
`HttpMethod`	`defaultUpdateMethod` The default method to use for updates.
`java.lang.String`	`expandParameter` The name of the expand parameter to use
`java.util.Observable<io.reactivex.netty.client.Host>`	`hosts` The default client host to connect to
`java.util.List<RequestInterceptor>`	`interceptors` The interceptors to use
`boolean`	`isSecure` Whether communication is over a security HTTPS connection
`io.netty.handler.logging.LogLevel`	`loggerLevel` The default log level
`java.lang.String`	`loggerName` The default log level
`java.lang.String`	`maxParameter` The name of the max parameter to use
`java.lang.String`	`offsetParameter` The name of the offset parameter to use
`java.lang.String`	`orderParameter` The name of the order parameter to use
`java.lang.String`	`password` The password to use for BASIC auth
`java.util.List<java.net.Proxy>`	`proxies` The proxies to use to connect
`java.lang.String`	`queryParameter` The name of the query parameter to use
`java.lang.Class<? extends SimpleRxRestQuery>`	`queryType` The query type to use
`int`	`readTimeout` The default read timeout
`RxHttpClientBuilder`	`rxHttpClientBuilder` A low level client for non entity related operations
`RestConnectionSourceSettings`	`settings`
`java.lang.String`	`sortParameter` The name of the sort parameter to use
`io.netty.handler.ssl.SslContext`	`sslContext`
`io.netty.handler.ssl.SslProvider`	`sslProvider` The SSL provider
`long`	`sslSessionCacheSize` The default session cache size
`long`	`sslSessionTimeout` The SSL timeout period
`javax.net.ssl.TrustManagerFactory`	`sslTrustManagerFactory` The default trust manager factory
`java.lang.String`	`username` The username to use for BASIC auth

Constructor Summary

Constructors
Constructor and description
`RxRestDatastoreClient (ConnectionSources<io.reactivex.netty.client.ConnectionProviderFactory, RestConnectionSourceSettings> connectionSources, RestClientMappingContext mappingContext)`
`RxRestDatastoreClient (ConnectionSources<io.reactivex.netty.client.ConnectionProviderFactory, RestConnectionSourceSettings> connectionSources, java.lang.Class... classes)`
`RxRestDatastoreClient (java.util.List<java.lang.String> hosts, org.springframework.core.env.PropertyResolver configuration, java.lang.Class... classes)`
`RxRestDatastoreClient (java.util.List<java.lang.String> hosts, java.lang.Class... classes)`
`RxRestDatastoreClient (java.lang.String host, org.springframework.core.env.PropertyResolver configuration, java.lang.Class... classes)`
`RxRestDatastoreClient (java.lang.String host, java.lang.Class... classes)`
`RxRestDatastoreClient (org.springframework.core.env.PropertyResolver configuration, java.lang.Class... classes)`
`RxRestDatastoreClient (java.lang.Class... classes)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.Observable<java.lang.Number>`	`batchDelete(BatchOperation operation)`
	`java.util.Observable<java.lang.Number>`	`batchWrite(BatchOperation operation)`
	`protected io.reactivex.netty.protocol.http.client.HttpClient<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf>`	`configureProxy(io.reactivex.netty.protocol.http.client.HttpClient<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> httpClient)` Configures any java.net.Proxy instances for the client
	`protected RxRestDatastoreClient`	`createChildClient(SingletonConnectionSources<io.reactivex.netty.client.ConnectionProviderFactory, RestConnectionSourceSettings> singletonConnectionSources)`
	`protected java.util.Observable<io.netty.buffer.ByteBuf>`	`createContentWriteObservable(RestEndpointPersistentEntity restEndpointPersistentEntity, org.bson.codecs.Codec codec, EntityOperation entityOp)`
	`protected static InMemoryConnectionSources<io.reactivex.netty.client.ConnectionProviderFactory, RestConnectionSourceSettings>`	`createDefaultConnectionSourcesForHosts(java.util.List<java.lang.String> hosts, org.springframework.core.env.PropertyResolver configuration)`
	`Query`	`createEntityQuery(PersistentEntity entity, QueryState queryState)`
	`Query`	`createEntityQuery(PersistentEntity entity, QueryState queryState, java.util.Map arguments)`
	`io.reactivex.netty.protocol.http.client.HttpClient<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf>`	`createHttpClient(java.util.Map<java.lang.String, java.lang.Object> arguments)`
	`RxRestGormInstanceApi`	`createInstanceApi(PersistentEntity entity, java.lang.String connectionSourceName)`
	`protected static RestClientMappingContext`	`createMappingContext(org.springframework.core.env.PropertyResolver configuration, java.lang.Class... classes)`
	`Query`	`createQuery(java.lang.Class type, com.damnhandy.uri.template.UriTemplate uriTemplate, QueryState queryState, java.util.Map arguments = Collections.emptyMap()`
	`protected static java.util.List<java.net.SocketAddress>`	`createServerSocketAddresses(org.springframework.core.env.PropertyResolver configuration)`
	`RxRestGormStaticApi`	`createStaticApi(PersistentEntity entity, java.lang.String connectionSourceName)`
	`void`	`doClose()`
	`protected java.lang.String`	`expandUri(com.damnhandy.uri.template.UriTemplate uriTemplate, EntityReflector entityReflector, java.lang.Object object)`
	`java.io.Serializable`	`generateIdentifier(PersistentEntity entity, java.lang.Object instance, EntityReflector reflector)`
`<T>`	`org.bson.codecs.Codec<T>`	`get(java.lang.Class<T> clazz, org.bson.codecs.configuration.CodecRegistry registry)`
	`RestClientMappingContext`	`getMappingContext()`
	`RxHttpClientBuilder`	`getNativeInterface()`
	`protected void`	`initDefaultConverters(RestClientMappingContext mappingContext)`
	`protected void`	`initialize(RestClientMappingContext mappingContext)`
	`boolean`	`isAllowBlockingOperations()`
	`java.util.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse>`	`prepareRequest(io.reactivex.netty.protocol.http.client.HttpClientRequest<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> httpClientRequest, InterceptorContext context)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractRxDatastoreClient`	activeDirtyChecking, batchDelete, batchWrite, close, createEntityQuery, createEntityQuery, createInstanceApi, createInstanceApi, createQuery, createQuery, createQuery, createQuery, createStaticApi, createStaticApi, createValidationApi, createValidationApi, createValidatorRegistry, delete, delete, deleteAll, deleteAll, doClose, generateIdentifier, get, get, getDatastoreClient, getDatastoreClientForTenantId, getEventPublisher, getMappingContext, getMultiTenancyMode, getTenantResolver, initDefaultEventListeners, insert, insertAll, insertAll, isIndexed, isSchemaless, persist, persist, persistAll, persistAll, persistAllInternal, processAssociations, proxy, proxy, scheduleInsert, scheduleInsertOrUpdate, scheduleUpdate, setEventPublisher, setMessageSource
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected final boolean allowBlockingOperations
- Property Detail
  - final java.nio.charset.Charset charset
    
    The encoding to use
  - final org.bson.codecs.configuration.CodecRegistry codecRegistry
    
    The org.bson.codecs.configuration.CodecRegistry
  - final io.reactivex.netty.client.ConnectionProviderFactory connectionProviderFactory
    
    The io.reactivex.netty.client.ConnectionProviderFactory to use to create connections
  - final java.util.Set<java.lang.String> defaultParameterNames
    
    The default allowable set of parameter names
  - final HttpMethod defaultUpdateMethod
    
    The default method to use for updates. Defaults to PUT
  - final java.lang.String expandParameter
    
    The name of the expand parameter to use
  - final java.util.Observable<io.reactivex.netty.client.Host> hosts
    
    The default client host to connect to
  - final java.util.List<RequestInterceptor> interceptors
    
    The interceptors to use
  - final boolean isSecure
    
    Whether communication is over a security HTTPS connection
  - final io.netty.handler.logging.LogLevel loggerLevel
    
    The default log level
  - final java.lang.String loggerName
    
    The default log level
  - final java.lang.String maxParameter
    
    The name of the max parameter to use
  - final java.lang.String offsetParameter
    
    The name of the offset parameter to use
  - final java.lang.String orderParameter
    
    The name of the order parameter to use
  - final java.lang.String password
    
    The password to use for BASIC auth
  - final java.util.List<java.net.Proxy> proxies
    
    The proxies to use to connect
  - final java.lang.String queryParameter
    
    The name of the query parameter to use
  - final java.lang.Class<? extends SimpleRxRestQuery> queryType
    
    The query type to use
  - final int readTimeout
    
    The default read timeout
  - final RxHttpClientBuilder rxHttpClientBuilder
    
    A low level client for non entity related operations
  - final RestConnectionSourceSettings settings
  - final java.lang.String sortParameter
    
    The name of the sort parameter to use
  - final io.netty.handler.ssl.SslContext sslContext
  - final io.netty.handler.ssl.SslProvider sslProvider
    
    The SSL provider
  - final long sslSessionCacheSize
    
    The default session cache size
  - final long sslSessionTimeout
    
    The SSL timeout period
  - final javax.net.ssl.TrustManagerFactory sslTrustManagerFactory
    
    The default trust manager factory
  - final java.lang.String username
    
    The username to use for BASIC auth
- Constructor Detail
  - RxRestDatastoreClient(ConnectionSources<io.reactivex.netty.client.ConnectionProviderFactory, RestConnectionSourceSettings> connectionSources, RestClientMappingContext mappingContext)
  - RxRestDatastoreClient(ConnectionSources<io.reactivex.netty.client.ConnectionProviderFactory, RestConnectionSourceSettings> connectionSources, java.lang.Class... classes)
  - RxRestDatastoreClient(java.util.List<java.lang.String> hosts, org.springframework.core.env.PropertyResolver configuration, java.lang.Class... classes)
  - RxRestDatastoreClient(java.util.List<java.lang.String> hosts, java.lang.Class... classes)
  - RxRestDatastoreClient(java.lang.String host, org.springframework.core.env.PropertyResolver configuration, java.lang.Class... classes)
  - RxRestDatastoreClient(java.lang.String host, java.lang.Class... classes)
  - RxRestDatastoreClient(org.springframework.core.env.PropertyResolver configuration, java.lang.Class... classes)
  - RxRestDatastoreClient(java.lang.Class... classes)
- Method Detail
  - @java.lang.Override java.util.Observable<java.lang.Number> batchDelete(BatchOperation operation)
  - @java.lang.Override java.util.Observable<java.lang.Number> batchWrite(BatchOperation operation)
  - protected io.reactivex.netty.protocol.http.client.HttpClient<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> configureProxy(io.reactivex.netty.protocol.http.client.HttpClient<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> httpClient)
    
    Configures any java.net.Proxy instances for the client
    Parameters:
    httpClient - The client
    Returns:
    The configured client
  - protected RxRestDatastoreClient createChildClient(SingletonConnectionSources<io.reactivex.netty.client.ConnectionProviderFactory, RestConnectionSourceSettings> singletonConnectionSources)
  - protected java.util.Observable<io.netty.buffer.ByteBuf> createContentWriteObservable(RestEndpointPersistentEntity restEndpointPersistentEntity, org.bson.codecs.Codec codec, EntityOperation entityOp)
  - protected static InMemoryConnectionSources<io.reactivex.netty.client.ConnectionProviderFactory, RestConnectionSourceSettings> createDefaultConnectionSourcesForHosts(java.util.List<java.lang.String> hosts, org.springframework.core.env.PropertyResolver configuration)
  - @java.lang.Override Query createEntityQuery(PersistentEntity entity, QueryState queryState)
  - @java.lang.Override Query createEntityQuery(PersistentEntity entity, QueryState queryState, java.util.Map arguments)
  - io.reactivex.netty.protocol.http.client.HttpClient<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> createHttpClient(java.util.Map<java.lang.String, java.lang.Object> arguments)
  - @java.lang.Override RxRestGormInstanceApi createInstanceApi(PersistentEntity entity, java.lang.String connectionSourceName)
  - protected static RestClientMappingContext createMappingContext(org.springframework.core.env.PropertyResolver configuration, java.lang.Class... classes)
  - final Query createQuery(java.lang.Class type, com.damnhandy.uri.template.UriTemplate uriTemplate, QueryState queryState, java.util.Map arguments = Collections.emptyMap()
  - protected static java.util.List<java.net.SocketAddress> createServerSocketAddresses(org.springframework.core.env.PropertyResolver configuration)
  - @java.lang.Override RxRestGormStaticApi createStaticApi(PersistentEntity entity, java.lang.String connectionSourceName)
  - @java.lang.Override void doClose()
  - protected java.lang.String expandUri(com.damnhandy.uri.template.UriTemplate uriTemplate, EntityReflector entityReflector, java.lang.Object object)
  - @java.lang.Override java.io.Serializable generateIdentifier(PersistentEntity entity, java.lang.Object instance, EntityReflector reflector)
  - <T> @java.lang.Override org.bson.codecs.Codec<T> get(java.lang.Class<T> clazz, org.bson.codecs.configuration.CodecRegistry registry)
  - @java.lang.Override RestClientMappingContext getMappingContext()
  - @java.lang.Override RxHttpClientBuilder getNativeInterface()
  - protected void initDefaultConverters(RestClientMappingContext mappingContext)
  - protected void initialize(RestClientMappingContext mappingContext)
  - @java.lang.Override boolean isAllowBlockingOperations()
  - java.util.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse> prepareRequest(io.reactivex.netty.protocol.http.client.HttpClientRequest<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> httpClientRequest, InterceptorContext context)

Summary:
Field
Property
Constructor
Method

[Groovy] Class RxRestDatastoreClient

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final boolean allowBlockingOperations

Property Detail

final java.nio.charset.Charset charset

final org.bson.codecs.configuration.CodecRegistry codecRegistry

final io.reactivex.netty.client.ConnectionProviderFactory connectionProviderFactory

final java.util.Set<java.lang.String> defaultParameterNames

final HttpMethod defaultUpdateMethod

final java.lang.String expandParameter

final java.util.Observable<io.reactivex.netty.client.Host> hosts

final java.util.List<RequestInterceptor> interceptors

final boolean isSecure

final io.netty.handler.logging.LogLevel loggerLevel

final java.lang.String loggerName

final java.lang.String maxParameter

final java.lang.String offsetParameter

final java.lang.String orderParameter

final java.lang.String password

final java.util.List<java.net.Proxy> proxies

final java.lang.String queryParameter

final java.lang.Class<? extends SimpleRxRestQuery> queryType

final int readTimeout

final RxHttpClientBuilder rxHttpClientBuilder

final RestConnectionSourceSettings settings

final java.lang.String sortParameter

final io.netty.handler.ssl.SslContext sslContext

final io.netty.handler.ssl.SslProvider sslProvider

final long sslSessionCacheSize

final long sslSessionTimeout

final javax.net.ssl.TrustManagerFactory sslTrustManagerFactory

final java.lang.String username

Constructor Detail

RxRestDatastoreClient(ConnectionSources<io.reactivex.netty.client.ConnectionProviderFactory, RestConnectionSourceSettings> connectionSources, RestClientMappingContext mappingContext)

RxRestDatastoreClient(ConnectionSources<io.reactivex.netty.client.ConnectionProviderFactory, RestConnectionSourceSettings> connectionSources, java.lang.Class... classes)

RxRestDatastoreClient(java.util.List<java.lang.String> hosts, org.springframework.core.env.PropertyResolver configuration, java.lang.Class... classes)

RxRestDatastoreClient(java.util.List<java.lang.String> hosts, java.lang.Class... classes)

RxRestDatastoreClient(java.lang.String host, org.springframework.core.env.PropertyResolver configuration, java.lang.Class... classes)

RxRestDatastoreClient(java.lang.String host, java.lang.Class... classes)

RxRestDatastoreClient(org.springframework.core.env.PropertyResolver configuration, java.lang.Class... classes)

RxRestDatastoreClient(java.lang.Class... classes)

Method Detail

@java.lang.Override java.util.Observable<java.lang.Number> batchDelete(BatchOperation operation)

@java.lang.Override java.util.Observable<java.lang.Number> batchWrite(BatchOperation operation)

protected io.reactivex.netty.protocol.http.client.HttpClient<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> configureProxy(io.reactivex.netty.protocol.http.client.HttpClient<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> httpClient)

protected RxRestDatastoreClient createChildClient(SingletonConnectionSources<io.reactivex.netty.client.ConnectionProviderFactory, RestConnectionSourceSettings> singletonConnectionSources)

protected java.util.Observable<io.netty.buffer.ByteBuf> createContentWriteObservable(RestEndpointPersistentEntity restEndpointPersistentEntity, org.bson.codecs.Codec codec, EntityOperation entityOp)

protected static InMemoryConnectionSources<io.reactivex.netty.client.ConnectionProviderFactory, RestConnectionSourceSettings> createDefaultConnectionSourcesForHosts(java.util.List<java.lang.String> hosts, org.springframework.core.env.PropertyResolver configuration)

@java.lang.Override Query createEntityQuery(PersistentEntity entity, QueryState queryState)

@java.lang.Override Query createEntityQuery(PersistentEntity entity, QueryState queryState, java.util.Map arguments)

io.reactivex.netty.protocol.http.client.HttpClient<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> createHttpClient(java.util.Map<java.lang.String, java.lang.Object> arguments)

@java.lang.Override RxRestGormInstanceApi createInstanceApi(PersistentEntity entity, java.lang.String connectionSourceName)

protected static RestClientMappingContext createMappingContext(org.springframework.core.env.PropertyResolver configuration, java.lang.Class... classes)

final Query createQuery(java.lang.Class type, com.damnhandy.uri.template.UriTemplate uriTemplate, QueryState queryState, java.util.Map arguments = Collections.emptyMap()

protected static java.util.List<java.net.SocketAddress> createServerSocketAddresses(org.springframework.core.env.PropertyResolver configuration)

@java.lang.Override RxRestGormStaticApi createStaticApi(PersistentEntity entity, java.lang.String connectionSourceName)

@java.lang.Override void doClose()

protected java.lang.String expandUri(com.damnhandy.uri.template.UriTemplate uriTemplate, EntityReflector entityReflector, java.lang.Object object)

@java.lang.Override java.io.Serializable generateIdentifier(PersistentEntity entity, java.lang.Object instance, EntityReflector reflector)

<T> @java.lang.Override org.bson.codecs.Codec<T> get(java.lang.Class<T> clazz, org.bson.codecs.configuration.CodecRegistry registry)

@java.lang.Override RestClientMappingContext getMappingContext()

@java.lang.Override RxHttpClientBuilder getNativeInterface()

protected void initDefaultConverters(RestClientMappingContext mappingContext)

protected void initialize(RestClientMappingContext mappingContext)

@java.lang.Override boolean isAllowBlockingOperations()

java.util.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse> prepareRequest(io.reactivex.netty.protocol.http.client.HttpClientRequest<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> httpClientRequest, InterceptorContext context)