com.scalagent.kjoram.messages.Message

com.scalagent.kjoram.messages.Message Class Reference

List of all members.

Public Member Functions

 Message ()
void setIdentifier (String id)
void setPersistent (boolean persistent)
void setPriority (int priority)
void setExpiration (long expiration)
void setTimestamp (long timestamp)
void setDestination (String id, boolean queue)
void setCorrelationId (String correlationId)
void setReplyTo (String id, boolean queue)
void setOptionalHeader (String name, Object value)
int getType ()
String getIdentifier ()
boolean getPersistent ()
int getPriority ()
long getExpiration ()
long getTimestamp ()
String getDestinationId ()
boolean toQueue ()
String getCorrelationId ()
String getReplyToId ()
boolean replyToQueue ()
Object getOptionalHeader (String name)
void setBooleanProperty (String name, boolean value) throws MessageROException
void setByteProperty (String name, byte value) throws MessageROException
void setIntProperty (String name, int value) throws MessageROException
void setLongProperty (String name, long value) throws MessageROException
void setObjectProperty (String name, Object value) throws MessageException
void setShortProperty (String name, short value) throws MessageROException
void setStringProperty (String name, String value) throws MessageROException
boolean getBooleanProperty (String name) throws MessageValueException
byte getByteProperty (String name) throws MessageValueException
int getIntProperty (String name) throws MessageValueException
long getLongProperty (String name) throws MessageValueException
Object getObjectProperty (String name)
short getShortProperty (String name) throws MessageValueException
String getStringProperty (String name)
boolean propertyExists (String name)
Enumeration getPropertyNames ()
void clearProperties ()
void setMap (Hashtable map) throws Exception
void setText (String text) throws MessageROException
void setStream (byte[] bytes) throws MessageROException
void setBytes (byte[] bytes) throws MessageROException
Hashtable getMap ()
String getText ()
byte[] getStream ()
byte[] getBytes ()
void clearBody ()
boolean isValid ()
Object clone ()
Hashtable soapCode ()

Static Public Member Functions

static Message soapDecode (Hashtable h)

Public Attributes

int deliveryCount = 0
boolean denied = false
boolean deletedDest = false
boolean expired = false
boolean notWriteable = false
boolean undeliverable = false
transient int acksCounter
transient int durableAcksCounter

Package Attributes

int type
boolean persistent = true
String id = null
int priority = 4
long expiration = 0
long timestamp
String toId = null
boolean toQueue
String correlationId = null
String replyToId = null
boolean replyToQueue
Hashtable optionalHeader = null
byte[] body_bytes = null
Hashtable body_map = null
String body_text = null
boolean bodyRO = false
Hashtable properties = null
boolean propertiesRO = false

Detailed Description

The Message class actually provides the transport facility for the data exchanged during MOM operations.

A message may either carry a String, or a serializable object, or an hashtable, or bytes, even nothing. It is charaterized by properties and "header" fields.

Definition at line 39 of file Message.java.

Constructor & Destructor Documentation

com.scalagent.kjoram.messages.Message.Message (  ) 

Constructs a Message instance.

Definition at line 118 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.clone(), and com.scalagent.kjoram.messages.Message.soapDecode().

Member Function Documentation

void com.scalagent.kjoram.messages.Message.setIdentifier ( String  id  ) 

Sets the message identifier.

Definition at line 125 of file Message.java.

void com.scalagent.kjoram.messages.Message.setPersistent ( boolean  persistent  ) 

Sets the message persistence mode.

Definition at line 131 of file Message.java.

void com.scalagent.kjoram.messages.Message.setPriority ( int  priority  ) 

Sets the message priority.

Parameters:
priority Priority value: 0 the lowest, 9 the highest, 4 normal.

Definition at line 141 of file Message.java.

void com.scalagent.kjoram.messages.Message.setExpiration ( long  expiration  ) 

Sets the message expiration.

Definition at line 148 of file Message.java.

