ListCommand (ActiveMQ 5.17.0 API)

java.lang.Object
- org.apache.activemq.console.command.AbstractCommand
- - org.apache.activemq.console.command.AbstractJmxCommand
  - - org.apache.activemq.console.command.ListCommand

All Implemented Interfaces:: Command

public class ListCommand
extends AbstractJmxCommand

Field Summary

Fields
Modifier and Type Field Description

protected String[] helpFile
- Fields inherited from class org.apache.activemq.console.command.AbstractJmxCommand
  DEFAULT_JMX_URL
- Fields inherited from class org.apache.activemq.console.command.AbstractCommand
  COMMAND_OPTION_DELIMETER, context

Constructor Summary

Constructors
Constructor Description

ListCommand()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getName()`
`String`	`getOneLineDescription()`
`protected void`	`printHelp()`	Print the help messages for the browse command
`protected void`	`runTask(List tokens)`	List all running brokers registered in the specified JMX context

Methods inherited from class org.apache.activemq.console.command.AbstractJmxCommand
closeJmxConnection, createJmxConnection, execute, findJMXUrlByProcessId, getJmxPassword, getJmxServiceUrl, getJmxUser, getJVM, handleOption, isJmxUseLocal, isSunJVM, setJmxPassword, setJmxServiceUrl, setJmxServiceUrl, setJmxUseLocal, setJmxUser, useJmxServiceUrl

Methods inherited from class org.apache.activemq.console.command.AbstractCommand
handleException, parseOptions, printHelpFromFile, setCommandContext

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

- Field Detail
  - helpFile
```
protected String[] helpFile
```
- Constructor Detail
  - ListCommand
```
public ListCommand()
```
- Method Detail
  - getName
```
public String getName()
```
  - getOneLineDescription
```
public String getOneLineDescription()
```
  - runTask
```
protected void runTask(List tokens)
                throws Exception
```
    List all running brokers registered in the specified JMX context
    
    Specified by:
    
    runTask in class AbstractCommand
    
    Parameters:
    
    tokens - - command arguments
    
    Throws:
    
    Exception
  - printHelp
```
protected void printHelp()
```
    Print the help messages for the browse command
    
    Specified by:
    
    printHelp in class AbstractCommand