jmsprops  list

Chapter 12: Using jagtool and jagant

jmsset_props

Description

Sets properties for a JMS entity.

Syntax

Local mode support: No.

Command line: To set an individual property, specify the property name and value on the command line:

jmsset_props connect-args entity name value

To set multiple properties (one or more) from a properties file, specify the file name:

jmsset_props connect-args entity file

Ant build file: To set an individual property, specify the property name and value:

<jag_jmsset_props entity=”entity” name=”name” value=”value” />

To set multiple properties (one or more) from a properties file, specify the file name:

<jag_jmsset_props entity=”entity” file=”file” />

Option

Description

Required

connect-args

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

Yes

entity

The entity of interest, in the form EntityType:EntityName. Valid entity types are:

  • MessageQueue

  • MessageTopic

  • QueueConnectionFactory

  • ThreadPool

  • TopicConnectionFactory

Yes

name

The property name.

No

value

The property value.

No

file

An optional file containing properties for the entity. The file must specify properties in the form of an EAServer repository properties file.

No

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 configures the “maximum” property of the queue named “AntQueue”:

jagtool jmsset_props "MessageQueue:AntQueue" maximum 99

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

<jag_jmsset_props entity="MessageQueue:AntQueue" name="maximum" value="99" />

Example 2

This command line example configures the queue named “AntQueue,” specifying a properties file:

jagtool jmsset_props "MessageQueue:AntQueue" "D:\Jag41005\sample\jagtool\Newqueueprops.txt"

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

<jag_jmsset_props entity="MessageQueue:AntQueue" file="D:\Jag41005\sample\jagtool\Newqueueprops.txt" />

Example 3

Here is what the Newqueueprops.txt file used in the above examples might contain. See “Permanent destinations” for an explanation of these properties:

IGNORE_DUPLICATE_KEY=false
REQUIRES_ACKNOWLEDGE=false
REQUIRES_TRANSACTION=false
maximum=0
qop=none
share=true
store=true
table=
timeout=60

See also

jmscreate, jmsdelete, jmslist, jmsprops

“Permanent destinations” describes properties for message queues and message topics.

“Connection factories” describes properties for queue connection factories and topic connection factories.

“Thread pools” describes thread pool properties.





Copyright © 2005. Sybase Inc. All rights reserved. list