void com.scalagent.kjoram.messages.Message.setTimestamp ( long  timestamp  ) 

Sets the message time stamp.

Definition at line 155 of file Message.java.

void com.scalagent.kjoram.messages.Message.setDestination ( String  id,
boolean  queue 
)

Sets the message destination.

Parameters:
id The destination identifier.
queue true if the destination is a queue.

Definition at line 166 of file Message.java.

void com.scalagent.kjoram.messages.Message.setCorrelationId ( String  correlationId  ) 

Sets the message correlation identifier.

Definition at line 173 of file Message.java.

void com.scalagent.kjoram.messages.Message.setReplyTo ( String  id,
boolean  queue 
)

Sets the destination to which a reply should be sent.

Parameters:
id The destination identifier.
queue true if the destination is a queue.

Definition at line 184 of file Message.java.

void com.scalagent.kjoram.messages.Message.setOptionalHeader ( String  name,
Object  value 
)

Sets an optional header field value.

Parameters:
name The header field name.
value The corresponding value.

Definition at line 196 of file Message.java.

References com.scalagent.kjoram.messages.Message.optionalHeader.

int com.scalagent.kjoram.messages.Message.getType (  ) 

Returns the message type.

Definition at line 211 of file Message.java.

References com.scalagent.kjoram.messages.Message.type.

String com.scalagent.kjoram.messages.Message.getIdentifier (  ) 

Returns the message identifier.

Definition at line 217 of file Message.java.

References com.scalagent.kjoram.messages.Message.id.

boolean com.scalagent.kjoram.messages.Message.getPersistent (  ) 

Returns true if the message is persistent.

Definition at line 223 of file Message.java.

References com.scalagent.kjoram.messages.Message.persistent.

int com.scalagent.kjoram.messages.Message.getPriority (  ) 

Returns the message priority.

Definition at line 229 of file Message.java.

References com.scalagent.kjoram.messages.Message.priority.

long com.scalagent.kjoram.messages.Message.getExpiration (  ) 

Returns the message expiration time.

Definition at line 235 of file Message.java.

References com.scalagent.kjoram.messages.Message.expiration.

long com.scalagent.kjoram.messages.Message.getTimestamp (  ) 

Returns the message time stamp.

Definition at line 241 of file Message.java.

References com.scalagent.kjoram.messages.Message.timestamp.

String com.scalagent.kjoram.messages.Message.getDestinationId (  ) 

Returns the message destination identifier.

Definition at line 247 of file Message.java.

References com.scalagent.kjoram.messages.Message.toId.

boolean com.scalagent.kjoram.messages.Message.toQueue (  ) 

Returns true if the destination is a queue.

Definition at line 253 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.clone(), and com.scalagent.kjoram.messages.Message.soapCode().

String com.scalagent.kjoram.messages.Message.getCorrelationId (  ) 

Returns the message correlation identifier.

Definition at line 259 of file Message.java.

References com.scalagent.kjoram.messages.Message.correlationId.

String com.scalagent.kjoram.messages.Message.getReplyToId (  ) 

Returns the destination id the reply should be sent to.

Definition at line 265 of file Message.java.

References com.scalagent.kjoram.messages.Message.replyToId.

boolean com.scalagent.kjoram.messages.Message.replyToQueue (  ) 

Returns true if the reply to destination is a queue.

Definition at line 271 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.clone(), and com.scalagent.kjoram.messages.Message.soapCode().

Object com.scalagent.kjoram.messages.Message.getOptionalHeader ( String  name  ) 

Returns an optional header field value.

Parameters:
name The header field name.

Definition at line 281 of file Message.java.

References com.scalagent.kjoram.messages.Message.optionalHeader.

void com.scalagent.kjoram.messages.Message.setBooleanProperty ( String  name,
boolean  value 
) throws MessageROException

Sets a property as a boolean value.

Parameters:
name The property name.
value The property value.
Exceptions:
MessageROException If the message properties are read-only.

Definition at line 297 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

