Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Info

This page is out of date and should not be used. Please refer to the Qpid JMS client books for up to date documentation.

Format

No Format

amqp://[<user>:<pass>@][<clientid>]<virtualhost>[?<option>='<value>'[&<option>='<value>']]

...

guest:guest@localhost = username:password@clientid where the clientid is the name of your server (used under the covers but don't worry about this for now). Always use the guest:guest combination at the moment.unmigrated-wiki-markup

development = the name of the virtualhost, where the virtualhost is a path which acts as a namespace. You can effectively use any value here so long as you're consistent throughout. The virtualhost must start with a slash "/" and continue with names separated by slashes. A name consists of any combination of at least one of \ [A-Za-z0-9\] plus zero or more of \ [.-_+!=:\].

brokerlist = this is the host address and port for the broker you want to connect to. The connection factory will assume tcp if you don't specify a transport protocol. The port also defaults to 5672. Naturally you have to put at least one broker in this list.

...

Option

Default

Description

brokerlist

see below

The list of brokers to use for this connection

failover

see below

The type of failover method to use with the broker list.

maxprefetch

5000

The maximum number of messages to prefetch from the broker.

Brokerlist option

No Format

brokerlist='<broker url>[;<broker url>]'

...

Broker URL format

No Format

<transport>://<host>[:<port>][?<option>='<value>'[&<option>='<value>']]

...

Brokerlist failover option

No Format

failover='<method>[?<options>]'

...

Method

Description

singlebroker

This will only use the first broker in the list.

roundrobin

This method tries each broker in turn.

nofailover

[New in 0.5] This method disables all retry and failover logic.

The current defaults are naturally to use the 'singlebroker' when only one broker is present and the 'roundrobin' method with multiple brokers. The '''method''' value in the URL may also be any valid class on the classpath that implements the FailoverMethod interface.

The 'nofailover' method is useful if you are using a 3rd party tool such as Mule that has its own reconnection strategy that you wish to use.

Options

Option

Default

Description

cyclecount

01

The number of times to loop through the list of available brokers before failure.

Note: Default was changed from 0 to 1 in Release 0.5

Sample URLs

No Format

amqp:///test?brokerlist='localhost'
amqp:///test?brokerlist='tcp://anotherhost:5684?retries='10''
amqp://guest:guest@/test?brokerlist='vm://:1;vm://:2'&failover='roundrobin'
amqp://guest:guest@/test?brokerlist='vm://:1;vm://:2'&failover='roundrobin?cyclecount='20''
amqp://guest:guest@client/test?brokerlist='tcp://localhost;tcp://redundant-server:5673?ssl='true''&failover='roundrobin'
amqp://guest:guest@/test?brokerlist='vm://:1'&failover='nofailover'