MessageUtil (Couchbase Java DCP Client 0.36.0 API)

java.lang.Object
- java.lang.Enum<MessageUtil>
- - com.couchbase.client.dcp.message.MessageUtil

All Implemented Interfaces:

Serializable, Comparable<MessageUtil>
```
public enum MessageUtil
extends Enum<MessageUtil>
```

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`ACTIVE_EXTERNAL_USERS_OPCODE`
`static byte`	`AUTHENTICATE_OPCODE`
`static int`	`BODY_LENGTH_OFFSET`
`static int`	`CAS_OFFSET`
`static byte`	`CLUSTERMAP_CHANGE_NOTIFICATION_OPCODE`
`static int`	`DATA_TYPE_OFFSET`
`static byte`	`DCP_ADD_STREAM_OPCODE`
`static byte`	`DCP_BUFFER_ACK_OPCODE`
`static byte`	`DCP_CONTROL_OPCODE`
`static byte`	`DCP_DELETION_OPCODE`
`static byte`	`DCP_EXPIRATION_OPCODE`
`static byte`	`DCP_FAILOVER_LOG_OPCODE`
`static byte`	`DCP_FLUSH_OPCODE`
`static byte`	`DCP_MUTATION_OPCODE`
`static byte`	`DCP_NOOP_OPCODE`
`static byte`	`DCP_OSO_SNAPSHOT_MARKER_OPCODE`
`static byte`	`DCP_SEQNO_ADVANCED_OPCODE`
`static byte`	`DCP_SET_VBUCKET_STATE_OPCODE`
`static byte`	`DCP_SNAPSHOT_MARKER_OPCODE`
`static byte`	`DCP_STREAM_CLOSE_OPCODE`
`static byte`	`DCP_STREAM_END_OPCODE`
`static byte`	`DCP_STREAM_REQUEST_OPCODE`
`static byte`	`DCP_SYSTEM_EVENT_OPCODE`
`static int`	`EXTRAS_LENGTH_OFFSET`
`static byte`	`GET_CLUSTER_CONFIG_OPCODE`
`static byte`	`GET_COLLECTIONS_MANIFEST_OPCODE`
`static byte`	`GET_SEQNOS_OPCODE`
`static int`	`HEADER_SIZE`
`static byte`	`HELLO_OPCODE`
`static byte`	`INTERNAL_ROLLBACK_OPCODE`
`static int`	`KEY_LENGTH_OFFSET`
`static byte`	`MAGIC_INT`
`static byte`	`MAGIC_REQ`
`static byte`	`MAGIC_RES`
`static byte`	`MAGIC_SERVER_REQ`
`static byte`	`MAGIC_SERVER_RES`
`static byte`	`NOOP_OPCODE`
`static byte`	`OBSERVE_SEQNO_OPCODE`
`static int`	`OPAQUE_OFFSET`
`static byte`	`OPEN_CONNECTION_OPCODE`
`static byte`	`SASL_AUTH_OPCODE`
`static byte`	`SASL_LIST_MECHS_OPCODE`
`static byte`	`SASL_STEP_OPCODE`
`static byte`	`SELECT_BUCKET_OPCODE`
`static int`	`VBUCKET_OFFSET`
`static byte`	`VERSION_OPCODE`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static long`	`getCas(io.netty.buffer.ByteBuf buffer)`
`static CollectionIdAndKey`	`getCollectionIdAndKey(io.netty.buffer.ByteBuf buffer, boolean collectionsEnabled)`
`static io.netty.buffer.ByteBuf`	`getContent(io.netty.buffer.ByteBuf buffer)` Returns the message content, uncompressed.
`static ContentAndXattrs`	`getContentAndXattrs(io.netty.buffer.ByteBuf buffer)`
`static byte[]`	`getContentAsByteArray(io.netty.buffer.ByteBuf buffer)` Returns a new array containing the uncompressed content of the given message.
`static String`	`getContentAsString(io.netty.buffer.ByteBuf buffer)`
`static byte`	`getDataType(io.netty.buffer.ByteBuf buffer)`
`static io.netty.buffer.ByteBuf`	`getExtras(io.netty.buffer.ByteBuf buffer)`
`static io.netty.buffer.ByteBuf`	`getKey(io.netty.buffer.ByteBuf buffer)`
`static String`	`getKeyAsString(io.netty.buffer.ByteBuf buffer)`
`static int`	`getOpaque(io.netty.buffer.ByteBuf buffer)`
`static int`	`getOpcode(io.netty.buffer.ByteBuf buf)`
`static io.netty.buffer.ByteBuf`	`getRawContent(io.netty.buffer.ByteBuf buffer)` Returns the message content in its original form (possibly compressed).
`static ResponseStatus`	`getResponseStatus(io.netty.buffer.ByteBuf buffer)`
`static String`	`getShortOpcodeName(io.netty.buffer.ByteBuf buf)`
`static String`	`getShortOpcodeName(int opcode)`
`static short`	`getStatus(io.netty.buffer.ByteBuf buffer)` Deprecated. in favor of `getResponseStatus(ByteBuf)`
`static int`	`getVbucket(io.netty.buffer.ByteBuf buffer)`
`static String`	`humanize(io.netty.buffer.ByteBuf buffer)` Dumps the given ByteBuf in the "wire format".
`static void`	`initRequest(byte opcode, io.netty.buffer.ByteBuf buffer)` Helper method to initialize a request with an opcode.
`static void`	`initResponse(byte opcode, io.netty.buffer.ByteBuf buffer)` Helper method to initialize a response with an opcode.
`static boolean`	`isComplete(io.netty.buffer.ByteBuf buffer)` Returns true if message can be processed and false if more data is needed.
`static boolean`	`isSnappyCompressed(io.netty.buffer.ByteBuf buffer)`
`static boolean`	`requiresFlowControlAck(io.netty.buffer.ByteBuf message)`
`static void`	`setContent(byte[] content, io.netty.buffer.ByteBuf buffer)`
`static void`	`setContent(io.netty.buffer.ByteBuf content, io.netty.buffer.ByteBuf buffer)` Sets the content payload of the buffer, updating the content length as well.
`static void`	`setDataType(byte dataType, io.netty.buffer.ByteBuf buffer)`
`static void`	`setExtras(io.netty.buffer.ByteBuf extras, io.netty.buffer.ByteBuf buffer)`
`static void`	`setKey(String key, io.netty.buffer.ByteBuf buffer)` Helper method to set the key, update the key length and the content length.
`static void`	`setOpaque(int opaque, io.netty.buffer.ByteBuf buffer)`
`static void`	`setVbucket(int vbucket, io.netty.buffer.ByteBuf buffer)`
`static MessageUtil`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static MessageUtil[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Field Detail
- HEADER_SIZE
```
public static final int HEADER_SIZE
```
  See Also:
  
  Constant Field Values
- MAGIC_INT
```
public static final byte MAGIC_INT
```
  See Also:
  
  Constant Field Values
- MAGIC_REQ
```
public static final byte MAGIC_REQ
```
  See Also:
  
  Constant Field Values
- MAGIC_RES
```
public static final byte MAGIC_RES
```
  See Also:
  
  Constant Field Values
- MAGIC_SERVER_REQ
```
public static final byte MAGIC_SERVER_REQ
```
  See Also:
  
  Constant Field Values
- MAGIC_SERVER_RES
```
public static final byte MAGIC_SERVER_RES
```
  See Also:
  
  Constant Field Values
- KEY_LENGTH_OFFSET
```
public static final int KEY_LENGTH_OFFSET
```
  See Also:
  
  Constant Field Values
- EXTRAS_LENGTH_OFFSET
```
public static final int EXTRAS_LENGTH_OFFSET
```
  See Also:
  
  Constant Field Values
- DATA_TYPE_OFFSET
```
public static final int DATA_TYPE_OFFSET
```
  See Also:
  
  Constant Field Values
- VBUCKET_OFFSET
```
public static final int VBUCKET_OFFSET
```
  See Also:
  
  Constant Field Values
- BODY_LENGTH_OFFSET
```
public static final int BODY_LENGTH_OFFSET
```
  See Also:
  
  Constant Field Values
- OPAQUE_OFFSET
```
public static final int OPAQUE_OFFSET
```
  See Also:
  
  Constant Field Values
- CAS_OFFSET
```
public static final int CAS_OFFSET
```
  See Also:
  
  Constant Field Values
- NOOP_OPCODE
```
public static final byte NOOP_OPCODE
```
  See Also:
  
  Constant Field Values
- VERSION_OPCODE
```
public static final byte VERSION_OPCODE
```
  See Also:
  
  Constant Field Values
- HELLO_OPCODE
```
public static final byte HELLO_OPCODE
```
  See Also:
  
  Constant Field Values
- SASL_LIST_MECHS_OPCODE
```
public static final byte SASL_LIST_MECHS_OPCODE
```
  See Also:
  
  Constant Field Values
- SASL_AUTH_OPCODE
```
public static final byte SASL_AUTH_OPCODE
```
  See Also:
  
  Constant Field Values
- SASL_STEP_OPCODE
```
public static final byte SASL_STEP_OPCODE
```
  See Also:
  
  Constant Field Values
- GET_SEQNOS_OPCODE
```
public static final byte GET_SEQNOS_OPCODE
```
  See Also:
  
  Constant Field Values
- OPEN_CONNECTION_OPCODE
```
public static final byte OPEN_CONNECTION_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_ADD_STREAM_OPCODE
```
public static final byte DCP_ADD_STREAM_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_STREAM_CLOSE_OPCODE
```
public static final byte DCP_STREAM_CLOSE_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_STREAM_REQUEST_OPCODE
```
public static final byte DCP_STREAM_REQUEST_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_FAILOVER_LOG_OPCODE
```
public static final byte DCP_FAILOVER_LOG_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_STREAM_END_OPCODE
```
public static final byte DCP_STREAM_END_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_SNAPSHOT_MARKER_OPCODE
```
public static final byte DCP_SNAPSHOT_MARKER_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_MUTATION_OPCODE
```
public static final byte DCP_MUTATION_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_DELETION_OPCODE
```
public static final byte DCP_DELETION_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_EXPIRATION_OPCODE
```
public static final byte DCP_EXPIRATION_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_FLUSH_OPCODE
```
public static final byte DCP_FLUSH_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_SET_VBUCKET_STATE_OPCODE
```
public static final byte DCP_SET_VBUCKET_STATE_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_NOOP_OPCODE
```
public static final byte DCP_NOOP_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_BUFFER_ACK_OPCODE
```
public static final byte DCP_BUFFER_ACK_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_CONTROL_OPCODE
```
public static final byte DCP_CONTROL_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_SYSTEM_EVENT_OPCODE
```
public static final byte DCP_SYSTEM_EVENT_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_SEQNO_ADVANCED_OPCODE
```
public static final byte DCP_SEQNO_ADVANCED_OPCODE
```
  See Also:
  
  Constant Field Values
- DCP_OSO_SNAPSHOT_MARKER_OPCODE
```
public static final byte DCP_OSO_SNAPSHOT_MARKER_OPCODE
```
  See Also:
  
  Constant Field Values
- SELECT_BUCKET_OPCODE
```
public static final byte SELECT_BUCKET_OPCODE
```
  See Also:
  
  Constant Field Values
- OBSERVE_SEQNO_OPCODE
```
public static final byte OBSERVE_SEQNO_OPCODE
```
  See Also:
  
  Constant Field Values
- GET_CLUSTER_CONFIG_OPCODE
```
public static final byte GET_CLUSTER_CONFIG_OPCODE
```
  See Also:
  
  Constant Field Values
- GET_COLLECTIONS_MANIFEST_OPCODE
```
public static final byte GET_COLLECTIONS_MANIFEST_OPCODE
```
  See Also:
  
  Constant Field Values
- INTERNAL_ROLLBACK_OPCODE
```
public static final byte INTERNAL_ROLLBACK_OPCODE
```
  See Also:
  
  Constant Field Values
- CLUSTERMAP_CHANGE_NOTIFICATION_OPCODE
```
public static final byte CLUSTERMAP_CHANGE_NOTIFICATION_OPCODE
```
  See Also:
  
  Constant Field Values
- AUTHENTICATE_OPCODE
```
public static final byte AUTHENTICATE_OPCODE
```
  See Also:
  
  Constant Field Values
- ACTIVE_EXTERNAL_USERS_OPCODE
```
public static final byte ACTIVE_EXTERNAL_USERS_OPCODE
```
  See Also:
  
  Constant Field Values

Method Detail

values
```
public static MessageUtil[] values()
```
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (MessageUtil c : MessageUtil.values())
    System.out.println(c);
```
Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf
```
public static MessageUtil valueOf(String name)
```
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getOpcode