void com.scalagent.kjoram.messages.Message.setByteProperty ( String  name,
byte  value 
) throws MessageROException

Sets a property as a byte value.

Parameters:
name The property name.
value The property value.
Exceptions:
MessageROException If the message properties are read-only.

Definition at line 312 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

void com.scalagent.kjoram.messages.Message.setIntProperty ( String  name,
int  value 
) throws MessageROException

Sets a property as an int value.

Parameters:
name The property name.
value The property value.
Exceptions:
MessageROException If the message properties are read-only.

Definition at line 357 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

void com.scalagent.kjoram.messages.Message.setLongProperty ( String  name,
long  value 
) throws MessageROException

Sets a property as a long value.

Parameters:
name The property name.
value The property value.
Exceptions:
MessageROException If the message properties are read-only.

Definition at line 371 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

void com.scalagent.kjoram.messages.Message.setObjectProperty ( String  name,
Object  value 
) throws MessageException

Sets a property value.

Parameters:
name The property name.
value The property value.
Exceptions:
MessageROException If the message properties are read-only.
MessageValueException If the value is not a Java primitive object.

Definition at line 388 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

void com.scalagent.kjoram.messages.Message.setShortProperty ( String  name,
short  value 
) throws MessageROException

Sets a property as a short value.

Parameters:
name The property name.
value The property value.
Exceptions:
MessageROException If the message properties are read-only.

Definition at line 414 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

void com.scalagent.kjoram.messages.Message.setStringProperty ( String  name,
String  value 
) throws MessageROException

Sets a property as a String.

Parameters:
name The property name.
value The property value.
Exceptions:
MessageROException If the message properties are read-only.

Definition at line 429 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

boolean com.scalagent.kjoram.messages.Message.getBooleanProperty ( String  name  )  throws MessageValueException

Returns a property as a boolean value.

Exceptions:
MessageValueException If the property type is invalid.

Definition at line 441 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

byte com.scalagent.kjoram.messages.Message.getByteProperty ( String  name  )  throws MessageValueException

Exceptions:
MessageValueException If the property type is invalid.

Definition at line 452 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

int com.scalagent.kjoram.messages.Message.getIntProperty ( String  name  )  throws MessageValueException

Returns a property as a int value.

Parameters:
name The property name.
Exceptions:
MessageValueException If the property type is invalid.

Definition at line 494 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

long com.scalagent.kjoram.messages.Message.getLongProperty ( String  name  )  throws MessageValueException

Returns a property as a long value.

Parameters:
name The property name.
Exceptions:
MessageValueException If the property type is invalid.

Definition at line 508 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

Object com.scalagent.kjoram.messages.Message.getObjectProperty ( String  name  ) 

Returns a property as an object.

Parameters:
name The property name.

Definition at line 520 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

short com.scalagent.kjoram.messages.Message.getShortProperty ( String  name  )  throws MessageValueException

Returns a property as a short value.

Parameters:
name The property name.
Exceptions:
MessageValueException If the property type is invalid.

Definition at line 534 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

String com.scalagent.kjoram.messages.Message.getStringProperty ( String  name  ) 

Returns a property as a String.

Parameters:
name The property name.

Definition at line 546 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

boolean com.scalagent.kjoram.messages.Message.propertyExists ( String  name  ) 

Returns true if a given property exists.

Parameters:
name The name of the property to check.

Definition at line 558 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

Enumeration com.scalagent.kjoram.messages.Message.getPropertyNames (  ) 

Returns an enumeration of the properties names.

Definition at line 567 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties.

void com.scalagent.kjoram.messages.Message.clearProperties (  ) 

Empties the properties table.

Definition at line 576 of file Message.java.

References com.scalagent.kjoram.messages.Message.properties, and com.scalagent.kjoram.messages.Message.propertiesRO.

void com.scalagent.kjoram.messages.Message.setMap ( Hashtable  map  )  throws Exception

Sets a map as the body of the message.

