|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mq.jms.MQDestination
An MQDestination object encapsulates a provider-specific address.
Field Summary |
Method Summary | |
boolean |
equals(java.lang.Object obj)
Test for equality. |
int |
getCCSID()
Gets the number of the character set that is used by this destination. |
java.lang.String |
getDescription()
Gets the description of the destination. |
int |
getEncoding()
Gets the encoding that is used for this destination. |
long |
getExpiry()
Gets the value of the expiry for this destination. |
int |
getFailIfQuiesce()
Gets the status of the failIfQuiesce property of this destination. |
int |
getPersistence()
Gets the value of the persistence of all messages sent to this destination. |
int |
getPriority()
Gets the override priority value. |
java.lang.String |
getProperty(java.lang.String name)
Gets the named, user-defined property from the MQDestination URI. |
java.lang.String |
getStringFromDestination()
Takes a JMS Destination object and produces a transport-dependent string that encapsulates the properties of the destination. |
int |
getTargetClient()
Gets the JMS compliance indicator flag. |
void |
setCCSID(int ccsid)
Sets the number of the character set that is used by this destination. |
void |
setDescription(java.lang.String description)
Sets a description of the destination. |
void |
setEncoding(int encoding)
Sets the encoding to be used for numeric fields in messages sent to this destination. |
void |
setExpiry(long expiry)
Sets the expiry of all messages sent to this destination. |
void |
setFailIfQuiesce(int fiq)
Sets the behavior of applications accessing a quiescing queue manager with this destination. |
void |
setPersistence(int persistence)
Overrides the persistence of all messages sent to this destination. |
void |
setPriority(int priority)
Overrides the priority of all messages sent to this destination. |
void |
setProperty(java.lang.String name,
java.lang.String value)
Sets an arbitrary, user-defined property. |
void |
setTargetClient(int targetClient)
Sets a flag indicating whether the remote application supports JMS. |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public int getFailIfQuiesce()
JMSC.MQJMS_FIQ_YES
- default
JMSC.MQJMS_FIQ_NO
public void setFailIfQuiesce(int fiq) throws javax.jms.JMSException
fiq
- possible values are:
JMSC.MQJMS_FIQ_YES
- default
JMSC.MQJMS_FIQ_NO
javax.jms.JMSException
- if fiq is not one of the above.public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- the description for the destination.public int getPriority()
JMSC.MQJMS_PRI_APP
JMSC.MQJMS_PRI_QDEF
public void setPriority(int priority) throws javax.jms.JMSException
priority
- the new priority.
Possible values are:
JMSC.MQJMS_PRI_APP
JMSC.MQJMS_PRI_QDEF
javax.jms.JMSException
- if the value is invalidpublic long getExpiry()
public void setExpiry(long expiry) throws javax.jms.JMSException
expiry
- the expiry time (milliseconds).
javax.jms.JMSException
- if expiry is not valid.public int getPersistence()
MQMD.persistence
public void setPersistence(int persistence) throws javax.jms.JMSException
persistence
- the value of persistence.
See MQMD.persistence
javax.jms.JMSException
- if persistence is invalid.public int getTargetClient()
public void setTargetClient(int targetClient) throws javax.jms.JMSException
targetClient
- the value of the flag. Possible values are:
JMSC.MQJMS_CLIENT_JMS_COMPLIANT
JMSC.MQJMS_CLIENT_NONJMS_MQ
javax.jms.JMSException
- if the value is invalidpublic int getCCSID()
MQMD.characterSet
.public void setCCSID(int ccsid) throws javax.jms.JMSException
ccsid
- the CCSID.
See MQMD.characterSet
.
javax.jms.JMSException
- if ccsid is invalid.public int getEncoding()
MQMD.encoding
.public void setEncoding(int encoding) throws javax.jms.JMSException
encoding
- the encoding.
See MQMD.encoding
.
javax.jms.JMSException
- if encoding is not valid.public java.lang.String getProperty(java.lang.String name)
name
- The name of the property.
setProperty(java.lang.String, java.lang.String)
public void setProperty(java.lang.String name, java.lang.String value)
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.
name
- The name of the property.value
- The value of the property.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String getStringFromDestination()
getStringFromDestination
in interface JMSDestination
|
(c) Copyright IBM Corp. 2005. All Rights Reserved. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |