Command (AMPS Java Client (5.3.2.1.6d15937f.540279))

java.lang.Object
- com.crankuptheamps.client.Command

```
public class Command
extends java.lang.Object
```
Command is an encapsulation of a single AMPS command sent by the client. Using Command you can build commands to be executed by the client, with message processing happening either synchronously via the Client execute() method or asynchronously via the executeAsync() methods. Command is designed to be used as a "builder" enabling AMPS commands to be built easily, for example:
```
 Client client = new Client(...);
 for(Message m : client.execute(new Command("sow").setTopic("topic"))) { ... }
 
```
Notice that the Message class can represent both command messages to AMPS and response messages from AMPS. In contrast, Command represents only commands to AMPS, so the class includes only properties that are valid on outgoing commands.
Since:

4.0.0.0

Constructor Summary

Constructors
Constructor and Description
`Command()` Create a new Command with no command type or arguments set.
`Command(int command)` Create a Command with the Command field set.
`Command(java.lang.String command)` Create a Command with the Command field set.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Command`	`addAckType(int ackType)` Adds an additional ackType to the ackTypes already set for this Command.
`int`	`getAckType()` Get the ackType for this command.
`int`	`getBatchSize()` Get the batchSize set on this command.
`java.lang.String`	`getBookmark()` Get the bookmark for this command.
`long`	`getClientSequenceNumber()` Get the client sequence number set on this command.
`int`	`getCommand()` Return the command type for this command.
`CommandId`	`getCommandId()`
`java.lang.String`	`getCorrelationId()` Returns the correlation Id set on this command
`java.lang.String`	`getData()` Get the data set on this command.
`int`	`getExpiration()` Get the expiration set on this command.
`java.lang.String`	`getFilter()` Get the filter for this command.
`java.lang.String`	`getOptions()` Get the options for this command.
`java.lang.String`	`getOrderBy()` Get the orderBy clause for this command.
`CommandId`	`getQueryId()` Get the queryId for this command.
`java.lang.String`	`getSowKey()` Returns the SOW key on this command.
`java.lang.String`	`getSOWKey()` Deprecated. Use getSowKey() instead.
`java.lang.String`	`getSowKeys()` Returns the SOW key on this command.
`java.lang.String`	`getSOWKeys()` Deprecated. Use getSowKeys() instead
`CommandId`	`getSubId()` Get the subId set on this command.
`long`	`getTimeout()` Get the timeout set on this command.
`java.lang.String`	`getTopic()` Get the topic set on this command.
`int`	`getTopN()` Get the topN value for this command.
`boolean`	`hasExpiration()` Returns true if this command has an expiration set.
`boolean`	`isSow()` Returns true if this command queries a SOW.
`boolean`	`isSubscribe()` Returns true if this command creates a subscription.
`boolean`	`needsSequenceNumber()` Returns true if this command can be associated with a client sequence number.
`protected CommandId`	`prepare(Client client_)` Binds self to a given client, preparing a message from that client to be sent.
`Command`	`reset(int command)` Resets this command with a new Command type and re-initializes all other fields.
`Command`	`reset(java.lang.String command)` Resets this command with a new Command type and re-initializes all other fields.
`Command`	`setAckType(int ackType)` Set the ackType for this command.
`Command`	`setBatchSize(int batchSize)` Set the batchSize for this command.
`Command`	`setBookmark(java.lang.String bookmark)` Set the bookmark for this command.
`Command`	`setClientSequenceNumber(long seqNumber)` Sets the client sequence number for this command.
`Command`	`setCommand(int command)` Set the command type for this command.
`Command`	`setCommandId(CommandId commandId)` Set the commandId for this command.
`Command`	`setCorrelationId(java.lang.String correlationId_)` Sets the correlation Id for this command.
`Command`	`setData(byte[] data, int offset, int length)` Set the data for this command.
`Command`	`setData(CompositeMessageBuilder builder)` Set the data for this command.
`Command`	`setData(java.lang.String data)` Set the data for this command.
`Command`	`setExpiration(int expiration)` Set the expiration for this command.
`Command`	`setFilter(java.lang.String filter)` Set the filter for this command.
`Command`	`setOptions(java.lang.String options)` Set the options for this command.
`Command`	`setOrderBy(java.lang.String orderBy)` Set the orderBy clause for this command.
`Command`	`setQueryId(CommandId queryId)` Set the queryId for this command.
`Command`	`setSowKey(java.lang.String sowKey)` The SowKey for a command is used to publish to a SOW topic with explicit keys set by the user rather than AMPS.
`Command`	`setSOWKey(java.lang.String sowKey)` Deprecated. Use setSowKey() instead.
`Command`	`setSowKeys(java.lang.String sowKeys)` The SowKeys for a command are a comma-separated list of the keys that AMPS assigns to SOW messages.
`Command`	`setSOWKeys(java.lang.String sowKeys)` Deprecated. Use setSowKeys() instead.
`Command`	`setSubId(CommandId subId)` Set the subId for this command.
`Command`	`setSubId(java.lang.String subId)` Set the subId for this command.
`Command`	`setTimeout(long timeout)` Set the timeout for this command (in milliseconds).
`Command`	`setTopic(byte[] topic, int offset, int length)` Set the topic for this command from raw bytes.
`Command`	`setTopic(java.lang.String topic)` Set the topic for this command.
`Command`	`setTopN(int topN)` Set the topN value for this command.
`void`	`unsetExpiration()` Clears any expiration value set on self.

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

- Constructor Detail
  - Command
```
public Command()
```
    Create a new Command with no command type or arguments set.
    
    Since:
    
    4.0.0.0
  - Command
```
public Command(int command)
```
    Create a Command with the Command field set.
    
    Parameters:
    
    command - A Message.Command value indicating the AMPS command.
    
    Since:
    
    4.0.0.0
  - Command
```
public Command(java.lang.String command)
```
    Create a Command with the Command field set.
    
    Parameters:
    
    command - A string indicating the AMPS command.
    
    Since:
    
    4.0.0.0
- Method Detail
  - getSOWKey
```
@Deprecated
public java.lang.String getSOWKey()
```
    Deprecated. Use getSowKey() instead.
    
    Returns the SOW key on this command.
    
    Returns:
    
    the sow key
    
    Since:
    
    4.0.0.0
  - getSowKey
```
public java.lang.String getSowKey()
```
    Returns the SOW key on this command.
    
    Returns:
    
    the sow key
    
    Since:
    
    5.0.0.0
  - setSOWKey
```
@Deprecated
public Command setSOWKey(java.lang.String sowKey)
```
    Deprecated. Use setSowKey() instead.
    
    The SowKey for a command is used to publish to a SOW topic with explicit keys set by the user rather than AMPS. The SOW key for a message is available through the Message.getSowKey() method on a message.
    
    Parameters:
    
    sowKey - the sow key to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.3.0.0
  - setSowKey
```
public Command setSowKey(java.lang.String sowKey)
```
    The SowKey for a command is used to publish to a SOW topic with explicit keys set by the user rather than AMPS. The SOW key for a message is available through the Message.getSowKey() method on a message.
    
    Parameters:
    
    sowKey - the sow key to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    5.0.0.0
  - getSowKeys
```
public java.lang.String getSowKeys()
```
    Returns the SOW key on this command.
    
    Returns:
    
    the sow key
    
    Since:
    
    5.0.0.0
  - getSOWKeys
```
@Deprecated
public java.lang.String getSOWKeys()
```
    Deprecated. Use getSowKeys() instead
    
    Returns the SOW key on this command.
    
    Returns:
    
    the sow key
    
    Since:
    
    4.3.0.0
  - setSowKeys
```
public Command setSowKeys(java.lang.String sowKeys)
```
    The SowKeys for a command are a comma-separated list of the keys that AMPS assigns to SOW messages. The SOW key for a message is available through the Message.getSowKey() method on a message.
    
    Parameters:
    
    sowKeys - the sow keys to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    5.0.0.0
  - setSOWKeys
```
@Deprecated
public Command setSOWKeys(java.lang.String sowKeys)
```
    Deprecated. Use setSowKeys() instead.
    
    The SowKeys for a command are a comma-separated list of the keys that AMPS assigns to SOW messages. The SOW key for a message is available through the Message.getSowKey() method on a message.
    
    Parameters:
    
    sowKeys - the sow keys to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - isSubscribe
```
public final boolean isSubscribe()
```
    Returns true if this command creates a subscription.
    
    Returns:
    
    true if this command creates a subscription.
    
    Since:
    
    4.0.0.0
  - isSow
```
public final boolean isSow()
```
    Returns true if this command queries a SOW.
    
    Returns:
    
    true if this command queries a SOW.
    
    Since:
    
    4.0.0.0
  - needsSequenceNumber
```
public boolean needsSequenceNumber()
```
    Returns true if this command can be associated with a client sequence number.
    
    Returns:
    
    true if this command can be associated with a client sequence number.
    
    Since:
    
    4.0.0.0
  - reset
```
public Command reset(int command)
```
    Resets this command with a new Command type and re-initializes all other fields.
    
    Parameters:
    
    command - A Message.Command value indicating the AMPS command.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - reset
```
public Command reset(java.lang.String command)
```
    Resets this command with a new Command type and re-initializes all other fields.
    
    Parameters:
    
    command - A string value indicating the AMPS command.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getCommandId
```
public CommandId getCommandId()
```
    Returns:
    
    the commandId, which is automatically generated for some command types.
    
    Since:
    
    4.0.0.0
  - setCommandId
```
public Command setCommandId(CommandId commandId)
```
    Set the commandId for this command.
    
    Parameters:
    
    commandId - the commandId to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getQueryId
```
public CommandId getQueryId()
```
    Get the queryId for this command.
    
    Returns:
    
    the queryId
    
    Since:
    
    4.0.0.0
  - setQueryId
```
public Command setQueryId(CommandId queryId)
```
    Set the queryId for this command.
    
    Parameters:
    
    queryId - the queryId to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getCommand
```
public int getCommand()
```
    Return the command type for this command.
    
    Returns:
    
    the command
    
    Since:
    
    4.0.0.0
  - setCommand
```
public Command setCommand(int command)
```
    Set the command type for this command.
    
    Parameters:
    
    command - the command to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getTopic
```
public java.lang.String getTopic()
```
    Get the topic set on this command.
    
    Returns:
    
    the topic
    
    Since:
    
    4.0.0.0
  - setTopic
```
public Command setTopic(java.lang.String topic)
```
    Set the topic for this command.
    
    Parameters:
    
    topic - the topic to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - setTopic
```
public Command setTopic(byte[] topic,
                        int offset,
                        int length)
