Use the createSIBLink command to create
a new service integration bus link.
Purpose
The createSIBLink command
creates a new bus link for a specified bus. A bus link defines a link
between a messaging engine in one bus and a messaging engine in a
foreign bus.
Required parameters
- -bus
- The name of the service integration bus for which you want to
create the service integration bus link. You can use the listSIBuses command
to list the names of existing buses.
- -messagingEngine
- The name of the messaging engine for which you want to create
the service integration bus link. The service integration bus link
connects a messaging engine to another messaging engine in a different
service integration bus, thereby providing a bridge between two service
integration buses.
- -name
- The name by which you want the service integration bus link to
be known.
- -foreignBusName
- The name of the foreign bus that defines the remote service integration
bus for the service integration bus link. You can use the listSIBForeignBuses command
to list the names of existing foreign buses.
- -bootstrapEndpoints
- The comma-separated list of endpoints used to connect to a bootstrap server.
This property is set in the same way as the Provider endpoint property in the JMS connection factory settings. For more information, see the steps relating to setting bootstrap endpoints in Configuring a connection to a non-default bootstrap server.
The port
for the bootstrap endpoint is the port defined on the SIB endpoint
address that is configured on the target application server on the
foreign bus.
- -remoteMessagingEngineName
- The messaging engine on the foreign bus to which this link connects.
Conditional parameters
None.
Optional parameters
- -description
- An optional description for the bus, for administrative purposes.
- -protocolName
- The type of transport chain used for communication with the foreign bus.
The
transport chain name must be the name of the transport chain as defined
on the server on which the target messaging engine is hosted.
- -authAlias
- The name of the authentication alias, used to authenticate access to the foreign bus.
You
must have predefined a J2C authentication alias.
- -exceptionDestination
- The destination for an inbound message when the service integration
bus link cannot deliver the message to its target bus destination,
or to the exception destination that is configured for that target
destination, or when the target destination does not exist.
- System
- The
service integration bus link uses the default exception destination.
All messages that cannot be delivered to the bus destination are rerouted
automatically to the system default exception destination for the
messaging engine that this link is assigned to: _SYSTEM.Exception.Destination.messaging_engine_name.
- None
- The
service integration bus link has no exception destination. Undeliverable
messages are not rerouted to an exception destination and can block
the processing of other messages waiting for delivery to the same
destination. This option can be used to preserve message ordering.
- Specify
- The
service integration bus link uses the exception destination specified
here. If this is not possible, it uses the system exception destination.
- -initialState Started | Stopped
- The state of the gateway link, which shows whether the link is
started automatically when the messaging engine is started.
Default |
Started |
Range |
- Stopped
- When the associated messaging engine is started, the gateway link is in a stopped state and cannot process any new requests for connections.
- Started
- When the associated messaging engine is started, the gateway link is in a started state and can process any new requests for connections.
|
- -preferLocal TRUE | FALSE
- Indicates that the link prefers to send incoming messages to the
queue point of the target destination that is located on the same
messaging engine as the link, if available. The link must be owned
by a messaging engine running on a WebSphere Application Server Version 7.0 or
later server.
This option is supported only when used by a JMS
application that is running with a WebSphere Application ServerVersion 7.0 server or client, and
that is connected to a messaging engine running on WebSphere Application ServerVersion 7.0 server. Use on previous
versions of WebSphere Application Server will result
in an exception to the application.
Default |
TRUE |
Range |
- TRUE
- Send each incoming message to the queue point of the target destination
that is located on the same messaging engine as the link, if available.
- FALSE
- Send incoming messages to any queue points of the target destinations.
|
Example
AdminTask.createSIBLink('[-bus bus1 -messagingEngine node01.server1-myBus
-name mySIBLink -foreignBusName bus2 -bootstrapEndpoints host1:1111:chain1
-remoteMessagingEngineName node02.server2-bus2]')
Create
a service integration bus link that uses a queue point on the same
messaging engine as the link, whenever possible.
AdminTask.createSIBLink('[-bus bus1 -messagingEngine node01.server1-bus1
-name mySIBLink -foreignBusName bus2 -bootstrapEndpoints host1:1111:chain1
-remoteMessagingEngineName node02.server2-bus2 -preferLocal TRUE]')