modifySIBDestination command

Use the modifySIBDestination command to change properties of a bus destination for a service integration bus. To run the command, use the AdminTask object of the wsadmin scripting client. Command-line help is provided for service integration bus commands:

After using the command, save the changes to the master configuration; for example, by using the following command:

AdminConfig.save()

 

Purpose

The modifySIBDestination changes properties of a bus destination for a service integration bus.

 

Target object

A bus destination.

 

Required parameters

-bus

The name of the service integration bus on which the bus destination is configured. Use the listSIBuses command to list the names of existing buses.

-name

The identifier by which this destination is known for administrative purposes.

 

Conditional parameters

None.

 

Optional parameters

-description

Specify a description for the bus destination, for administrative purposes.

-reliability

Default reliability level to assign to a message produced to this destination when an explicit reliability has not been set by the producer application. Service integration supports five reliability levels (also known as delivery options or qualities of service):

BEST_EFFORT_NONPERSISTENT

Messages are discarded when a messaging engine stops or fails. Messages might also be discarded if a connection used to send them becomes unavailable or as a result of constrained system resources.

EXPRESS_NONPERSISTENT

Messages are discarded when a messaging engine stops or fails. Messages might also be discarded if a connection used to send them becomes unavailable.

RELIABLE_NONPERSISTENT

Messages are discarded when a messaging engine stops or fails.

RELIABLE_PERSISTENT

Messages might be discarded when a messaging engine fails.

ASSURED_PERSISTENT

Messages are not discarded.

Higher levels of reliability have higher impacts on performance.

See about service integration reliability levels, see Message reliability levels - JMS delivery mode and service integration quality of service.

-overrideOfQOSByProducerAllowed TRUE | FALSE

Controls the quality of service for message flows between producers and the destination. Select this option to use the quality of service specified by producers instead of the quality defined for the destination.

-defaultPriority number

The default priority assigned to messages sent to this destination when a priority has not been set by the producer.

-maxFailedDeliveries number

The maximum number of failed attempts to process a message. After this number of failed attempts, the message is forwarded from the intended destination to its exception destination. Specify a value in the range 0 through 2147483647. A value of 0 (zero) means that if a message cannot be delivered on the first attempt, it is either forwarded to the exception destination or discarded, as defined by the -exceptionDestination parameter.

-exceptionDestination value

The destination to which a message is forwarded by the system when it cannot be delivered to this destination.

By default, all messages that cannot be delivered to this destination are rerouted to the system default exception destination for the messaging engine to which this destination is assigned (_SYSTEM.Exception.Destination.messaging_engine_name). Use this parameter to override the default value. We can set a specific exception destination for this destination, or we can specify that undeliverable messages are not rerouted to an exception destination by entering an empty string (""), in which case the maximum failed deliveries count has no effect.

An undeliverable message can block the processing of other messages waiting for delivery to the same destination.

Use this option and specify no exception destination to preserve message ordering.

-sendAllowed TRUE | FALSE

Clear this option (setting it to FALSE) to stop producers from being able to send messages to this destination.

  • For a queue point of a non-mediated destination, or a mediation point of a mediated destination, if you clear this option then new messages (from attached producers or forwarded from another destination) are redirected to any available message point. If no message points are available, then messages that have already been accepted onto the bus, and new messages from attached producers, are preserved by the bus until a message point becomes available. The only exception to this is the case of a destination with only one message point (queue point or mediation point depending on whether the destination is mediated or non-mediated), where the producer is attached to the same messaging engine. In this case, an exception message is generated on each send call. The exception message indicates that the only extant localization has been disabled for send. The producer remains open as usual, and any more send calls succeed if the Send allowed property of the localization is reselected (reset to TRUE).

  • For a queue point of a mediated destination, if you clear this option then messages from mediation instances are redirected to any available message point. If no message points are available, then the messages are preserved by the bus until a message point becomes available. For any mediation instance (that is, on any server that has a mediation point), if the same server hosts a queue point, and that queue point is the only queue point for the destination, then the mediation changes to the "stopped on error" state.

-receiveAllowed TRUE | FALSE

Clear this option (setting it to false) to prevent consumers from being able to receive messages from this destination. For the message point, if you clear this option then any open consumers change state and an exception is generated if the consumer requests a message. Messages can continue to be sent, and accumulate on the message point.

-receiveExclusive TRUE | FALSE

Select this option (setting it to true) to allow only one consumer to attach to a destination. If you select this option, only a single consumer can be attached to each queue point of a queue destination at any one time. Subsequent consumers attempting to attach to a queue point with a consumer already attached are rejected.

-maintainStrictMessageOrder TRUE | FALSE

Select this option (setting it to TRUE) to maintain the order in which a producer sends messages to the destination.

At run time, this property has priority over other configuration property values. For information about the configuration properties that are overridden at run time, see Strict message ordering for bus destinations.

-topicAccessCheckRequired

Include this option if authorization checks are required for access to topics.

-replyDestination

The name of a destination to be appended to any non-empty reverse routing path of messages sent to this destination. Is intended for use with mediations on reply messages. For more information about the use of this property, see Configure a destination reverse routing path.

-replyDestinationBus

The name of the bus on which the reply destination is configured. Is intended for use with mediations on reply messages.

See about the use of this property, see Configure a destination reverse routing path.

-delegateAuthorizationCheckToTarget

Indicates whether the authorization check is performed on the alias or the target destination. Include this option if you want the authorization check to be performed on the target destination.

-auditAllowed TRUE | FALSE

Clear this option (setting it to FALSE) to prevent the bus from auditing topic level authorization checks when the bus and appserver have auditing enabled. The default value is TRUE. You must have Audit Administrator privileges to use this parameter. The parameter is ignored if it is used in the creation of other types of destination.

-defaultForwardRoutingPath

The value to which a message forward routing path is set if the message contains no forward routing path. This identifies a sequential list of intermediary bus destinations that messages must pass through to reach a target bus destination. The format of the field is a list of bus destinations specified as bus_name:destination_name.

-queuePoints

A list of the queue points used by users of the alias destination. If no queue points are supplied, all queue points can be used. The target destination must be a queue destination in the same bus as the alias destination definition. The target destination must also be a queue destination with multiple queue points.

A queue point is specified in the following form: destination_name@messaging_engine_name

-useAllQueuePoints TRUE | FALSE

If you set this option to TRUE all available queue points are used whereas, if you set this option to FALSE, only those queue points in the list specified by the -queuePoints option are used.

-mediationPoints

A list of the mediation points used by users of the alias destination. If no mediation points are supplied, all mediation points can be used. The target destination must be a mediated queue destination in the same bus as the alias destination definition. The target destination must also be a queue destination with multiple mediation points.

A mediation point is specified in the following form: destination_name@messaging_engine_name

-useAllMediationPoints TRUE | FALSE

If you set this option to TRUE all available queue points are used whereas, if you set this option to FALSE, only those queue points in the list specified by the -mediationPoints option are used.

 

Example

 

Example

 

Example

   


Last updated Nov 10, 2010 8:23:07 PM CST