Class MQDistributionList

java.lang.Object

com.ibm.mq.jmqi.JmqiObject

com.ibm.mq.MQManagedObject

com.ibm.mq.MQDistributionList

public class MQDistributionList
extends MQManagedObject

Create a distribution list using the MQDistributionList constructor or the MQQueueManager.accessDistributionList() method. A distribution list represents a set of open queues to which messages can be sent using a single call to the put method.

Field Summary

Fields inherited from class MQManagedObject

alternateUserId, closeOptions, connectionReference, isOpen, name, openOptions

Fields inherited from class com.ibm.mq.jmqi.JmqiObject

COMP_JM, COMP_JN, COMP_JO

Constructor Summary

Constructors

Constructor	Description
MQDistributionList(MQQueueManager qMgr, MQDistributionListItem[] litems, int openOptions, String alternateUserId)	Creates a new distribution list and opens the queues.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the distribution list.
MQDistributionListItem	getFirstDistributionListItem()	Gets the first item in the distribution list, or null if the list is empty.
int	getInvalidDestinationCount()	Gets the number of items in the distribution list that failed to open successfully.
int	getValidDestinationCount()	Gets the number of items in the distribution list that were opened successfully.
void	put(MQMessage message, MQPutMessageOptions putMessageOptions)	Puts a message to the queues on the distribution list.

Methods inherited from class MQManagedObject

getAlternateUserId, getAttributeString, getCloseOptions, getConnectionReference, getDescription, getName, getOpenOptions, getResolvedObjectString, getResolvedQName, getResolvedType, inquire, inquire, isOpen, set, setAttributeString, setCloseOptions

Methods inherited from class com.ibm.mq.jmqi.JmqiObject

getJmqiEnvironment

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MQDistributionList

public MQDistributionList(MQQueueManager qMgr,
 MQDistributionListItem[] litems,
 int openOptions,
 String alternateUserId)
                   throws MQException

Creates a new distribution list and opens the queues.

Parameters:

qMgr - the queue manager where the list is to be opened.

litems - the items to be included in the distribution list.

openOptions - options which control the opening of the distribution list.

alternateUserId - the alternative user identifier used to check the authorization for opening queues if MQOO_ALTERNATE_USER_AUTHORITY is specified in openOptions. Otherwise this parameter can be left blank (or null).

Throws:

MQException - is only thrown if the call fails completely. The constructor completes if at least one queue opens succesfully.

Method Details

put

public void put(MQMessage message,
 MQPutMessageOptions putMessageOptions)
         throws MQException

Puts a message to the queues on the distribution list.

Parameters:

message - the message descriptor information and the returned message data.

putMessageOptions - controls the action of MQPUT.

Throws:

MQException - if the put fails.

close

public void close()
           throws MQException

Closes the distribution list.

Overrides:

close in class MQManagedObject

Throws:

MQException - if the close fails.

getValidDestinationCount

public int getValidDestinationCount()

Gets the number of items in the distribution list that were opened successfully.

Returns:

the number of items.

getInvalidDestinationCount

public int getInvalidDestinationCount()

Gets the number of items in the distribution list that failed to open successfully.

Returns:

the number of items.

getFirstDistributionListItem

public MQDistributionListItem getFirstDistributionListItem()

Gets the first item in the distribution list, or null if the list is empty.

Returns:

the first item.