MQDestination

public abstract class MQDestination
extends Object
implements DestinationJMSDestinationSerializable
java.lang.Object
   |
   +----com.ibm.mq.jms.MQDestination
          

An MQDestination object encapsulates a provider-specific address.

Methods

equals

public boolean equals(Object obj);

Test for equality.

getCCSID

public int getCCSID();

Gets the number of the character set that is used by this destination.

Returns

getDescription

public String getDescription();

Gets the description of the destination.

Returns

getEncoding

public int getEncoding();

Gets the encoding that is used for this destination.

Returns

getExpiry

public long getExpiry();

Gets the value of the expiry for this destination.

Returns

getFailIfQuiesce

public int getFailIfQuiesce();

Gets the status of the failIfQuiesce property of this destination.

Returns

getPersistence

public int getPersistence();

Gets the value of the persistence of all messages sent to this destination.

Returns

getPriority

public int getPriority();

Gets the override priority value.

Returns

getProperty

public String getProperty(String name);

Gets the named, user-defined property from the MQDestination URI.

Parameters
Returns

getStringFromDestination

public String getStringFromDestination();

Takes a JMS Destination object and produces a transport-dependent string that encapsulates the properties of the destination.

Returns

getTargetClient

public int getTargetClient();

Gets the JMS compliance indicator flag.

Returns

setCCSID

public void setCCSID(int ccsid) throws JMSException;

Sets the number of the character set that is used by this destination.

Parameters
Exceptions

setDescription

public void setDescription(String description);

Sets a description of the destination.

Parameters

setEncoding

public void setEncoding(int encoding) throws JMSException;

Sets the encoding to be used for numeric fields in messages sent to this destination.

Parameters
Exceptions

setExpiry

public void setExpiry(long expiry) throws JMSException;

Sets the expiry of all messages sent to this destination.

Parameters
Exceptions

setFailIfQuiesce

public void setFailIfQuiesce(int fiq) throws JMSException;

Sets the behavior of applications accessing a quiescing queue manager with this destination.

Parameters
Exceptions

setPersistence

public void setPersistence(int persistence) throws JMSException;

Overrides the persistence of all messages sent to this destination.

Parameters
Exceptions

setPriority

public void setPriority(int priority) throws JMSException;

Overrides the priority of all messages sent to this destination.

Parameters
Exceptions

setProperty

public void setProperty(String name, String value);

Sets an arbitrary, user-defined property. This property is added to the URI string that is returned by calling getStringFromDestination() Names and values for such properties must conform to the following rules:

Names can contain any character, but '=', '%' and '&' characters will be escaped using standard URI syntax (that is, %3d, %25 and %26 respectively) when they are added to the Destination URI string.
Names beginning with the characters 'ibm' are reserved for IBM internal use only.
The names of existing MQDestination properties (for example, priority, CCSID or brokerVersion) are also reserved.
Values can contain any character but '%' and '&' characters will be escaped using standard URI syntax when they are added to the Destination URI string.

Destination URI strings that cannot be decoded due to syntax errors will result in a JMSException with reason MQJMS_EXCEPTION_INVALID_DESTINATION being thrown.

Names and Values added using the setProperty() method must not have any '=', '%' and '&' characters replaced by escape sequences as this will be done they are added to the Destination URI string.
If this method is used on a 1.3.1 JDK or lower, the Names and Values added will not be escaped and will be added to the Destination URI as they are. This can cause unpredictable results if the Names or Values contain unescaped '=', '%' or '&' characters. For example, they might result in a JMSException being thrown or they might cause additional erroneous properties to be defined in the MQDestination object.

Parameters

setTargetClient

public void setTargetClient(int targetClient) throws JMSException;

Sets a flag indicating whether the remote application supports JMS.

Parameters
Exceptions