AbstractCouchbaseRequest (Couchbase JVM Core IO 1.7.2 API)

java.lang.Object
- com.couchbase.client.core.message.AbstractCouchbaseRequest

All Implemented Interfaces:

CouchbaseMessage, CouchbaseRequest

Direct Known Subclasses:

AbstractKeyValueRequest, AddNodeRequest, AddServiceRequest, AnalyticsHandler.KeepAliveRequest, AnalyticsHandlerV2.KeepAliveRequest, AnalyticsQueryResultRequest, AnalyticsQueryStatusRequest, BucketConfigRequest, BucketsConfigRequest, BucketStreamingRequest, CloseBucketRequest, ClusterConfigRequest, DiagnosticsRequest, DisconnectRequest, FlushRequest, GenericAnalyticsRequest, GenericQueryRequest, GetClusterConfigRequest, GetConfigProviderRequest, GetDesignDocumentRequest, GetDesignDocumentsRequest, GetSearchIndexRequest, GetUsersRequest, InsertBucketRequest, OpenBucketRequest, PingRequest, PingRequest, PingRequest, PingRequest, QueryHandler.KeepAliveRequest, QueryHandlerV2.KeepAliveRequest, RemoveBucketRequest, RemoveDesignDocumentRequest, RemoveNodeRequest, RemoveSearchIndexRequest, RemoveServiceRequest, RemoveUserRequest, RestApiRequest, SearchHandler.KeepAliveRequest, SearchQueryRequest, SeedNodesRequest, SignalConfigReload, SignalFlush, UpdateBucketRequest, UpsertDesignDocumentRequest, UpsertSearchIndexRequest, UpsertUserRequest, ViewHandler.KeepAliveRequest, ViewQueryRequest
```
public abstract class AbstractCouchbaseRequest
extends Object
implements CouchbaseRequest
```
Default implementation for a CouchbaseRequest, should be extended by child messages.

Since:

1.0

Author:

Michael Nitschinger

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractCouchbaseRequest(String bucket, String password)` Create a new `AbstractCouchbaseRequest`.
`protected`	`AbstractCouchbaseRequest(String bucket, String username, String password)` Create a new `AbstractCouchbaseRequest`.
`protected`	`AbstractCouchbaseRequest(String bucket, String username, String password, rx.subjects.Subject<CouchbaseResponse,CouchbaseResponse> observable)` Create a new `AbstractCouchbaseRequest`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`afterSpanSet(io.opentracing.Span span)` Use this method to add custom span values on insert.
`String`	`bucket()` The associated bucket name for this request.
`void`	`complete()` Completes the underlying state holder.
`long`	`creationTime()` Returns the time in nanoseconds when the message was created.
`String`	`dispatchHostname()`
`void`	`dispatchHostname(String hostname)`
`void`	`emit(CouchbaseResponse response)` Emits the `CouchbaseResponse` into the underlying state holder (like a subject) without completing it as per contract.
`void`	`fail(Throwable throwable)` Fails the `CouchbaseResponse` on the state holder as per contract.
`int`	`incrementRetryCount()` Returns the old retry count and increments it by one.
`boolean`	`isActive()` Checks if the request is unsubscribed on a timeout
`String`	`lastLocalId()`
`void`	`lastLocalId(String localId)`
`String`	`lastLocalSocket()`
`void`	`lastLocalSocket(String local)`
`String`	`lastRemoteSocket()`
`void`	`lastRemoteSocket(String remote)`
`long`	`maxRetryDuration()` Returns the maximum retry duration for the request.
`void`	`maxRetryDuration(long maxRetryDuration)` Sets the maximum retry duration for the request.
`rx.subjects.Subject<CouchbaseResponse,CouchbaseResponse>`	`observable()` Get the underlying `Observable`.
`String`	`operationId()` Default implementation, sub requests need to override this.
`String`	`password()` The password associated with the bucket/ user
`long`	`retryAfter()` Gets the initial retry after time for the request.
`void`	`retryAfter(long after)` Sets the initial retry after time for the request.
`int`	`retryCount()` Returns the current retry count.
`Delay`	`retryDelay()` Returns the retry delay config
`void`	`retryDelay(Delay retryDelay)` Sets the retry delay config
`io.opentracing.Span`	`span()` Returns the `Span` for this request if set.
`void`	`span(io.opentracing.Span span, CoreEnvironment env)` Allows to set a custom span that should be used.
`void`	`subscriber(rx.Subscriber subscriber)` Optionally add subscriber to check for the timeouts
`void`	`succeed(CouchbaseResponse response)` Emits the `CouchbaseResponse` into the underlying state holder (like a subject) and completes it as well per contract.
`String`	`toString()`
`String`	`username()` User authorized for bucket access

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AbstractCouchbaseRequest
```
protected AbstractCouchbaseRequest(String bucket,
                                   String password)
```
    Create a new AbstractCouchbaseRequest. Depending on the type of operation, bucket and password may be null, this needs to be enforced properly by the child implementations. This constructor will create a AsyncSubject, which implies that the response for this request only emits one message. If you need to expose a streaming response, use the other constructor and feed it a ReplaySubject or something similar.
    
    Parameters:
    
    bucket - the name of the bucket.
    
    password - user password.
  - AbstractCouchbaseRequest
```
protected AbstractCouchbaseRequest(String bucket,
                                   String username,
                                   String password)
```
    Create a new AbstractCouchbaseRequest. Depending on the type of operation, bucket and password may be null, this needs to be enforced properly by the child implementations. This constructor will create a AsyncSubject, which implies that the response for this request only emits one message. If you need to expose a streaming response, use the other constructor and feed it a ReplaySubject or something similar.
    
    Parameters:
    
    bucket - the name of the bucket.
    
    username - user authorized to access the bucket.
    
    password - user password.
  - AbstractCouchbaseRequest
```
protected AbstractCouchbaseRequest(String bucket,
                                   String username,
                                   String password,
                                   rx.subjects.Subject<CouchbaseResponse,CouchbaseResponse> observable)
```
    Create a new AbstractCouchbaseRequest. Depending on the type of operation, bucket and password may be null, this needs to be enforced properly by the child implementations.
    
    Parameters:
    
    bucket - the name of the bucket.
    
    username - user authorized to access the bucket.
    
    password - the password of the bucket.
- Method Detail
  - observable
```
public rx.subjects.Subject<CouchbaseResponse,CouchbaseResponse> observable()
```
    Description copied from interface: CouchbaseRequest
    
    Get the underlying Observable.
    
    Specified by:
    
    observable in interface CouchbaseRequest
    
    Returns:
    
    the observable which will complete the response.
  - bucket
```
public String bucket()
```
    Description copied from interface: CouchbaseRequest
    
    The associated bucket name for this request.
    
    Specified by:
    
    bucket in interface CouchbaseRequest
    
    Returns:
    
    the bucket name.
  - username
```
public String username()
```
    Description copied from interface: CouchbaseRequest
    
    User authorized for bucket access
    
    Specified by:
    
    username in interface CouchbaseRequest
  - password
```
public String password()
```
    Description copied from interface: CouchbaseRequest
    
    The password associated with the bucket/ user
    
    Specified by:
    
    password in interface CouchbaseRequest
    
    Returns:
    
    the password.
  - creationTime
```
public long creationTime()
```
    Description copied from interface: CouchbaseMessage
    
    Returns the time in nanoseconds when the message was created.
    
    Specified by:
    
    creationTime in interface CouchbaseMessage
    
    Returns:
    
    the creation time in nanoseconds.
  - incrementRetryCount
```
public int incrementRetryCount()
```
    Description copied from interface: CouchbaseRequest
    
    Returns the old retry count and increments it by one.
    
    Specified by:
    
    incrementRetryCount in interface CouchbaseRequest
    
    Returns:
    
    the old retryCount.
  - retryCount
```
public int retryCount()
```
    Description copied from interface: CouchbaseRequest
    
    Returns the current retry count.
    
    Specified by:
    
    retryCount in interface CouchbaseRequest
    
    Returns:
    
    the current retry count.
  - retryAfter
```
public void retryAfter(long after)
```
    Description copied from interface: CouchbaseRequest
    
    Sets the initial retry after time for the request.
    
    Specified by:
    
    retryAfter in interface CouchbaseRequest
  - retryAfter
```
public long retryAfter()
```
    Description copied from interface: CouchbaseRequest
    
    Gets the initial retry after time for the request.
    
    Specified by:
    
    retryAfter in interface CouchbaseRequest
  - maxRetryDuration
```
public void maxRetryDuration(long maxRetryDuration)
```
    Description copied from interface: CouchbaseRequest
    
    Sets the maximum retry duration for the request.
    
    Specified by:
    
    maxRetryDuration in interface CouchbaseRequest
  - maxRetryDuration
```
public long maxRetryDuration()
```
    Description copied from interface: CouchbaseRequest
    
    Returns the maximum retry duration for the request.
    
    Specified by:
    
    maxRetryDuration in interface CouchbaseRequest
    
    Returns:
    
    duration
  - retryDelay
```
public void retryDelay(Delay retryDelay)
```
    Description copied from interface: CouchbaseRequest
    
    Sets the retry delay config
    
    Specified by:
    
    retryDelay in interface CouchbaseRequest
  - retryDelay
```
public Delay retryDelay()
```
    Description copied from interface: CouchbaseRequest
    
    Returns the retry delay config
    
    Specified by:
    
    retryDelay in interface CouchbaseRequest
    
    Returns:
    
    delay
  - isActive
```
public boolean isActive()
```
    Description copied from interface: CouchbaseRequest
    
    Checks if the request is unsubscribed on a timeout
    
    Specified by:
    
    isActive in interface CouchbaseRequest
    
    Returns:
    
    false if timed out, else true
  - subscriber
```
public void subscriber(rx.Subscriber subscriber)
```
    Description copied from interface: CouchbaseRequest
    
    Optionally add subscriber to check for the timeouts
    
    Specified by:
    
    subscriber in interface CouchbaseRequest
  - dispatchHostname
```
public String dispatchHostname()
```
    Specified by:
    
    dispatchHostname in interface CouchbaseRequest
  - dispatchHostname
```
public void dispatchHostname(String hostname)
```
    Specified by:
    
    dispatchHostname in interface CouchbaseRequest
  - emit
```
public void emit(CouchbaseResponse response)
```
    Description copied from interface: CouchbaseRequest
    
    Emits the CouchbaseResponse into the underlying state holder (like a subject) without completing it as per contract.
    
    Specified by:
    
    emit in interface CouchbaseRequest
    
    Parameters:
    
    response - the response to emit.
  - complete
```
public void complete()
```
    Description copied from interface: CouchbaseRequest
    
    Completes the underlying state holder.
    
    Specified by:
    
    complete in interface CouchbaseRequest
  - succeed
```
public void succeed(CouchbaseResponse response)
```
    Description copied from interface: CouchbaseRequest
    
    Emits the CouchbaseResponse into the underlying state holder (like a subject) and completes it as well per contract. Its basically a shortcut for CouchbaseRequest.emit(CouchbaseResponse) followed by CouchbaseRequest.complete().
    
    Specified by:
    
    succeed in interface CouchbaseRequest
    
    Parameters:
    
    response - the response to emit and complete.
  - fail
```
public void fail(Throwable throwable)
```
    Description copied from interface: CouchbaseRequest
    
    Fails the CouchbaseResponse on the state holder as per contract.
    
    Specified by:
    
    fail in interface CouchbaseRequest
    
    Parameters:
    
    throwable - the throwable to fail the response with.
  - span
```
public io.opentracing.Span span()
```
    Description copied from interface: CouchbaseRequest
    
    Returns the Span for this request if set.
    
    Specified by:
    
    span in interface CouchbaseRequest
    
    Returns:
    
    the span used.
  - span
```
public void span(io.opentracing.Span span,
                 CoreEnvironment env)
