|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mq.MQManagedObject | +--com.ibm.mq.MQDistributionList
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 com.ibm.mq.MQManagedObject |
alternateUserId, closeOptions, connectionReference, isOpen, name, openOptions |
Constructor Summary | |
MQDistributionList(MQQueueManager qMgr,
MQDistributionListItem[] litems,
int openOptions,
java.lang.String alternateUserId)
Creates a new distribution list and opens the queues. |
Method Summary | |
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 com.ibm.mq.MQManagedObject |
getAttributeString, getDescription, inquire, isOpen, set, setAttributeString |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public MQDistributionList(MQQueueManager qMgr, MQDistributionListItem[] litems, int openOptions, java.lang.String alternateUserId) throws MQException
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).
MQException
- is only thrown if the call fails completely.
The constructor completes if at least one queue opens succesfully.Method Detail |
public void put(MQMessage message, MQPutMessageOptions putMessageOptions) throws MQException
message
- the message descriptor information and the returned message data.putMessageOptions
- controls the action of MQPUT.
MQException
- if the put fails.public void close() throws MQException
close
in class MQManagedObject
MQException
- if the close fails.public int getValidDestinationCount()
public int getInvalidDestinationCount()
public MQDistributionListItem getFirstDistributionListItem()
|
(c) Copyright IBM Corp. 2005. All Rights Reserved. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |