com.scalagent.joram.mom.dest.mail.MailMessage

com.scalagent.joram.mom.dest.mail.MailMessage Class Reference

Collaboration diagram for com.scalagent.joram.mom.dest.mail.MailMessage:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 MailMessage ()
 MailMessage (org.objectweb.joram.shared.messages.Message momMsg)
Message getSharedMessage ()
int getType ()
String getIdentifier ()
boolean getPersistent ()
int getJMSPriority ()
long getJMSExpiration ()
long getTimestamp ()
String getDestinationId ()
String getToType ()
String getCorrelationId ()
String getReplyToId ()
String replyToType ()
int getDeliveryCount ()
boolean getDenied ()
Object getProperty (String name)
String getText ()
void setIdentifier (String id)
void setPersistent (boolean persistent)
void setPriority (int priority)
void setExpiration (long expiration)
void setTimestamp (long timestamp)
void setDestination (String id, String type)
void setCorrelationId (String correlationId)
void setReplyTo (String id, String type)
void setDeliveryCount (int deliveryCount)
void setDenied (boolean redelivered)
void setProperty (String propName, Object propValue)
void setText (String text)

Detailed Description

A mail message encapsulates a proprietary message which is also used for effective MOM transport facility.

Definition at line 32 of file MailMessage.java.

Constructor & Destructor Documentation

com.scalagent.joram.mom.dest.mail.MailMessage.MailMessage (  ) 

Constructs a bright new MailMessage.

Definition at line 38 of file MailMessage.java.

com.scalagent.joram.mom.dest.mail.MailMessage.MailMessage ( org.objectweb.joram.shared.messages.Message  momMsg  ) 

Instanciates a MailMessage wrapping a consumed MOM simple message.

Parameters:
momMsg The MOM message to wrap.

Definition at line 48 of file MailMessage.java.

Member Function Documentation

Message com.scalagent.joram.mom.dest.mail.MailMessage.getSharedMessage (  ) 

Returns:
shared message structure

Definition at line 56 of file MailMessage.java.

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailTopicImpl.doPop(), and com.scalagent.joram.mom.dest.mail.JavaMailQueueImpl.doPop().

int com.scalagent.joram.mom.dest.mail.MailMessage.getType (  ) 

The client message type: SIMPLE, TEXT, OBJECT, MAP, STREAM, BYTES. By default, the message type is SIMPLE.

Returns:
int

Definition at line 66 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.type.

String com.scalagent.joram.mom.dest.mail.MailMessage.getIdentifier (  ) 

The message identifier.

Returns:
identifier

Definition at line 74 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.id.

boolean com.scalagent.joram.mom.dest.mail.MailMessage.getPersistent (  ) 

true if the message must be persisted.

Returns:
persistent

Definition at line 82 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.persistent.

int com.scalagent.joram.mom.dest.mail.MailMessage.getJMSPriority (  ) 

The message priority from 0 to 9, 9 being the highest. By default, the priority is 4?

Returns:
priority

Definition at line 92 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.priority.

long com.scalagent.joram.mom.dest.mail.MailMessage.getJMSExpiration (  ) 

The message expiration time, by default 0 for infinite time-to-live.

Returns:
expiration

Definition at line 100 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.expiration.

long com.scalagent.joram.mom.dest.mail.MailMessage.getTimestamp (  ) 

The message time stamp.

Returns:
time

Definition at line 108 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.timestamp.

String com.scalagent.joram.mom.dest.mail.MailMessage.getDestinationId (  ) 

The message destination identifier.

Returns:
destination id.

Definition at line 116 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.toId.

String com.scalagent.joram.mom.dest.mail.MailMessage.getToType (  ) 

The message destination type.

Returns:
destination type

Definition at line 124 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.toType.

String com.scalagent.joram.mom.dest.mail.MailMessage.getCorrelationId (  ) 

The correlation identifier field.

Returns:
correlation id

Definition at line 132 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.correlationId.

String com.scalagent.joram.mom.dest.mail.MailMessage.getReplyToId (  ) 

The reply to destination identifier.

Returns:
reply id

Definition at line 140 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.replyToId.

String com.scalagent.joram.mom.dest.mail.MailMessage.replyToType (  ) 

true if the "reply to" destination is a queue.

Returns:
reply type

Definition at line 148 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.replyToType.

