com.ibm.msg.client.jms
Interface JmsPropertyContext
-
- All Superinterfaces:
- JmsReadablePropertyContext, java.util.Map<java.lang.String,java.lang.Object>, java.io.Serializable
- All Known Subinterfaces:
- JmsConnection, JmsConnectionFactory, JmsConnectionMetaData, JmsConsumer, JmsContext, JmsDestination, JmsMessageConsumer, JmsMessageProducer, JmsQueue, JmsQueueBrowser, JmsQueueConnection, JmsQueueConnectionFactory, JmsQueueReceiver, JmsQueueSender, JmsQueueSession, JmsSession, JmsTemporaryQueue, JmsTemporaryTopic, JmsTopic, JmsTopicConnection, JmsTopicConnectionFactory, JmsTopicPublisher, JmsTopicSession, JmsTopicSubscriber, JmsXAConnection, JmsXAConnectionFactory, JmsXAContext, JmsXAQueueConnection, JmsXAQueueConnectionFactory, JmsXAQueueSession, JmsXASession, JmsXATopicConnection, JmsXATopicConnectionFactory, JmsXATopicSession
- All Known Implementing Classes:
- Cleanup, com.ibm.msg.client.jms.admin.JmsConnectionFactoryImpl, com.ibm.msg.client.jms.admin.JmsDestinationImpl, com.ibm.msg.client.jms.admin.JmsJndiConnectionFactoryImpl, com.ibm.msg.client.jms.admin.JmsJndiDestinationImpl, com.ibm.msg.client.jms.internal.JmsPropertyContextImpl, MQConnection, MQConnectionFactory, MQConnectionMetaData, MQDestination, MQMessageConsumer, MQMessageProducer, MQQueue, MQQueueBrowser, MQQueueConnection, MQQueueConnectionFactory, MQQueueReceiver, MQQueueSender, MQQueueSession, MQRoot, MQSession, MQTemporaryQueue, MQTemporaryTopic, MQTopic, MQTopicConnection, MQTopicConnectionFactory, MQTopicPublisher, MQTopicSession, MQTopicSubscriber, MQXAConnection, MQXAConnectionFactory, MQXAQueueConnection, MQXAQueueConnectionFactory, MQXAQueueSession, MQXASession, MQXATopicConnection, MQXATopicConnectionFactory, MQXATopicSession
public interface JmsPropertyContext extends JmsReadablePropertyContext, java.util.Map<java.lang.String,java.lang.Object>
This is the interface used to get and set properties from all JMS objects. Properties of primitive types will be converted according to the JMS type conversion rules: A property value written as the row type below can be read as the column type:boolean byte short char int long float double String byte[] boolean X X byte X X X X X short X X X X char X X int X X X long X X float X X X double X X String X X X X X X X X byte[] X
-
-
Method Summary
Methods Modifier and Type Method and Description void
setBatchProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
Sets multiple property values passed in via a Map.void
setBooleanProperty(java.lang.String name, boolean value)
Sets a boolean property value with the given name.void
setByteProperty(java.lang.String name, byte value)
Sets a byte property value with the given name.void
setBytesProperty(java.lang.String name, byte[] value)
Sets a byte array property value with the given name.void
setCharProperty(java.lang.String name, char value)
Sets a character property value with the given name.void
setDoubleProperty(java.lang.String name, double value)
Sets a double property value with the given name.void
setFloatProperty(java.lang.String name, float value)
Sets a float property value with the given name.void
setIntProperty(java.lang.String name, int value)
Sets an int property value with the given name.void
setLongProperty(java.lang.String name, long value)
Sets a long property value with the given name.void
setObjectProperty(java.lang.String name, java.lang.Object value)
Sets an Object property value with the given name.void
setShortProperty(java.lang.String name, short value)
Sets a short property value with the given name.void
setStringProperty(java.lang.String name, java.lang.String value)
Sets a String property value with the given name.-
Methods inherited from interface com.ibm.msg.client.jms.JmsReadablePropertyContext
getBooleanProperty, getByteProperty, getBytesProperty, getCharProperty, getDoubleProperty, getFloatProperty, getIntProperty, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists
-
-
-
-
Method Detail
-
setCharProperty
void setCharProperty(java.lang.String name, char value) throws javax.jms.JMSException
Sets a character property value with the given name.- Parameters:
name
- the name of the char property.value
- the char value to put into the property context.- Throws:
javax.jms.JMSException
- if the property context is marked read-only or if the proposed value is invalid for the property.
-
setBooleanProperty
void setBooleanProperty(java.lang.String name, boolean value) throws javax.jms.JMSException
Sets a boolean property value with the given name.- Parameters:
name
- the name of the boolean property.value
- the boolean value to put into the property context.- Throws:
javax.jms.JMSException
- if the property context is marked read-only or if the proposed value is invalid for the property.
-
setByteProperty
void setByteProperty(java.lang.String name, byte value) throws javax.jms.JMSException
Sets a byte property value with the given name.- Parameters:
name
- the name of the byte property.value
- the byte value to put into the property context.- Throws:
javax.jms.JMSException
- if the property context is marked read-only or if the proposed value is invalid for the property.
-
setShortProperty
void setShortProperty(java.lang.String name, short value) throws javax.jms.JMSException
Sets a short property value with the given name.- Parameters:
name
- the name of the short property.value
- the short value to put into the property context.- Throws:
javax.jms.JMSException
- if the property context is marked read-only or if the proposed value is invalid for the property.
-
setIntProperty
void setIntProperty(java.lang.String name, int value) throws javax.jms.JMSException
Sets an int property value with the given name.- Parameters:
name
- the name of the int property.value
- the int value to put into the property context.- Throws:
javax.jms.JMSException
- if the property context is marked read-only or if the proposed value is invalid for the property.
-
setLongProperty
void setLongProperty(java.lang.String name, long value) throws javax.jms.JMSException
Sets a long property value with the given name.- Parameters:
name
- the name of the long property.value
- the long value to put into the property context.- Throws:
javax.jms.JMSException
- if the property context is marked read-only or if the proposed value is invalid for the property.
-
setFloatProperty
void setFloatProperty(java.lang.String name, float value) throws javax.jms.JMSException
Sets a float property value with the given name.- Parameters:
name
- the name of the float property.value
- the float value to put into the property context.- Throws:
javax.jms.JMSException
- if the property context is marked read-only or if the proposed value is invalid for the property.
-
setDoubleProperty
void setDoubleProperty(java.lang.String name, double value) throws javax.jms.JMSException
Sets a double property value with the given name.- Parameters:
name
- the name of the double property.value
- the double value to put into the property context.- Throws:
javax.jms.JMSException
- if the property context is marked read-only or if the proposed value is invalid for the property.
-
setStringProperty
void setStringProperty(java.lang.String name, java.lang.String value) throws javax.jms.JMSException
Sets a String property value with the given name.- Parameters:
name
- the name of the String property.value
- the String value to put into the property context.- Throws:
javax.jms.JMSException
- if the property context is marked read-only or if the proposed value is invalid for the property.
-
setObjectProperty
void setObjectProperty(java.lang.String name, java.lang.Object value) throws javax.jms.JMSException
Sets an Object property value with the given name.- Parameters:
name
- the name of the Object property.value
- the Object value to put into the property context.- Throws:
javax.jms.JMSException
- if the property context is marked read-only or if the proposed value is invalid for the property.
-
setBytesProperty
void setBytesProperty(java.lang.String name, byte[] value) throws javax.jms.JMSException
Sets a byte array property value with the given name.- Parameters:
name
- the name of the byte array property.value
- the byte array to put into the property context.- Throws:
javax.jms.JMSException
- if the property context is marked read-only or if the proposed value is invalid for the property.
-
setBatchProperties
void setBatchProperties(java.util.Map<java.lang.String,java.lang.Object> properties) throws javax.jms.JMSException
Sets multiple property values passed in via a Map. If any property fails to be set, all changes are rolled back.- Parameters:
properties
- the Map of properties.- Throws:
javax.jms.JMSException
- if the property context is marked read-only or if any proposed value is invalid for any property.
-
-