|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sourceforge.jmmslib.MmsMessage
public class MmsMessage
Represents an mms message.
This class is used to fill the field of an mms message and do some basic data validation.
The field required for the various type of mms messages are listed on the document WAP-209-MMSEncapsulation-20020105-a, avaiable at the Open Mobile Alliance web site.
Field Summary | |
---|---|
static java.lang.String |
CHARSET_US_ASCII
|
static java.lang.String |
CHARSET_UTF8
|
static java.lang.String |
CTYPE_APPLICATION_MULTIPART_MIXED
|
static java.lang.String |
CTYPE_APPLICATION_MULTIPART_RELATED
|
static java.lang.String |
CTYPE_IMAGE
|
static java.lang.String |
CTYPE_IMAGE_GIF
|
static java.lang.String |
CTYPE_IMAGE_JPEG
|
static java.lang.String |
CTYPE_IMAGE_PNG
|
static java.lang.String |
CTYPE_IMAGE_TIFF
|
static java.lang.String |
CTYPE_IMAGE_VND_WAP_WBMP
|
static java.lang.String |
CTYPE_MULTIPART
|
static java.lang.String |
CTYPE_MULTIPART_MIXED
|
static java.lang.String |
CTYPE_TEXT
|
static java.lang.String |
CTYPE_TEXT_HTML
|
static java.lang.String |
CTYPE_TEXT_PLAIN
|
static java.lang.String |
CTYPE_TEXT_WML
|
static java.lang.String |
CTYPE_UNKNOWN
|
static java.lang.String |
MMS_ADDRESS_TYPE_IPV4
|
static java.lang.String |
MMS_ADDRESS_TYPE_IPV6
|
static java.lang.String |
MMS_ADDRESS_TYPE_MAIL
|
static java.lang.String |
MMS_ADDRESS_TYPE_MOBILE_NUMBER
|
static java.lang.String |
MMS_BCC
|
static java.lang.String |
MMS_CC
|
static java.lang.String |
MMS_CLASS
|
static java.lang.String |
MMS_CLASS_ADVERTISEMENT
|
static java.lang.String |
MMS_CLASS_AUTO
|
static java.lang.String |
MMS_CLASS_INFORMATIONAL
|
static java.lang.String |
MMS_CLASS_PERSONAL
|
static java.lang.String |
MMS_CONTENT_TYPE
|
static java.lang.String |
MMS_DATE
|
static java.lang.String |
MMS_DELIVERY_REPORT
|
static java.lang.String |
MMS_DELIVERY_REPORT_NO
|
static java.lang.String |
MMS_DELIVERY_REPORT_YES
|
static java.lang.String |
MMS_DELIVERY_TIME
|
static java.lang.String |
MMS_EXPIRY
|
static java.lang.String |
MMS_FROM
|
static java.lang.String |
MMS_MESSAGE_ID
|
static java.lang.String |
MMS_MESSAGE_TYPE
|
static java.lang.String |
MMS_MESSAGE_TYPE_SEND_CONF
|
static java.lang.String |
MMS_MESSAGE_TYPE_SEND_REQUEST
|
static java.lang.String |
MMS_PRIORITY
|
static java.lang.String |
MMS_PRIORITY_HIGH
|
static java.lang.String |
MMS_PRIORITY_LOW
|
static java.lang.String |
MMS_PRIORITY_NORMAL
|
static java.lang.String |
MMS_READ_REPLY
|
static java.lang.String |
MMS_READ_REPLY_NO
|
static java.lang.String |
MMS_READ_REPLY_YES
|
static java.lang.String |
MMS_RESPONSE_STATUS
|
static java.lang.String |
MMS_RESPONSE_STATUS_ERROR_CONTENT_NOT_ACCEPTED
|
static java.lang.String |
MMS_RESPONSE_STATUS_ERROR_MESSAGE_FORMAT_CORRUPT
|
static java.lang.String |
MMS_RESPONSE_STATUS_ERROR_MESSAGE_NOT_FOUND
|
static java.lang.String |
MMS_RESPONSE_STATUS_ERROR_NETWORK_PROBLEM
|
static java.lang.String |
MMS_RESPONSE_STATUS_ERROR_SENDING_ADDRESS_UNRESOLVED
|
static java.lang.String |
MMS_RESPONSE_STATUS_ERROR_SERVICE_DENIED
|
static java.lang.String |
MMS_RESPONSE_STATUS_ERROR_UNSPECIFIED
|
static java.lang.String |
MMS_RESPONSE_STATUS_ERROR_UNSUPPORTED_MESSAGE
|
static java.lang.String |
MMS_RESPONSE_STATUS_OK
|
static java.lang.String |
MMS_RESPONSE_TEXT
|
static java.lang.String |
MMS_SENDER_VISIBILITY
|
static java.lang.String |
MMS_SENDER_VISIBILITY_HIDE
|
static java.lang.String |
MMS_SENDER_VISIBILITY_SHOW
|
static java.lang.String |
MMS_SUBJECT
|
static java.lang.String |
MMS_TO
|
static java.lang.String |
MMS_TRANSACTION_ID
|
static java.lang.String |
MMS_VERSION
|
static java.lang.String |
MMS_VERSION_1
|
Constructor Summary | |
---|---|
MmsMessage()
Creates an MmsMessage object. |
Method Summary | |
---|---|
void |
addMessaceBCC(java.lang.String receiver,
java.lang.String addressType)
Adds a message BCC |
void |
addMessageCC(java.lang.String receiver,
java.lang.String addressType)
Adds a message CC. |
void |
addMessageReceiver(java.lang.String receiver,
java.lang.String addressType)
Adds a message receiver. |
void |
addPart(MmsPart part)
Add a part to the MMS message. |
java.util.List<java.lang.String> |
getMessageBCC()
Return the BCCs list |
java.util.List<java.lang.String> |
getMessageCC()
Return the CCs list. |
java.lang.String |
getMessageClass()
Returns the message class. |
java.lang.String |
getMessageContentType()
Returns the message content type. |
java.util.Date |
getMessageDate()
Returns the date of the message. |
java.util.Date |
getMessageDeliveryTime()
Returns the delivery time of the message. |
java.util.Date |
getMessageExpiryTime()
Returns the message expiry time. |
java.lang.String |
getMessageID()
Returns the message identifier |
java.lang.String |
getMessagePriority()
Returns the message priority. |
java.util.List<java.lang.String> |
getMessageReceivers()
Returns the receivers for this MMS message. |
java.lang.String |
getMessageSender()
Return the message sender. |
java.lang.String |
getMessageSubject()
Return the message subject. |
java.lang.String |
getMessageType()
Returns the message type. |
MmsPart |
getPart(int i)
Returns the ith part or null if i is greater then parts number. |
java.util.List<MmsPart> |
getParts()
Returns the mms parts in the message. |
int |
getPartsNumber()
Return the number of parts in the message. |
java.lang.String |
getResponseStatus()
Returns the response status. |
java.lang.String |
getResponseText()
Returns the response text |
java.lang.String |
getSenderVisibility()
Returns the sender visibility. |
java.lang.String |
getTransactionID()
Returns the transaction id. |
java.lang.String |
getVersion()
Return the version of the MMS Protocol. |
boolean |
isDeliveryReportEnabled()
Checks whether the delivery report is enabled |
boolean |
isMessageBCCSet()
Checks if at least one BCC is present. |
boolean |
isMessageCCSet()
Checks if there is at least one message CC. |
boolean |
isMessageClassSet()
Checks if the message class is present. |
boolean |
isMessageContentTypeSet()
Chekcs if the message content type is present. |
boolean |
isMessageDateSet()
Checks if the message date is present. |
boolean |
isMessageDeliveryTimeAbsolute()
Checks if the delivery time is absolute. |
boolean |
isMessageDeliveryTimeSet()
Checks if the delivery time is present. |
boolean |
isMessageExpiryTimeAbsolute()
Checks if the expiry time is absolute. |
boolean |
isMessageExpiryTimeSet()
Checks if the expiry time is specified. |
boolean |
isMessageIDSet()
Checks if the message identifier is present. |
boolean |
isMessagePrioritySet()
Checks if the priority is specified. |
boolean |
isMessageReceiverSet()
Checks if there is at least one receiver. |
boolean |
isMessageSenderSet()
Checks if the message sender is specified. |
boolean |
isMessageSubjectSet()
Checks if the subject is present. |
boolean |
isMessageTypeSet()
Checks if the message type is specified. |
boolean |
isReadReplyEnabled()
Checks whether the read reply is enabled |
boolean |
isResonseTextSet()
Checks if the response text is present. |
boolean |
isResponseStatusSet()
Checks if the response status is present. |
boolean |
isSenderVisibilitySet()
Checks if the visibility is present. |
boolean |
isTransactionIDSet()
Checks if the transaction identifier is set |
boolean |
isVersionSet()
Checks if the version is present. |
void |
setDeliveryReport(boolean enabled)
Enables/disables the message delivery report. |
void |
setMessageClass(java.lang.String messageClass)
Sets the message class. |
void |
setMessageContentType(java.lang.String type)
Sets the content type for the message. |
void |
setMessageDate(java.util.Date d)
Sets the message date. |
void |
setMessageDate(long d)
Sets the message date. |
void |
setMessageDeliveryTime(java.util.Date time,
boolean absolute)
Sets the message delivery time. |
void |
setMessageExpiryTime(java.util.Date time,
boolean absolute)
Sets the message expiry time. |
void |
setMessageID(java.lang.String id)
Sets the message identifier. |
void |
setMessagePriority(java.lang.String priority)
Sets the message priority. |
void |
setMessageSender(java.lang.String sender,
java.lang.String addressType)
Set the message sender. |
void |
setMessageSubject(java.lang.String subject)
Sets the message subject |
void |
setMessageType(java.lang.String type)
Sets the MMS message type. |
void |
setReadReply(boolean enabled)
Enables/disables the message read reply. |
void |
setResponseStatus(java.lang.String status)
Set the response status. |
void |
setResponseText(java.lang.String text)
Sets the response text. |
void |
setSenderVisibility(java.lang.String visibility)
Sets the sender visibility. |
void |
setTransactionID(java.lang.String id)
Sets the transaction id. |
void |
setVersion(java.lang.String version)
Sets the version of the MMS message. |
java.lang.String |
toString()
Produce a string representation of the message easily readable by a human. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String MMS_MESSAGE_TYPE
public static final java.lang.String MMS_TRANSACTION_ID
public static final java.lang.String MMS_VERSION
public static final java.lang.String MMS_DATE
public static final java.lang.String MMS_FROM
public static final java.lang.String MMS_TO
public static final java.lang.String MMS_CC
public static final java.lang.String MMS_BCC
public static final java.lang.String MMS_SUBJECT
public static final java.lang.String MMS_CLASS
public static final java.lang.String MMS_EXPIRY
public static final java.lang.String MMS_DELIVERY_TIME
public static final java.lang.String MMS_PRIORITY
public static final java.lang.String MMS_SENDER_VISIBILITY
public static final java.lang.String MMS_DELIVERY_REPORT
public static final java.lang.String MMS_READ_REPLY
public static final java.lang.String MMS_CONTENT_TYPE
public static final java.lang.String MMS_RESPONSE_STATUS
public static final java.lang.String MMS_RESPONSE_TEXT
public static final java.lang.String MMS_MESSAGE_ID
public static final java.lang.String CHARSET_US_ASCII
public static final java.lang.String CHARSET_UTF8
public static final java.lang.String MMS_MESSAGE_TYPE_SEND_REQUEST
public static final java.lang.String MMS_MESSAGE_TYPE_SEND_CONF
public static final java.lang.String MMS_VERSION_1
public static final java.lang.String MMS_DELIVERY_REPORT_YES
public static final java.lang.String MMS_DELIVERY_REPORT_NO
public static final java.lang.String MMS_CLASS_PERSONAL
public static final java.lang.String MMS_CLASS_ADVERTISEMENT
public static final java.lang.String MMS_CLASS_INFORMATIONAL
public static final java.lang.String MMS_CLASS_AUTO
public static final java.lang.String MMS_PRIORITY_LOW
public static final java.lang.String MMS_PRIORITY_NORMAL
public static final java.lang.String MMS_PRIORITY_HIGH
public static final java.lang.String MMS_READ_REPLY_YES
public static final java.lang.String MMS_READ_REPLY_NO
public static final java.lang.String MMS_RESPONSE_STATUS_OK
public static final java.lang.String MMS_RESPONSE_STATUS_ERROR_UNSPECIFIED
public static final java.lang.String MMS_RESPONSE_STATUS_ERROR_SERVICE_DENIED
public static final java.lang.String MMS_RESPONSE_STATUS_ERROR_MESSAGE_FORMAT_CORRUPT
public static final java.lang.String MMS_RESPONSE_STATUS_ERROR_SENDING_ADDRESS_UNRESOLVED
public static final java.lang.String MMS_RESPONSE_STATUS_ERROR_MESSAGE_NOT_FOUND
public static final java.lang.String MMS_RESPONSE_STATUS_ERROR_NETWORK_PROBLEM
public static final java.lang.String MMS_RESPONSE_STATUS_ERROR_CONTENT_NOT_ACCEPTED
public static final java.lang.String MMS_RESPONSE_STATUS_ERROR_UNSUPPORTED_MESSAGE
public static final java.lang.String MMS_SENDER_VISIBILITY_HIDE
public static final java.lang.String MMS_SENDER_VISIBILITY_SHOW
public static final java.lang.String MMS_ADDRESS_TYPE_MOBILE_NUMBER
public static final java.lang.String MMS_ADDRESS_TYPE_MAIL
public static final java.lang.String MMS_ADDRESS_TYPE_IPV4
public static final java.lang.String MMS_ADDRESS_TYPE_IPV6
public static final java.lang.String CTYPE_UNKNOWN
public static final java.lang.String CTYPE_TEXT
public static final java.lang.String CTYPE_TEXT_PLAIN
public static final java.lang.String CTYPE_TEXT_HTML
public static final java.lang.String CTYPE_TEXT_WML
public static final java.lang.String CTYPE_IMAGE
public static final java.lang.String CTYPE_IMAGE_JPEG
public static final java.lang.String CTYPE_IMAGE_GIF
public static final java.lang.String CTYPE_IMAGE_TIFF
public static final java.lang.String CTYPE_IMAGE_PNG
public static final java.lang.String CTYPE_IMAGE_VND_WAP_WBMP
public static final java.lang.String CTYPE_MULTIPART
public static final java.lang.String CTYPE_MULTIPART_MIXED
public static final java.lang.String CTYPE_APPLICATION_MULTIPART_MIXED
public static final java.lang.String CTYPE_APPLICATION_MULTIPART_RELATED
Constructor Detail |
---|
public MmsMessage()
Method Detail |
---|
public void setMessageType(java.lang.String type) throws MmsMessageException
type
- type of the message
MmsMessageException
- message type not supportedpublic boolean isMessageTypeSet()
public void setTransactionID(java.lang.String id)
id
- transaction idpublic boolean isTransactionIDSet()
public void setVersion(java.lang.String version) throws MmsMessageException
MMS_VERSION_1
.
version
- version of the MMS message
MmsMessageException
- version not supportedpublic boolean isVersionSet()
public void setMessageDate(java.util.Date d)
d
- datepublic void setMessageDate(long d)
d
- datepublic boolean isMessageDateSet()
public void setMessageSender(java.lang.String sender, java.lang.String addressType) throws MmsMessageException
sender
- sender addressaddressType
- address type
MmsMessageException
- address type not supportedpublic boolean isMessageSenderSet()
public void addMessageReceiver(java.lang.String receiver, java.lang.String addressType) throws MmsMessageException
receiver
- receiver addressaddressType
- address type
MmsMessageException
- address type not supportedsetMessageSender(String, String)
public boolean isMessageReceiverSet()
public java.util.List<java.lang.String> getMessageReceivers()
public void addMessageCC(java.lang.String receiver, java.lang.String addressType) throws MmsMessageException
receiver
- CC addressaddressType
- address type
MmsMessageException
- address type not supportedsetMessageSender(String, String)
public boolean isMessageCCSet()
public java.util.List<java.lang.String> getMessageCC()
public void addMessaceBCC(java.lang.String receiver, java.lang.String addressType) throws MmsMessageException
receiver
- BCC addressaddressType
- address type
MmsMessageException
- address type not supportedsetMessageSender(String, String)
public boolean isMessageBCCSet()
public java.util.List<java.lang.String> getMessageBCC()
public void setMessageSubject(java.lang.String subject)
subject
- public boolean isMessageSubjectSet()
public void setMessageClass(java.lang.String messageClass) throws MmsMessageException
messageClass
- message class
MmsMessageException
- the message class is not supportedpublic boolean isMessageClassSet()
public void setMessageExpiryTime(java.util.Date time, boolean absolute)
time
- Time valueabsolute
- Specifies if the time is relative or absolutepublic boolean isMessageExpiryTimeSet()
public void setMessageDeliveryTime(java.util.Date time, boolean absolute)
time
- time valueabsolute
- specifies if the time is relative or absolutesetMessageExpiryTime(Date, boolean)
public boolean isMessageDeliveryTimeSet()
public void setMessagePriority(java.lang.String priority) throws MmsMessageException
priority
- priority of the message
MmsMessageException
- priority not supportedpublic boolean isMessagePrioritySet()
public void setSenderVisibility(java.lang.String visibility) throws MmsMessageException
visibility
- visibility value
MmsMessageException
- visibility not supportedpublic boolean isSenderVisibilitySet()
public void setDeliveryReport(boolean enabled)
enabled
- whether to enable the message delivery reportpublic void setReadReply(boolean enabled)
enabled
- whether to enable the message read replypublic void setResponseStatus(java.lang.String status) throws MmsMessageException
MMS_RESPONSE_STATUS_ERROR_CONTENT_NOT_ACCEPTED
MMS_RESPONSE_STATUS_ERROR_MESSAGE_FORMAT_CORRUPT
MMS_RESPONSE_STATUS_ERROR_MESSAGE_NOT_FOUND
MMS_RESPONSE_STATUS_ERROR_NETWORK_PROBLEM
MMS_RESPONSE_STATUS_ERROR_SENDING_ADDRESS_UNRESOLVED
MMS_RESPONSE_STATUS_ERROR_SERVICE_DENIED
MMS_RESPONSE_STATUS_ERROR_UNSPECIFIED
MMS_RESPONSE_STATUS_ERROR_UNSUPPORTED_MESSAGE
MMS_RESPONSE_STATUS_OK
status
- response status
MmsMessageException
- status not supportedpublic boolean isResponseStatusSet()
public void setResponseText(java.lang.String text)
text
- responsepublic boolean isResonseTextSet()
public void setMessageID(java.lang.String id)
id
- message identifierpublic boolean isMessageIDSet()
public void setMessageContentType(java.lang.String type)
CTYPE_APPLICATION_MULTIPART_MIXED
CTYPE_APPLICATION_MULTIPART_RELATED
CTYPE_IMAGE
CTYPE_IMAGE_GIF
CTYPE_IMAGE_JPEG
CTYPE_IMAGE_PNG
CTYPE_IMAGE_TIFF
CTYPE_IMAGE_VND_WAP_WBMP
CTYPE_MULTIPART
CTYPE_MULTIPART_MIXED
CTYPE_TEXT
CTYPE_TEXT_HTML
CTYPE_TEXT_PLAIN
CTYPE_TEXT_WML
CTYPE_UNKNOWN
type
- content typepublic boolean isMessageContentTypeSet()
public void addPart(MmsPart part) throws MmsMessageException
part
- part to add to the message
MmsMessageException
- the part is not compatible with the messagepublic int getPartsNumber()
public java.util.List<MmsPart> getParts()
public MmsPart getPart(int i)
i
- part number desidered
public java.lang.String getMessageType()
public java.lang.String getTransactionID()
public java.lang.String getVersion()
public java.util.Date getMessageDate()
public java.lang.String getMessageSender()
public java.lang.String getMessageSubject()
public java.lang.String getMessageClass()
public java.util.Date getMessageExpiryTime()
public boolean isMessageExpiryTimeAbsolute()
public java.util.Date getMessageDeliveryTime()
public boolean isMessageDeliveryTimeAbsolute()
public java.lang.String getMessagePriority()
public java.lang.String getSenderVisibility()
public boolean isDeliveryReportEnabled()
public boolean isReadReplyEnabled()
public java.lang.String getResponseStatus()
public java.lang.String getResponseText()
public java.lang.String getMessageID()
public java.lang.String getMessageContentType()
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |