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
-
JMessage()
-
-
JMessage(String[], String)
- This constructor will create a command message whose only recipient
will be the SNClient on the local machine.
-
JMessage(String[], String, String[])
- This constructor will create a standard message which will be sent
to one or more recipients.
-
getMessage()
- Retrieve the body of the message.
-
getRecipientList()
- Retrieve the list of recipients of the message.
-
getSender()
- Retrieve the originator of the message.
-
isCommandMessage()
- Returns true if this is a command message, and false otherwise.
-
print()
- Display the Jephyr message to stdout.
-
setCommandMessage(boolean)
- Set whether or not this is a command message
-
setMessage(String[])
- Sets the lines of the message.
-
setRecipientList(String[])
- Sets the message recipients.
-
setSender(String)
- Sets the name of the originator of the message.
JMessage
public JMessage()
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.
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.
getMessage
public String[] getMessage()
- Retrieve the body of the message.
- Returns:
- A string array consisting of the lines of the message.
setMessage
public void setMessage(String messagelines[])
- Sets the lines of the message.
- Parameters:
- messageslines - The new contents of the message.
getSender
public String getSender()
- Retrieve the originator of the message.
- Returns:
- The originator of the message.
setSender
public void setSender(String sender)
- Sets the name of the originator of the message.
- Parameters:
- sender - The name of the sender.
getRecipientList
public String[] getRecipientList()
- Retrieve the list of recipients of the message.
- Returns:
- A string array containing all of the message recipients.
setRecipientList
public void setRecipientList(String recipientlist[])
- Sets the message recipients.
- Parameters:
- recipientlist - The new array containing the desired recipients.
isCommandMessage
public boolean isCommandMessage()
- Returns true if this is a command message, and false otherwise.
setCommandMessage
public void setCommandMessage(boolean flag)
- Set whether or not this is a command message
print
public void print()
- Display the Jephyr message to stdout.
All Packages Class Hierarchy This Package Previous Next Index