public static int getOpcode(io.netty.buffer.ByteBuf buf)

getShortOpcodeName

public static String getShortOpcodeName(int opcode)

getShortOpcodeName

public static String getShortOpcodeName(io.netty.buffer.ByteBuf buf)

isComplete
```
public static boolean isComplete(io.netty.buffer.ByteBuf buffer)
```
Returns true if message can be processed and false if more data is needed.

humanize
```
public static String humanize(io.netty.buffer.ByteBuf buffer)
```
Dumps the given ByteBuf in the "wire format".
Note that the response is undefined if a buffer with a different content than the KV protocol is passed in.

Returns:

the String ready to be printed/logged.

initRequest

public static void initRequest(byte opcode,
                               io.netty.buffer.ByteBuf buffer)

Helper method to initialize a request with an opcode.

initResponse

public static void initResponse(byte opcode,
                                io.netty.buffer.ByteBuf buffer)

Helper method to initialize a response with an opcode.

setExtras

public static void setExtras(io.netty.buffer.ByteBuf extras,
                             io.netty.buffer.ByteBuf buffer)

getExtras

public static io.netty.buffer.ByteBuf getExtras(io.netty.buffer.ByteBuf buffer)

setVbucket

public static void setVbucket(int vbucket,
                              io.netty.buffer.ByteBuf buffer)