Exceptions:
IOException In case of an error while setting the map.
MessageROException If the message body is read-only.

Definition at line 593 of file Message.java.

References com.scalagent.kjoram.messages.Message.body_map, com.scalagent.kjoram.messages.Message.bodyRO, and com.scalagent.kjoram.messages.Message.type.

void com.scalagent.kjoram.messages.Message.setText ( String  text  )  throws MessageROException

Sets a String as the body of the message.

Exceptions:
MessageROException If the message body is read-only.

Definition at line 607 of file Message.java.

References com.scalagent.kjoram.messages.Message.body_text, com.scalagent.kjoram.messages.Message.bodyRO, and com.scalagent.kjoram.messages.Message.type.

void com.scalagent.kjoram.messages.Message.setStream ( byte[]  bytes  )  throws MessageROException

Sets the message body as a stream of bytes.

Exceptions:
MessageROException If the message body is read-only.

Definition at line 621 of file Message.java.

References com.scalagent.kjoram.messages.Message.body_bytes, com.scalagent.kjoram.messages.Message.bodyRO, and com.scalagent.kjoram.messages.Message.type.

void com.scalagent.kjoram.messages.Message.setBytes ( byte[]  bytes  )  throws MessageROException

Sets the message body as an array of bytes.

Exceptions:
MessageROException If the message body is read-only.

Definition at line 635 of file Message.java.

References com.scalagent.kjoram.messages.Message.body_bytes, com.scalagent.kjoram.messages.Message.bodyRO, and com.scalagent.kjoram.messages.Message.type.

Hashtable com.scalagent.kjoram.messages.Message.getMap (  ) 

Returns the map body of the message.

Definition at line 647 of file Message.java.

References com.scalagent.kjoram.messages.Message.body_map.

String com.scalagent.kjoram.messages.Message.getText (  ) 

Gets the String body of the message.

Definition at line 653 of file Message.java.

References com.scalagent.kjoram.messages.Message.body_text.

byte [] com.scalagent.kjoram.messages.Message.getStream (  ) 

Returns the stream of bytes body of the message.

Definition at line 659 of file Message.java.

References com.scalagent.kjoram.messages.Message.body_bytes, and com.scalagent.kjoram.messages.Message.type.

byte [] com.scalagent.kjoram.messages.Message.getBytes (  ) 

Returns the array of bytes body of the message.

Definition at line 668 of file Message.java.

References com.scalagent.kjoram.messages.Message.body_bytes, and com.scalagent.kjoram.messages.Message.type.

void com.scalagent.kjoram.messages.Message.clearBody (  ) 

Method clearing the message body.

Definition at line 679 of file Message.java.

References com.scalagent.kjoram.messages.Message.body_bytes, com.scalagent.kjoram.messages.Message.body_map, com.scalagent.kjoram.messages.Message.body_text, and com.scalagent.kjoram.messages.Message.bodyRO.

boolean com.scalagent.kjoram.messages.Message.isValid (  ) 

Returns true if the message is valid.

Definition at line 688 of file Message.java.

References com.scalagent.kjoram.messages.Message.expiration.

Object com.scalagent.kjoram.messages.Message.clone (  ) 

Clones the message.

Definition at line 697 of file Message.java.

