com.adaptris.core.wmq

Class MessageOptions

java.lang.Object

com.adaptris.core.wmq.MessageOptions

public class MessageOptions
extends java.lang.Object

Options handling queue access and MQMessage options when getting or putting messages on a MQQueue

The options can be set as an integer, or you can comma separate the option names. The options are directly copied from the WebsphereMQ client API documentation.

In the adapter configuration file this class is aliased as wmq-message-options which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
MessageOptions()

Method Summary

Modifier and Type	Method and Description
protected void	addMessageOption(java.lang.String option) Will add the value of the MQC field name given to the options.
protected void	addQueueCloseOption(java.lang.String option) Will add the value of the MQC field name given to the options.
protected void	addQueueOpenOption(java.lang.String option) Will add the value of the MQC field name given to the options.
MQMessageFactory.MQMessageInstance	getMessageFormat()
java.lang.String	getMessageOptions()
java.lang.String	getQueueCloseOptions()
java.lang.String	getQueueOpenOptions()
int	messageOptionsIntValue() Calculate the integer value of the options field.
int	queueCloseOptionsIntValue() Calculate the integer value of the options field.
int	queueOpenOptionsIntValue() Calculate the integer value of the options field.
void	setMessageFormat(MQMessageFactory.MQMessageInstance s) Set the MQMessage.format field to the desired value.
void	setMessageOptions(java.lang.String i) Options that control the action of MQQueue.put() and MQQueue.get()
void	setQueueCloseOptions(java.lang.String i) Set the close options when closing the queue.
void	setQueueOpenOptions(java.lang.String i) Set the open options on the queue when accessing the Queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageOptions

public MessageOptions()

Method Detail

getQueueOpenOptions

public java.lang.String getQueueOpenOptions()

Returns:

the openOptions

setQueueOpenOptions

public void setQueueOpenOptions(java.lang.String i)

Set the open options on the queue when accessing the Queue.

Any or none of the following MQC fields may be used. If more than one option is required, the values can be combined by simply comma separating each string option.

• MQOO_INQUIRE
• MQOO_BROWSE
• MQOO_INPUT_AS_Q_DEF
• MQOO_INPUT_SHARED
• MQOO_INPUT_EXCLUSIVE
• MQOO_OUTPUT
• MQOO_SAVE_ALL_CONTEXT
• MQOO_PASS_IDENTITY_CONTEXT
• MQOO_PASS_ALL_CONTEXT
• MQOO_SET_IDENTITY_CONTEXT
• MQOO_SET_ALL_CONTEXT
• MQOO_ALTERNATE_USER_AUTHORITY
• MQOO_FAIL_IF_QUIESCING

Parameters:

i - the openOptions to set. The default options are MQOO_INPUT_AS_Q_DEF , MQOO_OUTPUT

See Also:

MQQueueManager.accessQueue(String, int), MQC

getQueueCloseOptions

public java.lang.String getQueueCloseOptions()

Returns:

the closeOptions

setQueueCloseOptions

public void setQueueCloseOptions(java.lang.String i)

Set the close options when closing the queue.

One of the following MQC fields may be used.

• MQCO_NONE - the default value
• MQCO_DELETE - permanent dynamic queues only
• MQCO_DELETE_PURGE - permanent dynamic queues only

Parameters:

i - the closeOptions to set

See Also:

MQC.MQCO_NONE, MQC.MQCO_DELETE, MQC.MQCO_DELETE_PURGE

getMessageFormat

public MQMessageFactory.MQMessageInstance getMessageFormat()

Returns:

the messageFormat for the producer.

setMessageFormat

public void setMessageFormat(MQMessageFactory.MQMessageInstance s)

Set the MQMessage.format field to the desired value.

Only Text, String, Bytes, and Object are supported. They correspond to the values MQC.MQFMT_STRING, MQC.MQFMT_STRING, MQC.MQFMT_NONE and "Object" respectively.

• Text implies UTF.
• String relies on the character set of the message.

Parameters:

s - the messageType to set

See Also:

MQMessageFactory.MQMessageInstance

getMessageOptions

public java.lang.String getMessageOptions()

Returns:

the messageOptions

setMessageOptions

public void setMessageOptions(java.lang.String i)

Options that control the action of MQQueue.put() and MQQueue.get()

Any or none of the following MQC fields may be used. If more than one option is required, the values can be combined by simply comma separating each option.

If the context of the message options is part of a producer, then the following values have meaning.

• MQPMO_SYNCPOINT
• MQPMO_NO_SYNCPOINT - the default value
• MQPMO_NO_SYNCPOINT
• MQPMO_NO_CONTEXT
• MQPMO_DEFAULT_CONTEXT
• MQPMO_SET_IDENTITY_CONTEXT
• MQPMO_SET_ALL_CONTEXT
• MQPMO_FAIL_IF_QUIESCING
• MQPMO_NEW_MSG_ID
• MQPMO_NEW_CORREL_ID
• MQPMO_LOGICAL_ORDER
• MQPMO_ALTERNATE_USER_AUTHORITY
• MQPMO_RESOLVE_LOCAL_Q

If the context of the message options is part of a consumer, then the following values have meaning.

• MQGMO_WAIT - default
• MQGMO_NO_WAIT
• MQGMO_SYNCPOINT
• MQGMO_NO_SYNCPOINT - default
• MQGMO_BROWSE_FIRST
• MQGMO_BROWSE_NEXT
• MQGMO_BROWSE_MSG_UNDER_CURSOR
• MQGMO_MSG_UNDER_CURSOR
• MQGMO_LOCK MQC.MQGMO_UNLOCK
• MQGMO_ACCEPT_TRUNCATED_MSG
• MQGMO_FAIL_IF_QUIESCING
• MQGMO_CONVERT

Parameters:

i - the messageOptions to set

messageOptionsIntValue

public int messageOptionsIntValue()
                           throws CoreException

Calculate the integer value of the options field.

Returns:

the integer value of the options.

Throws:

CoreException

queueOpenOptionsIntValue

public int queueOpenOptionsIntValue()
                             throws CoreException

Calculate the integer value of the options field.

Returns:

the integer value of the options.

Throws:

CoreException

queueCloseOptionsIntValue

public int queueCloseOptionsIntValue()
                              throws CoreException

Calculate the integer value of the options field.

Returns:

the integer value of the options.

Throws:

CoreException

addMessageOption

protected void addMessageOption(java.lang.String option)
                         throws CoreException

Will add the value of the MQC field name given to the options.

Parameters:

option - the MQC field name

Throws:

CoreException

addQueueOpenOption

protected void addQueueOpenOption(java.lang.String option)
                           throws CoreException

Will add the value of the MQC field name given to the options.

Parameters:

option - the MQC field name

Throws:

CoreException

addQueueCloseOption

protected void addQueueCloseOption(java.lang.String option)
                            throws CoreException

Will add the value of the MQC field name given to the options.

Parameters:

option - the MQC field name

Throws:

CoreException