Consumer (Red Hat JBoss Enterprise Application Platform 8.0.0.GA public API)

java.lang.Object
- org.apache.activemq.artemis.cli.commands.ActionAbstract
- - org.apache.activemq.artemis.cli.commands.InputAbstract
  - - org.apache.activemq.artemis.cli.commands.messages.ConnectionAbstract
    - - org.apache.activemq.artemis.cli.commands.messages.DestAbstract
      - org.apache.activemq.artemis.cli.commands.messages.Consumer

All Implemented Interfaces:: Action

@Command(name="consumer",
         description="It will consume messages from an instance")
public class Consumer
extends DestAbstract

Field Summary
- Fields inherited from class org.apache.activemq.artemis.cli.commands.messages.ConnectionAbstract
  acceptor, brokerURL, clientID, password, protocol, user
- Fields inherited from class org.apache.activemq.artemis.cli.commands.ActionAbstract
  context, DEFAULT_BROKER_ACCEPTOR, DEFAULT_BROKER_URL, verbose

Constructor Summary

Constructors
Constructor Description

Consumer()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Object`	`execute(ActionContext context)`
`String`	`getFile()`
`String`	`getFilter()`
`int`	`getReceiveTimeout()`
`boolean`	`isBreakOnNull()`
`boolean`	`isDurable()`
`Consumer`	`setBreakOnNull(boolean breakOnNull)`
`Consumer`	`setDurable(boolean durable)`
`Consumer`	`setFile(String file)`
`Consumer`	`setFilter(String filter)`
`Consumer`	`setReceiveTimeout(int receiveTimeout)`

Methods inherited from class org.apache.activemq.artemis.cli.commands.messages.DestAbstract
getDestination, getDestination, getDestination, getMessageCount, getMessageSerializer, getSerializer, getSleep, getThreads, getTxBatchSize, setDestination, setMessageCount, setSerializer, setSleep, setThreads, setTxBatchSize, stripPrefix

Methods inherited from class org.apache.activemq.artemis.cli.commands.messages.ConnectionAbstract
createConnectionFactory, createConnectionFactory, createCoreConnectionFactory, createCoreConnectionFactory, getAcceptor, getBrokerURL, getClientID, getPassword, getProtocol, getUser, setAcceptor, setBrokerURL, setClientID, setPassword, setProtocol, setUser

Methods inherited from class org.apache.activemq.artemis.cli.commands.InputAbstract
enableInput, input, input, inputBoolean, inputInteger, inputPassword, isSilentInput, setSilentInput

Methods inherited from class org.apache.activemq.artemis.cli.commands.ActionAbstract
checkOptions, getBrokerConfiguration, getBrokerEtc, getBrokerHome, getBrokerInstance, getBrokerURIInstance, getBrokerURLInstance, isVerbose, setHomeValues

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

Constructor Detail
- Consumer
```
public Consumer()
```

Method Detail

execute
```
public Object execute(ActionContext context)
               throws Exception
```
Specified by:

execute in interface Action

Overrides:

execute in class ConnectionAbstract

Throws:

Exception

isDurable
```
public boolean isDurable()
```

setDurable

public Consumer setDurable(boolean durable)

isBreakOnNull
```
public boolean isBreakOnNull()
```

setBreakOnNull

public Consumer setBreakOnNull(boolean breakOnNull)

getReceiveTimeout
```
public int getReceiveTimeout()
```

setReceiveTimeout

public Consumer setReceiveTimeout(int receiveTimeout)

getFilter
```
public String getFilter()
```

setFilter

public Consumer setFilter(String filter)

getFile
```
public String getFile()
```

setFile

public Consumer setFile(String file)