References com.scalagent.kjoram.messages.Message.acksCounter, com.scalagent.kjoram.messages.Message.body_bytes, com.scalagent.kjoram.messages.Message.body_map, com.scalagent.kjoram.messages.Message.body_text, com.scalagent.kjoram.messages.Message.bodyRO, com.scalagent.kjoram.messages.Message.correlationId, com.scalagent.kjoram.messages.Message.deletedDest, com.scalagent.kjoram.messages.Message.deliveryCount, com.scalagent.kjoram.messages.Message.denied, com.scalagent.kjoram.messages.Message.durableAcksCounter, com.scalagent.kjoram.messages.Message.expiration, com.scalagent.kjoram.messages.Message.expired, com.scalagent.kjoram.messages.Message.id, com.scalagent.kjoram.messages.Message.Message(), com.scalagent.kjoram.messages.Message.notWriteable, com.scalagent.kjoram.messages.Message.optionalHeader, com.scalagent.kjoram.messages.Message.persistent, com.scalagent.kjoram.messages.Message.priority, com.scalagent.kjoram.messages.Message.properties, com.scalagent.kjoram.messages.Message.propertiesRO, com.scalagent.kjoram.messages.Message.replyToId, com.scalagent.kjoram.messages.Message.replyToQueue(), com.scalagent.kjoram.messages.Message.timestamp, com.scalagent.kjoram.messages.Message.toId, com.scalagent.kjoram.messages.Message.toQueue(), com.scalagent.kjoram.messages.Message.type, and com.scalagent.kjoram.messages.Message.undeliverable.

Here is the call graph for this function:

Hashtable com.scalagent.kjoram.messages.Message.soapCode (  ) 

Transforms this message into a vector of primitive values that can be vehiculated through the SOAP protocol.

Definition at line 757 of file Message.java.

References com.scalagent.kjoram.messages.Message.body_bytes, com.scalagent.kjoram.messages.Message.body_map, com.scalagent.kjoram.messages.Message.body_text, com.scalagent.kjoram.messages.Message.bodyRO, com.scalagent.kjoram.messages.Message.correlationId, com.scalagent.kjoram.messages.Message.deletedDest, com.scalagent.kjoram.messages.Message.deliveryCount, com.scalagent.kjoram.messages.Message.denied, com.scalagent.kjoram.messages.Message.expiration, com.scalagent.kjoram.messages.Message.expired, com.scalagent.kjoram.messages.Message.notWriteable, com.scalagent.kjoram.messages.Message.optionalHeader, com.scalagent.kjoram.messages.Message.persistent, com.scalagent.kjoram.messages.Message.priority, com.scalagent.kjoram.messages.Message.properties, com.scalagent.kjoram.messages.Message.propertiesRO, com.scalagent.kjoram.messages.Message.replyToId, com.scalagent.kjoram.messages.Message.replyToQueue(), com.scalagent.kjoram.messages.Message.timestamp, com.scalagent.kjoram.messages.Message.toId, com.scalagent.kjoram.messages.Message.toQueue(), com.scalagent.kjoram.messages.Message.type, and com.scalagent.kjoram.messages.Message.undeliverable.

Referenced by com.scalagent.kjoram.jms.QBrowseReply.soapCode(), com.scalagent.kjoram.jms.ProducerMessages.soapCode(), and com.scalagent.kjoram.jms.ConsumerMessages.soapCode().

Here is the call graph for this function:

static Message com.scalagent.kjoram.messages.Message.soapDecode ( Hashtable  h  )  [static]

Transforms a vector of primitive values into a Message instance.

Definition at line 809 of file Message.java.

References com.scalagent.kjoram.messages.Message.body_bytes, com.scalagent.kjoram.messages.Message.body_map, com.scalagent.kjoram.messages.Message.body_text, com.scalagent.kjoram.messages.Message.bodyRO, com.scalagent.kjoram.messages.Message.correlationId, com.scalagent.kjoram.messages.Message.deletedDest, com.scalagent.kjoram.messages.Message.deliveryCount, com.scalagent.kjoram.messages.Message.denied, com.scalagent.kjoram.messages.Message.expiration, com.scalagent.kjoram.messages.Message.expired, com.scalagent.kjoram.messages.Message.id, com.scalagent.kjoram.messages.Message.Message(), com.scalagent.kjoram.messages.Message.notWriteable, com.scalagent.kjoram.messages.Message.optionalHeader, com.scalagent.kjoram.messages.Message.persistent, com.scalagent.kjoram.messages.Message.priority, com.scalagent.kjoram.messages.Message.properties, com.scalagent.kjoram.messages.Message.propertiesRO, com.scalagent.kjoram.messages.Message.replyToId, com.scalagent.kjoram.messages.Message.replyToQueue, com.scalagent.kjoram.messages.Message.timestamp, com.scalagent.kjoram.messages.Message.toId, com.scalagent.kjoram.messages.Message.toQueue, com.scalagent.kjoram.messages.Message.type, and com.scalagent.kjoram.messages.Message.undeliverable.