getVbucket

public static int getVbucket(io.netty.buffer.ByteBuf buffer)

setKey

public static void setKey(String key,
                          io.netty.buffer.ByteBuf buffer)

Helper method to set the key, update the key length and the content length.

getKey

public static io.netty.buffer.ByteBuf getKey(io.netty.buffer.ByteBuf buffer)

getKeyAsString

public static String getKeyAsString(io.netty.buffer.ByteBuf buffer)

getCollectionIdAndKey

public static CollectionIdAndKey getCollectionIdAndKey(io.netty.buffer.ByteBuf buffer,
                                                       boolean collectionsEnabled)

setContent

public static void setContent(io.netty.buffer.ByteBuf content,
                              io.netty.buffer.ByteBuf buffer)

Sets the content payload of the buffer, updating the content length as well.

setContent

public static void setContent(byte[] content,
                              io.netty.buffer.ByteBuf buffer)

getRawContent
```
public static io.netty.buffer.ByteBuf getRawContent(io.netty.buffer.ByteBuf buffer)
```
Returns the message content in its original form (possibly compressed).
The returned buffer shares its reference count with the given buffer.

getContent
```
public static io.netty.buffer.ByteBuf getContent(io.netty.buffer.ByteBuf buffer)
```
Returns the message content, uncompressed.
Callers need not release the returned buffer, since it either shares its reference count with the given buffer, or is unpooled and not leak-aware.
If XATTRs were requested, they will be included in the returned buffer.

