com.couchbase.client.core.message.kv

Class AbstractKeyValueRequest

java.lang.Object

com.couchbase.client.core.message.AbstractCouchbaseRequest

com.couchbase.client.core.message.kv.AbstractKeyValueRequest

All Implemented Interfaces:

CouchbaseMessage, CouchbaseRequest, BinaryRequest

Direct Known Subclasses:

AbstractSubdocRequest, AppendRequest, CounterRequest, GetAllMutationTokensRequest, GetBucketConfigRequest, GetRequest, InsertRequest, KeyValueHandler.KeepAliveRequest, ObserveRequest, ObserveSeqnoRequest, PrependRequest, RemoveRequest, ReplaceRequest, ReplicaGetRequest, StatRequest, SubMultiLookupRequest, SubMultiMutationRequest, TouchRequest, UnlockRequest, UpsertRequest

public abstract class AbstractKeyValueRequest
extends AbstractCouchbaseRequest
implements BinaryRequest

Default implementation of a BinaryRequest.

Since:

1.0

Author:

Michael Nitschinger

Field Summary

Fields

Modifier and Type	Field and Description
protected static short	DEFAULT_PARTITION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractKeyValueRequest(String key, String bucket, String password) Creates a new AbstractKeyValueRequest.
protected	AbstractKeyValueRequest(String key, String bucket, String password, Subject<CouchbaseResponse,CouchbaseResponse> observable) Creates a new AbstractKeyValueRequest.

Method Summary

Modifier and Type	Method and Description
String	key() The key of the document.
byte[]	keyBytes() The raw byte representation of the key.
int	opaque() A opaque value representing this request.
short	partition() The partition (vbucket) to use for this request.
BinaryRequest	partition(short partition) Set the partition ID.

Methods inherited from class com.couchbase.client.core.message.AbstractCouchbaseRequest

bucket, creationTime, incrementRetryCount, observable, password, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.couchbase.client.core.message.CouchbaseRequest

bucket, incrementRetryCount, observable, password

Methods inherited from interface com.couchbase.client.core.message.CouchbaseMessage

creationTime

Field Detail

DEFAULT_PARTITION

protected static final short DEFAULT_PARTITION

See Also:

Constant Field Values

Constructor Detail

AbstractKeyValueRequest

protected AbstractKeyValueRequest(String key,
                                  String bucket,
                                  String password)

Creates a new AbstractKeyValueRequest.

Parameters:

key - the key of the document.

bucket - the bucket of the document.

password - the optional password of the bucket.

AbstractKeyValueRequest

protected AbstractKeyValueRequest(String key,
                                  String bucket,
                                  String password,
                                  Subject<CouchbaseResponse,CouchbaseResponse> observable)

Creates a new AbstractKeyValueRequest.

Parameters:

key - the key of the document.

bucket - the bucket of the document.

password - the optional password of the bucket.

observable - the observable which receives responses.

Method Detail

key

public String key()

Description copied from interface: BinaryRequest

The key of the document.

Specified by:

key in interface BinaryRequest

Returns:

the key of the document, if set.

keyBytes

public byte[] keyBytes()

Description copied from interface: BinaryRequest

The raw byte representation of the key.

Specified by:

keyBytes in interface BinaryRequest

Returns:

the bytes of the key.

partition

public short partition()

Description copied from interface: BinaryRequest

The partition (vbucket) to use for this request.

Specified by:

partition in interface BinaryRequest

Returns:

the partition to use.

partition

public BinaryRequest partition(short partition)

Description copied from interface: BinaryRequest

Set the partition ID.

Specified by:

partition in interface BinaryRequest

Parameters:

partition - the id of the partition.

Returns:

the BinaryRequest for proper chaining.

opaque

public int opaque()

Description copied from interface: BinaryRequest

A opaque value representing this request.

Specified by:

opaque in interface BinaryRequest

Returns:

an automatically generated opaque value.