9.2. Advanced VM URI Syntax

URI syntax

The advanced VM URI provides you full control over how the embedded broker is configured. It uses a broker configuration URI similar to the one used by the administration tool to configure the embedded broker.
Example 9.4, “Advanced VM URI Syntax” shows the syntax for an advanced VM URI.

Example 9.4. Advanced VM URI Syntax

vm://(BrokerConfigURI)?TransportOptions
  • BrokerConfigURI is a broker configuration URI.
  • TransportOptions specifies the configuration for the transport. They are specified in the form of a query list. Table 9.2, “VM Transport Options” lists the available options.

Transport options

Table 9.2, “VM Transport Options” shows options for configuring the VM transport.

Table 9.2. VM Transport Options

OptionDescription
marshal If true, forces each command sent over the transport to be marshalled and unmarshalled using the specified wire format. Default is false.
wireFormatThe name of the wire format to use.
wireFormat.*All options with this prefix are used to configure the wire format. See Table A.1, “Wire Format Options Supported by OpenWire Protocol” for more information.
jms.*All the properties with this prefix are used to configure client connections to a broker. See Appendix B, Client Connection Options for more information.
createSpecifies if the VM transport will create an embedded broker if one does not exist. The default is true.
waitForStart Specifies the time, in milliseconds, the VM transport will wait for an embedded broker to start before creating one. The default is -1 which specifies that the transport will not wait.

Example

Example 9.5, “Advanced VM URI” creates and connects to an embedded broker configured using a broker configuration URI.

Example 9.5. Advanced VM URI

vm:(broker:(tcp://localhost:6000)?persistent=false)?marshal=false