getContentAndXattrs

public static ContentAndXattrs getContentAndXattrs(io.netty.buffer.ByteBuf buffer)

isSnappyCompressed

public static boolean isSnappyCompressed(io.netty.buffer.ByteBuf buffer)

getContentAsString

public static String getContentAsString(io.netty.buffer.ByteBuf buffer)

getContentAsByteArray
```
public static byte[] getContentAsByteArray(io.netty.buffer.ByteBuf buffer)
```
Returns a new array containing the uncompressed content of the given message.
If XATTRs were requested, they will be included in the returned byte array.

getStatus

@Deprecated
public static short getStatus(io.netty.buffer.ByteBuf buffer)

Deprecated. in favor of getResponseStatus(ByteBuf)

getResponseStatus

public static ResponseStatus getResponseStatus(io.netty.buffer.ByteBuf buffer)

requiresFlowControlAck

public static boolean requiresFlowControlAck(io.netty.buffer.ByteBuf message)

getDataType

public static byte getDataType(io.netty.buffer.ByteBuf buffer)

setDataType

public static void setDataType(byte dataType,
                               io.netty.buffer.ByteBuf buffer)

setOpaque

public static void setOpaque(int opaque,
                             io.netty.buffer.ByteBuf buffer)

getOpaque

public static int getOpaque(io.netty.buffer.ByteBuf buffer)