```
    Set the topic for this command from raw bytes.
    
    Parameters:
    
    topic - The raw bytes to be used for the topic.
    
    offset - The offset into topic where the topic data begins
    
    length - The length of the topic.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getFilter
```
public java.lang.String getFilter()
```
    Get the filter for this command.
    
    Returns:
    
    the filter
    
    Since:
    
    4.0.0.0
  - setFilter
```
public Command setFilter(java.lang.String filter)
```
    Set the filter for this command.
    
    Parameters:
    
    filter - the filter to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    Get the orderBy clause for this command.
    
    Returns:
    
    the orderBy
    
    Since:
    
    4.0.0.0
  - setOrderBy
```
public Command setOrderBy(java.lang.String orderBy)
```
    Set the orderBy clause for this command.
    
    Parameters:
    
    orderBy - the orderBy to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getSubId
```
public CommandId getSubId()
```
    Get the subId set on this command.
    
    Returns:
    
    the subId
    
    Since:
    
    4.0.0.0
  - setSubId
```
public Command setSubId(CommandId subId)
```
    Set the subId for this command.
    
    Parameters:
    
    subId - the subId to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - setSubId
```
public Command setSubId(java.lang.String subId)
```
    Set the subId for this command.
    
    Parameters:
    
    subId - the subId to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getBookmark
```
public java.lang.String getBookmark()
```
    Get the bookmark for this command.
    
    Returns:
    
    the bookmark
    
    Since:
    
    4.0.0.0
  - setBookmark
```
public Command setBookmark(java.lang.String bookmark)
```
    Set the bookmark for this command.
    
    Parameters:
    
    bookmark - the bookmark to set
    
    Returns:
    
    Returns the instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getOptions
```
public java.lang.String getOptions()
```
    Get the options for this command.
    
    Returns:
    
    the options
    
    Since:
    
    4.0.0.0
  - setOptions
```
public Command setOptions(java.lang.String options)
```
    Set the options for this command. Options are a comma-delimited list.
    
    Parameters:
    
    options - the options to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getAckType
```
public int getAckType()
```
    Get the ackType for this command.
    
    Returns:
    
    the ackType
    
    Since:
    
    4.0.0.0
  - setAckType
```
public Command setAckType(int ackType)
```
    Set the ackType for this command. Different ackTypes are supported for each command. See the Command Reference for details.
    
    Parameters:
    
    ackType - the ackType to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - addAckType
```
public Command addAckType(int ackType)
```
    Adds an additional ackType to the ackTypes already set for this Command.
    
    Parameters:
    
    ackType - the ackType to add
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getData
```
public java.lang.String getData()
```
    Get the data set on this command.
    
    Returns:
    
    the data
    
    Since:
    
    4.0.0.0
  - setData
```
public Command setData(java.lang.String data)
```
    Set the data for this command.
    
    Parameters:
    
    data - the data to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - setData
```
public Command setData(byte[] data,
                       int offset,
                       int length)
