|
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.AddressData
AddressData represents a generic address. It's the common base class for all types of addresses used in Push service. AddressData provides a holder to keep all kinds of addresses. (e.g. email and phone number)
PhoneAddressData and EmailAddressData are two sub classes of AddressData which represent phone number and email address respectively.
Another subclass, UserAddressData, represents a generic user. A user could be an iAS Wireless user or any third party user. Only user name and its scope is specified in the class. Push Server will get all attributes of the user (e.g. email addresses and phone numbers) from user's profile.
Some devices can receive messages via many transport types. For example: a cell phone may be able to receive voice message, email and SMS. PrimaryTransportType is the transport type to be used in the first delivery attempt. It's a required field for all email and phone recipients.
If a device supports other transports, these transport types may be used as failover transport types. Use setFailoverTransportTypes() to set failover transport types. A device may have another device as failover device. If all transport types of the device have been tried and failed, Push server will use failover device to make further attempts.
Failover order: Push server will be trying to deliver message in the following order:
Try primary transport type first.
Try failover transport types at the order provided.
Failover to another device.
Note:
1. 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.
2. Constructors of this class may not be invoked by end users directly, because this is the base class of all AddressData classes. Please instantiate appropriate subclasses of DeviceAddressData or UserAddressData.
Field Summary | |
int |
failoverOrder |
static int |
MAX_ADDRESS_LENGTH |
static int |
MAX_ASSOCIATED_KEY_LENGTH |
static int |
MAX_NAME_LENGTH |
static int |
MAX_TRANSPORT_TYPE_LENGTH |
int |
totalFailovers |
Method Summary | |
java.lang.Object |
clone() |
boolean |
equals(java.lang.Object other) |
java.lang.String |
getAddress() get address string |
java.lang.String |
getAddressType() Get address type string. |
java.lang.String |
getAssociatedKey() get the key string of the address instance. |
java.lang.String |
getEncoding() get the charset encoding for the device of this address. |
AddressData |
getFailoverAddress() return the failover address (if any). |
DeliveryChannel[] |
getFailoverDeliveryChannels() get failover delivery channels set by setFailoverDeliveryChannel |
java.lang.String[] |
getFailoverTransportTypes() get failover transport type of this device. |
java.lang.String |
getFirstName() Get the first name of the recipient of the address |
java.lang.String |
getLastName() Get the first name of the recipient of the address |
DeliveryChannel |
getPrimaryDeliveryChannel() getPrimaryDeliveryChannel get the primary (first) delivery channel of this address. |
java.lang.String |
getPrimaryTransportType() get primary transport type of this address. |
int |
hashCode() |
void |
setAddress(java.lang.String address) Set address string |
void |
setAddressType(java.lang.String addressType) Set address type string. |
void |
setAssociatedKey(java.lang.String key) The application may set a key which may create a mapping to the application database table. |
void |
setEncoding(java.lang.String encoding) Set the charset encoding for device of this address. |
void |
setFailoverAddress(AddressData addr) Sets failover address. |
void |
setFailoverDeliveryChannels(DeliveryChannel[] failoverChannels) set failover delivery channels of an address. |
void |
setFailoverTransportTypes(java.lang.String[] failoverTransportTypes) Specify the order of transport types to be used in the same device, if former delivery attempts failed. |
void |
setFirstName(java.lang.String first) Set the first name of the recipient of the address |
void |
setLastName(java.lang.String last) Set the last name of the recipient of the address |
void |
setPrimaryDeliveryChannel(DeliveryChannel primaryChannel) setPrimaryDeliveryChannel sets primary delivery channel for this address. |
void |
setPrimaryTransportType(java.lang.String primaryTransportType) Set the first delivery type to be used to deliver the message. |
java.lang.String |
toString() |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public int failoverOrder
public static final int MAX_ADDRESS_LENGTH
public static final int MAX_ASSOCIATED_KEY_LENGTH
public static final int MAX_NAME_LENGTH
public static final int MAX_TRANSPORT_TYPE_LENGTH
public int totalFailovers
Method Detail |
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
public boolean equals(java.lang.Object other)
public java.lang.String getAddress()
public java.lang.String getAddressType()
public java.lang.String getAssociatedKey()
public java.lang.String getEncoding()
public AddressData getFailoverAddress()
public DeliveryChannel[] getFailoverDeliveryChannels()
public java.lang.String[] getFailoverTransportTypes()
public java.lang.String getFirstName()
public java.lang.String getLastName()
public DeliveryChannel getPrimaryDeliveryChannel()
public java.lang.String getPrimaryTransportType()
public int hashCode()
public void setAddress(java.lang.String address)
public void setAddressType(java.lang.String addressType)
public void setAssociatedKey(java.lang.String key)
public void setEncoding(java.lang.String encoding)
public void setFailoverAddress(AddressData addr)
public void setFailoverDeliveryChannels(DeliveryChannel[] failoverChannels)
public void setFailoverTransportTypes(java.lang.String[] failoverTransportTypes)
public void setFirstName(java.lang.String first)
public void setLastName(java.lang.String last)
public void setPrimaryDeliveryChannel(DeliveryChannel primaryChannel)
public void setPrimaryTransportType(java.lang.String primaryTransportType)
public java.lang.String toString()
|
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 |