getCas

public static long getCas(io.netty.buffer.ByteBuf buffer)

Enum MessageUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Field Detail

HEADER_SIZE

MAGIC_INT

MAGIC_REQ

MAGIC_RES

MAGIC_SERVER_REQ

MAGIC_SERVER_RES

KEY_LENGTH_OFFSET

EXTRAS_LENGTH_OFFSET

DATA_TYPE_OFFSET

VBUCKET_OFFSET

BODY_LENGTH_OFFSET

OPAQUE_OFFSET

CAS_OFFSET

NOOP_OPCODE

VERSION_OPCODE

HELLO_OPCODE

SASL_LIST_MECHS_OPCODE

SASL_AUTH_OPCODE

SASL_STEP_OPCODE

GET_SEQNOS_OPCODE

OPEN_CONNECTION_OPCODE

DCP_ADD_STREAM_OPCODE

DCP_STREAM_CLOSE_OPCODE

DCP_STREAM_REQUEST_OPCODE

DCP_FAILOVER_LOG_OPCODE

DCP_STREAM_END_OPCODE

DCP_SNAPSHOT_MARKER_OPCODE

DCP_MUTATION_OPCODE

DCP_DELETION_OPCODE

DCP_EXPIRATION_OPCODE

DCP_FLUSH_OPCODE

DCP_SET_VBUCKET_STATE_OPCODE

DCP_NOOP_OPCODE

DCP_BUFFER_ACK_OPCODE

DCP_CONTROL_OPCODE

DCP_SYSTEM_EVENT_OPCODE

DCP_SEQNO_ADVANCED_OPCODE

DCP_OSO_SNAPSHOT_MARKER_OPCODE

SELECT_BUCKET_OPCODE

OBSERVE_SEQNO_OPCODE

GET_CLUSTER_CONFIG_OPCODE

GET_COLLECTIONS_MANIFEST_OPCODE

INTERNAL_ROLLBACK_OPCODE

CLUSTERMAP_CHANGE_NOTIFICATION_OPCODE

AUTHENTICATE_OPCODE

ACTIVE_EXTERNAL_USERS_OPCODE

Method Detail

values

valueOf

getOpcode

getShortOpcodeName

getShortOpcodeName

isComplete

humanize

initRequest

initResponse

setExtras

getExtras

setVbucket

getVbucket

setKey

getKey

getKeyAsString

getCollectionIdAndKey

setContent

setContent

getRawContent

getContent

getContentAndXattrs

isSnappyCompressed

getContentAsString

getContentAsByteArray

getStatus

getResponseStatus