int com.scalagent.joram.mom.dest.mail.MailMessage.getDeliveryCount (  ) 

The number of delivery attempts for this message.

Returns:
delivery attempts

Definition at line 156 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.deliveryCount.

boolean com.scalagent.joram.mom.dest.mail.MailMessage.getDenied (  ) 

true if the message has been denied at least once by a consumer.

Returns:
denied

Definition at line 165 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.redelivered.

Object com.scalagent.joram.mom.dest.mail.MailMessage.getProperty ( String  name  ) 

true if the message is considered as undeliverable.

Parameters:
name 
Returns:
property value

Definition at line 174 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.getProperty().

Here is the call graph for this function:

String com.scalagent.joram.mom.dest.mail.MailMessage.getText (  ) 

The text body of the message.

Returns:
the text body of the message.

Definition at line 182 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.getText().

Here is the call graph for this function:

void com.scalagent.joram.mom.dest.mail.MailMessage.setIdentifier ( String  id  ) 

The message identifier.

Parameters:
id 

Definition at line 190 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.id.

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailUtil.createMessage().

void com.scalagent.joram.mom.dest.mail.MailMessage.setPersistent ( boolean  persistent  ) 

true if the message must be persisted.

Parameters:
persistent 

Definition at line 198 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.persistent.

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailUtil.createMessage().

void com.scalagent.joram.mom.dest.mail.MailMessage.setPriority ( int  priority  ) 

The message priority from 0 to 9, 9 being the highest. By default, the priority is 4?

Parameters:
priority 

Definition at line 207 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.priority.

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailUtil.createMessage().

void com.scalagent.joram.mom.dest.mail.MailMessage.setExpiration ( long  expiration  ) 

The message expiration time, by default 0 for infinite time-to-live.

Parameters:
expiration 

Definition at line 215 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.expiration.

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailUtil.createMessage().

void com.scalagent.joram.mom.dest.mail.MailMessage.setTimestamp ( long  timestamp  ) 

The message time stamp.

Parameters:
timestamp 

Definition at line 223 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.timestamp.

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailUtil.createMessage().

void com.scalagent.joram.mom.dest.mail.MailMessage.setDestination ( String  id,
String  type 
)

Sets the message destination.

Parameters:
id The destination identifier.
type The type of the destination.

Definition at line 233 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.setDestination().

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailUtil.createMessage().

Here is the call graph for this function:

void com.scalagent.joram.mom.dest.mail.MailMessage.setCorrelationId ( String  correlationId  ) 

The correlation identifier field.

Parameters:
correlationId 

Definition at line 241 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.correlationId.

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailUtil.createMessage().

void com.scalagent.joram.mom.dest.mail.MailMessage.setReplyTo ( String  id,
String  type 
)

Sets the destination to which a reply should be sent.

Parameters:
id The destination identifier.
type The destination type.

Definition at line 251 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.setReplyTo().

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailUtil.createMessage().

Here is the call graph for this function:

void com.scalagent.joram.mom.dest.mail.MailMessage.setDeliveryCount ( int  deliveryCount  ) 

The number of delivery attempts for this message.

Parameters:
deliveryCount 

Definition at line 259 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.deliveryCount.

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailUtil.createMessage().

void com.scalagent.joram.mom.dest.mail.MailMessage.setDenied ( boolean  redelivered  ) 

true if the message has been denied at least once by a consumer.

Parameters:
redelivered 

Definition at line 268 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.redelivered.

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailUtil.createMessage().

void com.scalagent.joram.mom.dest.mail.MailMessage.setProperty ( String  propName,
Object  propValue 
)

Sets a message property.

Parameters:
propName the property name
propValue the property value

Definition at line 277 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.setProperty().

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailUtil.createMessage().

Here is the call graph for this function:

void com.scalagent.joram.mom.dest.mail.MailMessage.setText ( String  text  ) 

Sets a String as the body of the message.

Parameters:
text 

Definition at line 285 of file MailMessage.java.

References org.objectweb.joram.shared.messages.Message.setText().

Referenced by com.scalagent.joram.mom.dest.mail.JavaMailUtil.createMessage().

Here is the call graph for this function:

The documentation for this class was generated from the following file:
Generated on Tue Sep 16 16:15:10 2008 for joram by  doxygen 1.5.0