jmsdelete

Description

Deletes the specified entity.

Syntax

Local mode support: No.

Command line:

jmsdelete connect-args entity

Ant build file:

<jag_jmsdelete entity=”entity” />

Option

Description

Required

connect-args

Arguments to specify a connection to the server. See “Using connected mode”.

Yes

entity

The entity to delete, in the form EntityType:EntityName. Valid entity types are:

  • Listener

  • MessageQueue

  • MessageTopic

  • QueueConnectionFactory

  • ThreadPool

  • TopicConnectionFactory

Yes

If the entity is a message queue, you must first remove its listeners. This operation removes selectors, and receives and acknowledges all queued messages for the message queue.

Returns

Return value

Indicates

0

The command ran successfully; the result is true/success.

2

The command did not run successfully; an exception was thrown.

Examples

Example 1

This command line example deletes the message queue “MyQueue”:

jagtool jmsdelete MessageQueue:MyQueue

Example 2

This example does the same thing in an Ant build file:

<jag_jmsdelete entity="MessageQueue:MyQueue" />