|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.panama.messaging.push.Packet
Packet class represents a generic message. (For example: email) It has a subject, one body or a set of message bodies (multipart). The same message may be delivered to multiple recipients of multiple transport types (delivery types).
For example: the same message can be delivered to 2 email recipients, 3 SMS recipients and 4 fax machines in the same packet.
Every transport type may have a sender, an alternate reply to address and a group of recipients. The packet could have a set of optional delivery instructions, like priority, registered etc.
Message, recipients and transport(s) are required fields.
Notes:
Never access any public data fields inside this class directly, because they are for internal use in this release and will be changed in coming releases. Always use public methods of this class.
Following functions are for backward compatible purpose and they DON'T support failover. All failover transport types and address are ignored.
public void addRecipients(String transportType, AddressData recipients[])
public Vector getRecipients(String transportType)
public Vector getAllRecipients()
public Enumeration getTransports()
public boolean removeRecipient(String transportType, AddressData recipient)
Following functions supports recipients with or without failover attributes.
public boolean removeRecipient(AddressData recipient)
public void addRecipients(AddressData recipients[])
public Vector getRecipients()
Field Summary | |
java.lang.String[] |
compactAddress |
java.util.Hashtable |
failover |
java.util.Hashtable |
from |
UserAddressData |
fromUser |
Message |
message |
java.util.Hashtable |
metaInfo |
MessageInfo |
msgInfo |
java.util.Hashtable |
recipients |
java.util.Hashtable |
replyTo |
UserAddressData |
replyToUser |
java.util.Vector |
vAddress |
boolean |
validation |
Constructor Summary | |
Packet() Create an empty packet. |
Method Summary | |
void |
addRecipient(AddressData recipient) Add recipient to the packet. |
void |
addRecipient(java.lang.String transportType, DeviceAddressData recipient) Deprecated. Use addRecipients(AddressData[]) instead |
void |
addRecipients(AddressData[] recipients) Add recipients to the packet. |
void |
addRecipients(java.lang.String transportType, AddressData[] recipients) Deprecated. Use addRecipients(AddressData[]) instead |
void |
addRecipients(java.lang.String transportType, DeviceAddressData[] recipients) Deprecated. Use addRecipients(AddressData[]) instead |
java.lang.Object |
clone() |
boolean |
equals(java.lang.Object other) |
java.util.Vector |
getAllRecipients() Deprecated. Use getRecipients() |
java.lang.String[] |
getFailover(java.lang.String transportType) Deprecated. Failover is defined at recipient level not at transport level any more. |
java.util.Enumeration |
getFrom() Get all 'from user' and 'from device' set by setFrom(transport, DeviceAddressData) or setFrom(AddressData). |
DeviceAddressData |
getFrom(java.lang.String transport) Get the sender's physical address of specified transport. |
java.util.Hashtable |
getFromAddresses() Get a copy of from address hashtable. |
UserAddressData |
getFromUser() Get from user of the packet set by setFrom(AddressData) |
Message |
getMessage() get message object from packet |
MessageInfo |
getMessageInfo() get MessageInfo object from packet |
java.lang.String |
getMetaInfo(java.lang.String name) Get Meta information of the packet |
java.util.Enumeration |
getMetaInfoNames() return all names in Meta Info object of current package |
java.util.Vector |
getRecipients() Get recipients added by addRecipients(AddressData[]). |
java.util.Vector |
getRecipients(java.lang.String transportType) Deprecated. Use getRecipients() instead |
java.util.Enumeration |
getReplyTo() get all reply to user and reply to device address set by setReplyTo(transport, DeviceAddressData) or setReplyTo(AddressData). |
DeviceAddressData |
getReplyTo(java.lang.String transport) get reply to device address by transport type. |
java.util.Hashtable |
getReplyToAddresses() Get a copy of reply to address hashtable. |
UserAddressData |
getReplyToUser() get reply to user of the packet set by setReplyTo(AddressData) |
java.util.Enumeration |
getTransports() Return all transport types (delivery types) will be used to deliver the message. |
boolean |
getValidation() Get the validation flag. |
int |
hashCode() |
void |
removeMetaInfo(java.lang.String name) Remove a Meta information item from the packet |
boolean |
removeRecipient(AddressData recipient) remove a recipient from recipient list, which was added by addRecipients(). |
boolean |
removeRecipient(java.lang.String transportType, DeviceAddressData recipient) Deprecated. Use removeRecipient(AddressData) instead |
void |
removeRecipients(java.lang.String transportType) remove all non-failover recipient from recipient list for transport type |
void |
setFailover(java.lang.String transportType, java.lang.String[] failovers) Deprecated. Failover is defined at recipient level not at transport level any more. |
void |
setFrom(AddressData sender) set the from address of the message. |
void |
setFrom(java.lang.String transport, AddressData sender) Deprecated. by setFrom(AddressData) |
void |
setFrom(java.lang.String transport, DeviceAddressData sender) Deprecated. by setFrom(AddressData) |
void |
setMessage(Message msg) Set message of current packet. |
void |
setMessageInfo(MessageInfo msgI) Set additional info of message. |
void |
setMetaInfo(java.lang.String name, java.lang.String value) Set Meta information of the packet |
void |
setReplyTo(AddressData replyToAddress) Set an alternative 'reply to' address. |
void |
setReplyTo(java.lang.String transport, DeviceAddressData replyToAddress) Deprecated. by setReplyTo(AddressData) |
void |
setValidation(boolean validation) setValidation(true): Enable validation. |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public java.lang.String[] compactAddress
public java.util.Hashtable failover
public java.util.Hashtable from
public UserAddressData fromUser
public Message message
public java.util.Hashtable metaInfo
public MessageInfo msgInfo
public java.util.Hashtable recipients
public java.util.Hashtable replyTo
public UserAddressData replyToUser
public java.util.Vector vAddress
public boolean validation
Constructor Detail |
public Packet()
Method Detail |
public void addRecipient(AddressData recipient)
recipient
-getRecipients()
public void addRecipient(java.lang.String transportType, DeviceAddressData recipient)
transportType
- The basic type of transport which will be used to deliver the message first. transport types are defined as constants in TransportType.java.recipient
- a recipient's DeviceAddressDataTransportType
, addRecipients(AddressData[])
public void addRecipients(AddressData[] recipients)
recipients
- Array of recipientsgetRecipients()
public void addRecipients(java.lang.String transportType, AddressData[] recipients)
transportType
- The basic type of transport which will be used to deliver the message first. transport types are defined as constants in TransportType.java.recipients
- Array of recipients.TransportType
, addRecipients(AddressData[])
, addRecipients(String, DeviceAddressData[])
public void addRecipients(java.lang.String transportType, DeviceAddressData[] recipients)
transportType
- The basic type of transport which will be used to deliver the message first. transport types are defined as constants in TransportType.java.recipients
- Array of recipientsTransportType
, addRecipients(AddressData[])
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
public boolean equals(java.lang.Object other)
public java.util.Vector getAllRecipients()
public java.lang.String[] getFailover(java.lang.String transportType)
public java.util.Enumeration getFrom()
setFrom(AddressData)
, setFrom(String, DeviceAddressData)
, getFrom(String)
public DeviceAddressData getFrom(java.lang.String transport)
setFrom(String,DeviceAddressData)
, setFrom(AddressData)
public java.util.Hashtable getFromAddresses()
setFrom(AddressData)
, setFrom(String, DeviceAddressData)
, getFromUser()
, getFrom()
public UserAddressData getFromUser()
setFrom(AddressData)
, getFrom()
public Message getMessage()
public MessageInfo getMessageInfo()
public java.lang.String getMetaInfo(java.lang.String name)
public java.util.Enumeration getMetaInfoNames()
public java.util.Vector getRecipients()
addRecipients(AddressData[])
public java.util.Vector getRecipients(java.lang.String transportType)
getRecipients()
public java.util.Enumeration getReplyTo()
setFrom(AddressData)
, setFrom(String, DeviceAddressData)
, getFrom(String)
, setReplyTo(String,DeviceAddressData)
, setReplyTo(AddressData)
public DeviceAddressData getReplyTo(java.lang.String transport)
setReplyTo(AddressData)
, setReplyTo(String,DeviceAddressData)
public java.util.Hashtable getReplyToAddresses()
setReplyTo(AddressData)
, setReplyTo(String, DeviceAddressData)
, getReplyToUser()
, getReplyTo()
public UserAddressData getReplyToUser()
setReplyTo(AddressData)
, getReplyTo()
public java.util.Enumeration getTransports()
public boolean getValidation()
getValidation()
public int hashCode()
public void removeMetaInfo(java.lang.String name)
public boolean removeRecipient(AddressData recipient)
addRecipients(AddressData[])
, getRecipients()
public boolean removeRecipient(java.lang.String transportType, DeviceAddressData recipient)
public void removeRecipients(java.lang.String transportType)
public void setFailover(java.lang.String transportType, java.lang.String[] failovers)
public void setFrom(AddressData sender)
sender
- address of the sender. An address could be either a user or a device.setFrom(String, DeviceAddressData)
public void setFrom(java.lang.String transport, AddressData sender)
transport
- delivery type name.sender
- address of the sender. It must be a DeviceAddressData or the method call will fail.setFrom(String, DeviceAddressData)
, setFrom(AddressData)
public void setFrom(java.lang.String transport, DeviceAddressData sender)
transport
- transport type to deliver the message.sender
- physical address (i.e. email and phone number) of the sendersetFrom(AddressData)
public void setMessage(Message msg)
public void setMessageInfo(MessageInfo msgI)
public void setMetaInfo(java.lang.String name, java.lang.String value)
public void setReplyTo(AddressData replyToAddress)
replyToAddress
- alternative address of the sendersetFrom(AddressData)
, setFrom(String, DeviceAddressData)
public void setReplyTo(java.lang.String transport, DeviceAddressData replyToAddress)
transport
- transport supported by Messaging gateway/engine.replyToAddress
- address of the sendersetFrom(String,DeviceAddressData)
, setFrom(AddressData)
public void setValidation(boolean validation)
getValidation()
|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |