com.couchbase.client.core.message

Class AbstractCouchbaseRequest

java.lang.Object

com.couchbase.client.core.message.AbstractCouchbaseRequest

All Implemented Interfaces:

CouchbaseMessage, CouchbaseRequest

Direct Known Subclasses:

AbstractDCPRequest, AbstractKeyValueRequest, AddNodeRequest, AddServiceRequest, AnalyticsHandler.KeepAliveRequest, BucketConfigRequest, BucketsConfigRequest, BucketStreamingRequest, CloseBucketRequest, ClusterConfigRequest, DisconnectRequest, FlushRequest, GenericAnalyticsRequest, GenericQueryRequest, GetClusterConfigRequest, GetConfigProviderRequest, GetDesignDocumentRequest, GetDesignDocumentsRequest, GetSearchIndexRequest, GetUsersRequest, InsertBucketRequest, OpenBucketRequest, OpenConnectionRequest, 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

Modifier and Type	Method and Description
String	bucket() The associated bucket name for this request.
long	creationTime() Returns the time in nanoseconds when the message was created.
int	incrementRetryCount() Returns the old retry count and increments it by one.
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	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
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

toString

public String toString()

Overrides:

toString in class Object