Here is the call graph for this function:

Member Data Documentation

int com.scalagent.kjoram.messages.Message.type [package]

The message type (SIMPLE, TEXT, MAP, BYTES).

Definition at line 41 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.clone(), com.scalagent.kjoram.messages.Message.getBytes(), com.scalagent.kjoram.messages.Message.getStream(), com.scalagent.kjoram.messages.Message.getType(), com.scalagent.kjoram.messages.Message.setBytes(), com.scalagent.kjoram.messages.Message.setMap(), com.scalagent.kjoram.messages.Message.setStream(), com.scalagent.kjoram.messages.Message.setText(), com.scalagent.kjoram.messages.Message.soapCode(), and com.scalagent.kjoram.messages.Message.soapDecode().

boolean com.scalagent.kjoram.messages.Message.persistent = true [package]

true if the message must be persisted.

Definition at line 44 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.clone(), com.scalagent.kjoram.messages.Message.getPersistent(), com.scalagent.kjoram.messages.Message.soapCode(), and com.scalagent.kjoram.messages.Message.soapDecode().

String com.scalagent.kjoram.messages.Message.id = null [package]

The message identifier.

Definition at line 47 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.clone(), com.scalagent.kjoram.messages.Message.getIdentifier(), and com.scalagent.kjoram.messages.Message.soapDecode().

int com.scalagent.kjoram.messages.Message.priority = 4 [package]

The message priority (from 0 to 9, 9 being the highest).

Definition at line 49 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.clone(), com.scalagent.kjoram.messages.Message.getPriority(), com.scalagent.kjoram.messages.Message.soapCode(), and com.scalagent.kjoram.messages.Message.soapDecode().

long com.scalagent.kjoram.messages.Message.expiration = 0 [package]

The message expiration time (0 for infinite time-to-live).

Definition at line 51 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.clone(), com.scalagent.kjoram.messages.Message.getExpiration(), com.scalagent.kjoram.messages.Message.isValid(), com.scalagent.kjoram.messages.Message.soapCode(), and com.scalagent.kjoram.messages.Message.soapDecode().

long com.scalagent.kjoram.messages.Message.timestamp [package]

The message time stamp.

Definition at line 53 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.clone(), com.scalagent.kjoram.messages.Message.getTimestamp(), com.scalagent.kjoram.messages.Message.soapCode(), and com.scalagent.kjoram.messages.Message.soapDecode().

String com.scalagent.kjoram.messages.Message.toId = null [package]

The message destination identifier.

Definition at line 55 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.clone(), com.scalagent.kjoram.messages.Message.getDestinationId(), com.scalagent.kjoram.messages.Message.soapCode(), and com.scalagent.kjoram.messages.Message.soapDecode().

boolean com.scalagent.kjoram.messages.Message.toQueue [package]

true if the message destination is a queue.

Definition at line 57 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.soapDecode().

String com.scalagent.kjoram.messages.Message.correlationId = null [package]

The correlation identifier field.

Definition at line 59 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.clone(), com.scalagent.kjoram.messages.Message.getCorrelationId(), com.scalagent.kjoram.messages.Message.soapCode(), and com.scalagent.kjoram.messages.Message.soapDecode().

String com.scalagent.kjoram.messages.Message.replyToId = null [package]

The reply to destination identifier.

Definition at line 61 of file Message.java.

Referenced by com.scalagent.kjoram.messages.Message.clone(), com.scalagent.kjoram.messages.Message.getReplyToId(), com.scalagent.kjoram.messages.Message.soapCode(), and com.scalagent.kjoram.messages.Message.soapDecode().