ie.ncl.sms.smpp
Class Message

java.lang.Object
  ie.ncl.sms.smpp.prot.Message
      ie.ncl.sms.smpp.Message

public class Message
extends ie.ncl.sms.smpp.prot.Message

Constructor Summary

Message()
This creates an empty message.

Message(Address to, byte[] bytes)

Message(Address to, java.lang.String s)

Method Summary

void	CC(Address address) Add a distribution list recipient.
void	CC(java.lang.String name) Add a distribution list recipient (send carbon copy to this list).
boolean	ccContains(java.lang.Object obj)
byte[]	getBytes() Get the message bytes.
int	getCommandId()
int	getCommandStatus()
int	getDataLength() Get the number of bytes in the message.
java.lang.String	getMessageId() Return the Id of the message.
boolean	getPriority() Get the priority (true if priority level is 1 or more).
boolean	getRegistered() Returns the registered delivery flag.
byte[]	getRequestPdu()
int	getResponseCommandId()
int	getResponseCommandStatus()
byte[]	getResponsePdu()
java.lang.String	getText() Get the text part of the message.
boolean	isErrorNotificationMessage()
boolean	multiRecipient() Indicates if the message is multi receipient or not.
void	setBytes(byte[] bytes) Set the body of the message as bytes.
void	setCommandId(int commandId)
void	setCommandStatus(int commandStatus)
void	setErrorNotificationMessage(boolean errorNotificationMessage)
void	setMessageId(java.lang.String id) set the id of the message.
void	setPriority(boolean priority) Set the priority (sets the priority level to 1).
void	setRegistered(boolean registered) Set the registered flag.
void	setRegistered(int registeredValue)
void	setRequestPdu(byte[] requestPdu)
void	setResponseCommandId(int responseCommandId)
void	setResponseCommandStatus(int responseCommandStatus)
void	setResponsePdu(byte[] responsePdu)
void	setText(java.lang.String text) Set the text part of the message.
void	setTo(java.lang.String distributionList) Specify the destination address as a distribution list.
java.lang.String	toString() This method puts the message structure in a printable string.

Methods inherited from class ie.ncl.sms.smpp.prot.Message

addRecipient, getData, getDcs, getEsm, getExpiry, getExpiryAsValidityPeriod, getFails, getFrom, getGsmError, getId, getPid, getPredefined, getPriorityService, getRecipients, getRecipientsAsVector, getRegisteredService, getReplacement, getSchedule, getScheduleAsRelativeDate, getScheduleRelative, getService, getStatus, getTimeStamp, getTo, getUserDataLength, getValidityAsRelativeDate, setData, setDcs, setEsm, setExpiry, setFails, setFrom, setGsmError, setId, setPid, setPredefined, setPriorityService, setRecipients, setRegisteredService, setRelativeExpiry, setReplacement, setSchedule, setScheduleAsRelativeDate, setScheduleRelative, setService, setStatus, setTimeStamp, setTo, setUserDataLength, setValidityAsRelativeDate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message(Address to,
               java.lang.String s)

Message

public Message(Address to,
               byte[] bytes)

Message

public Message()

This creates an empty message.

Method Detail

getResponsePdu

public byte[] getResponsePdu()

setResponsePdu

public void setResponsePdu(byte[] responsePdu)

getRequestPdu

public byte[] getRequestPdu()

setRequestPdu

public void setRequestPdu(byte[] requestPdu)

isErrorNotificationMessage

public boolean isErrorNotificationMessage()

setErrorNotificationMessage

public void setErrorNotificationMessage(boolean errorNotificationMessage)

getCommandId

public int getCommandId()

setCommandId

public void setCommandId(int commandId)

getCommandStatus

public int getCommandStatus()

setCommandStatus

public void setCommandStatus(int commandStatus)

getResponseCommandId

public int getResponseCommandId()

setResponseCommandId

public void setResponseCommandId(int responseCommandId)

getResponseCommandStatus

public int getResponseCommandStatus()

setResponseCommandStatus

public void setResponseCommandStatus(int responseCommandStatus)

setText

public void setText(java.lang.String text)

Set the text part of the message.

getText

public java.lang.String getText()

Get the text part of the message.

setBytes

public void setBytes(byte[] bytes)

Set the body of the message as bytes.

getBytes

public byte[] getBytes()

Get the message bytes.

getDataLength

public int getDataLength()

Get the number of bytes in the message.

setTo

public void setTo(java.lang.String distributionList)

Specify the destination address as a distribution list.

ccContains

public boolean ccContains(java.lang.Object obj)

CC

public void CC(Address address)

Add a distribution list recipient.

CC

public void CC(java.lang.String name)

Add a distribution list recipient (send carbon copy to this list).

multiRecipient

public boolean multiRecipient()

Indicates if the message is multi receipient or not.

setPriority

public void setPriority(boolean priority)

Set the priority (sets the priority level to 1).

getPriority

public boolean getPriority()

Get the priority (true if priority level is 1 or more).

setRegistered

public void setRegistered(boolean registered)

Set the registered flag. Delivery receipts will be received when the message goes into a final state (delivered, permanent error).

setRegistered

public void setRegistered(int registeredValue)

getRegistered

public boolean getRegistered()

Returns the registered delivery flag.

setMessageId

public void setMessageId(java.lang.String id)

set the id of the message.

getMessageId

public java.lang.String getMessageId()

Return the Id of the message.

toString

public java.lang.String toString()

This method puts the message structure in a printable string. It should only be used for debugging purposes as the string contains new line characters.

Overrides:

toString in class java.lang.Object

Returns:

The 'stringified' short message attributes.