```
    Set the data for this command.
    
    Parameters:
    
    data - The raw bytes to be used for the data.
    
    offset - The offset into data where the data begins.
    
    length - The length of the data.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - setData
```
public Command setData(CompositeMessageBuilder builder)
```
    Set the data for this command.
    
    Parameters:
    
    builder - a CompositeMessageBuilder to set self's data from.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - getTimeout
```
public long getTimeout()
```
    Get the timeout set on this command.
    
    Returns:
    
    the timeout
    
    Since:
    
    4.0.0.0
  - setTimeout
```
public Command setTimeout(long timeout)
```
    Set the timeout for this command (in milliseconds). If the client does not receive and consume a processed ack within the specified timeout, this method throws an exception. Notice that the timeout is monitored in the AMPS client, not on the server, and the client receive thread receives and consumes the ack from the server.
    
    Parameters:
    
    timeout - the timeout to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getTopN
```
public int getTopN()
```
    Get the topN value for this command.
    
    Returns:
    
    the topN
    
    Since:
    
    4.0.0.0
  - setTopN
```
public Command setTopN(int topN)
```
    Set the topN value for this command. This parameter sets a maximum number of records returned by a SOW query.
    
    Parameters:
    
    topN - the topN to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getBatchSize
```
public int getBatchSize()
```
    Get the batchSize set on this command.
    
    Returns:
    
    the batchSize
    
    Since:
    
    4.0.0.0
  - setBatchSize
```
public Command setBatchSize(int batchSize)
```
    Set the batchSize for this command. This sets the number of records returned in a batch during a SOW query.
    
    Parameters:
    
    batchSize - the batchSize to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getExpiration
```
public int getExpiration()
```
    Get the expiration set on this command. This method returns 0 if no expiration is set. Use hasExpiration() to check if an expiration is set.
    
    Returns:
    
    the expiration
    
    Since:
    
    4.0.0.0
  - hasExpiration
```
public boolean hasExpiration()
```
    Returns true if this command has an expiration set.
    
    Returns:
    
    true if an expiration is set.
    
    Since:
    
    4.0.0.0
  - setExpiration
```
public Command setExpiration(int expiration)
```
    Set the expiration for this command. For a publish command to a SOW topic or a queue, the expiration sets the amount of time to retain the message in the SOW or the queue.
    
    Parameters:
    
    expiration - the expiration to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - unsetExpiration
```
public void unsetExpiration()
```
    Clears any expiration value set on self.
    
    Since:
    
    4.0.0.0
  - prepare
```
protected CommandId prepare(Client client_)
                     throws AMPSException
