All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.devtools.SIPNoTE.JMessage

java.lang.Object
   |
   +----com.ibm.devtools.SIPNoTE.JMessage

public class JMessage
extends Object
implements Serializable
This class represents the basic Jephyr message. Jephyr messages are sent as objects between the SNClient and the standalone applications. A simple representation of this object is encoded in the content of the SIP messages.

See Also:
SNClient, jlocate, jlogon, jlogoff, jwrite

Constructor Index

 o JMessage()
 o JMessage(String[], String)
This constructor will create a command message whose only recipient will be the SNClient on the local machine.
 o JMessage(String[], String, String[])
This constructor will create a standard message which will be sent to one or more recipients.

Method Index

 o getMessage()
Retrieve the body of the message.
 o getRecipientList()
Retrieve the list of recipients of the message.
 o getSender()
Retrieve the originator of the message.
 o isCommandMessage()
Returns true if this is a command message, and false otherwise.
 o print()
Display the Jephyr message to stdout.
 o setCommandMessage(boolean)
Set whether or not this is a command message
 o setMessage(String[])
Sets the lines of the message.
 o setRecipientList(String[])
Sets the message recipients.
 o setSender(String)
Sets the name of the originator of the message.

Constructors

 o JMessage
 public JMessage()
 o JMessage
 public JMessage(String messagelines[],
                 String sender,
                 String recipientlist[])
This constructor will create a standard message which will be sent to one or more recipients.

Parameters:
messagelines - Array of strings which compose the body of the message.
sender - The sender of the message.
recipientlist - An array which contains the list of recipients of the message.
 o JMessage
 public JMessage(String messagelines[],
                 String sender)
This constructor will create a command message whose only recipient will be the SNClient on the local machine.

Parameters:
messagelines - Array of strings which compose the body of the message.
sender - The sender of the message.

Methods

 o getMessage
 public String[] getMessage()
Retrieve the body of the message.

Returns:
A string array consisting of the lines of the message.
 o setMessage
 public void setMessage(String messagelines[])
Sets the lines of the message.

Parameters:
messageslines - The new contents of the message.
 o getSender
 public String getSender()
Retrieve the originator of the message.

Returns:
The originator of the message.
 o setSender
 public void setSender(String sender)
Sets the name of the originator of the message.

Parameters:
sender - The name of the sender.
 o getRecipientList
 public String[] getRecipientList()
Retrieve the list of recipients of the message.

Returns:
A string array containing all of the message recipients.
 o setRecipientList
 public void setRecipientList(String recipientlist[])
Sets the message recipients.

Parameters:
recipientlist - The new array containing the desired recipients.
 o isCommandMessage
 public boolean isCommandMessage()
Returns true if this is a command message, and false otherwise.

 o setCommandMessage
 public void setCommandMessage(boolean flag)
Set whether or not this is a command message

 o print
 public void print()
Display the Jephyr message to stdout.


All Packages  Class Hierarchy  This Package  Previous  Next  Index