```
    Description copied from interface: CouchbaseRequest
    
    Allows to set a custom span that should be used.
    
    Specified by:
    
    span in interface CouchbaseRequest
    
    Parameters:
    
    span - the span to use.
    
    env - the core env used for context-sensitive stuff, may be null.
  - lastLocalSocket
```
public String lastLocalSocket()
```
    Specified by:
    
    lastLocalSocket in interface CouchbaseRequest
  - lastRemoteSocket
```
public String lastRemoteSocket()
```
    Specified by:
    
    lastRemoteSocket in interface CouchbaseRequest
  - lastLocalId
```
public String lastLocalId()
```
    Specified by:
    
    lastLocalId in interface CouchbaseRequest
  - lastLocalSocket
```
public void lastLocalSocket(String local)
```
    Specified by:
    
    lastLocalSocket in interface CouchbaseRequest
  - lastRemoteSocket
```
public void lastRemoteSocket(String remote)
```
    Specified by:
    
    lastRemoteSocket in interface CouchbaseRequest
  - lastLocalId
```
public void lastLocalId(String localId)
```
    Specified by:
    
    lastLocalId in interface CouchbaseRequest
  - afterSpanSet
```
protected void afterSpanSet(io.opentracing.Span span)
```
    Use this method to add custom span values on insert.
  - operationId
```
public String operationId()
```
    Default implementation, sub requests need to override this.
    
    Specified by:
    
    operationId in interface CouchbaseRequest
    
    Returns:
    
    the operation id or null.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractCouchbaseRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractCouchbaseRequest

AbstractCouchbaseRequest

AbstractCouchbaseRequest

Method Detail

observable

bucket

username

password

creationTime

incrementRetryCount

retryCount

retryAfter

retryAfter

maxRetryDuration

maxRetryDuration

retryDelay

retryDelay

isActive

subscriber

dispatchHostname

dispatchHostname

emit

complete

succeed

fail

span

span

lastLocalSocket

lastRemoteSocket

lastLocalId

lastLocalSocket

lastRemoteSocket

lastLocalId

afterSpanSet

operationId

toString