```
    Binds self to a given client, preparing a message from that client to be sent.
    
    Parameters:
    
    client_ - The client to bind against
    
    Returns:
    
    The CommandId for this command, if one is set, or null.
    
    Throws:
    
    AMPSException - Thrown when preparing the command fails.
    
    Since:
    
    4.0.0.0
  - setClientSequenceNumber
```
public Command setClientSequenceNumber(long seqNumber)
```
    Sets the client sequence number for this command.
    
    Parameters:
    
    seqNumber - Sequence number for this command
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getClientSequenceNumber
```
public long getClientSequenceNumber()
```
    Get the client sequence number set on this command.
    
    Returns:
    
    the client sequence number generated for this command, or 0 if none was generated.
    
    Since:
    
    4.0.0.0
  - setCorrelationId
```
public Command setCorrelationId(java.lang.String correlationId_)
```
    Sets the correlation Id for this command. The correlation ID is an arbitrary string that can be used for whatever purpose the application needs. It is not interpreted or used by AMPS. However, the correlation ID must only contain characters that are valid base64 encoded characters.
    
    Parameters:
    
    correlationId_ - The CorrelationId is a user provided string included in the log message for a logon. AMPS does not interpret or use this string for any other purpose.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
    
    Since:
    
    4.0.0.0
  - getCorrelationId
```
public java.lang.String getCorrelationId()
```
    Returns the correlation Id set on this command
    
    Returns:
    
    Returns the correlation id
    
    Since:
    
    4.0.0.0

Class Command

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Command

Command

Command

Method Detail

getSOWKey

getSowKey

setSOWKey

setSowKey

getSowKeys

getSOWKeys

setSowKeys

setSOWKeys

isSubscribe

isSow

needsSequenceNumber

reset

reset

getCommandId

setCommandId

getQueryId

setQueryId

getCommand

setCommand

getTopic

setTopic

setTopic

getFilter

setFilter

getOrderBy

setOrderBy

getSubId

setSubId

setSubId

getBookmark

setBookmark

getOptions

setOptions

getAckType

setAckType

addAckType

getData

setData

setData

setData

getTimeout

setTimeout

getTopN

setTopN

getBatchSize

setBatchSize

getExpiration

hasExpiration

setExpiration

unsetExpiration

prepare

setClientSequenceNumber

getClientSequenceNumber

setCorrelationId

getCorrelationId