public interface Address extends MessagingObject, Cloneable
Address
represents an address in the SDP Messaging. It
has three main attributes - an address type (such as Email, Phone
number, URL, etc.), a delivery type (such as Email, SMS, EMS, MMS,
WAP Push, etc.) and the actual address value. An
Address
can have an optional name which may be used
for display purposes.
An Address
can also have a failover
Address
- The failover address is used if message
delivery to this address fails or times out. For example: The home
phone number could be the failover address of the office phone. The
home phone number will be called if and only if the call to the
office number is not successful.
To create basic Address objects (with delivery type and address
value), use the MessagingFactory
. Then use the various
setters to set additional information.
Modifier and Type | Field and Description |
---|---|
static String |
ASSOCIATED_KEY
Pre-defined meta data key name for Associated Key.
|
static String |
CARRIER
Pre-defined meta data key name for Carrier.
|
static String |
EMAIL_MODE
Pre-defined meta data key name for Email Mode.
|
static String |
EMAIL_MODE_BCC
Pre-defined meta data value for Bcc Email Mode.
|
static String |
EMAIL_MODE_CC
Pre-defined meta data value for Cc Email Mode.
|
static String |
EMAIL_MODE_TO
Pre-defined meta data value for To Email Mode.
|
static String |
ENCODING
Pre-defined meta data key name for charset encoding.
|
static int |
MAX_ADDRESS_LENGTH |
static int |
MAX_ASSOCIATED_KEY_LENGTH |
static int |
MAX_DELIVERY_TYPE_LENGTH |
static int |
MAX_NAME_LENGTH |
static String |
NAME
Pre-defined meta data key name for Name.
|
METADATA_APPLICATION_NAME, NAMESPACE_NOTIFICATION_PREFERENCES, NAMESPACE_SDPM, NAMESPACE_UMS, NAMESPACE_UMS_JMP_PROPS
Modifier and Type | Method and Description |
---|---|
Object |
clone() |
AddressType |
getAddressType()
Get the address type.
|
String |
getCarrier()
Get the address carrier.
|
DeliveryType |
getDeliveryType()
Get the delivery type of this address.
|
String |
getEncoding()
Get the charset encoding for the device of this address.
|
Address |
getFailoverAddress()
Get the failover address.
|
String |
getName()
Get the (optional) name of the address owner.
|
String |
getNormalizedValue()
Get the normalized address value based on the address type and
delivery type of this address.
|
StatusType |
getSuccessStatusType()
Get the desired success status type for this address.
|
int |
getTimeout()
Get the delivery timeout in seconds.
|
String |
getValue()
Get the address value.
|
void |
setAddressType(AddressType type)
Set the address type.
|
void |
setCarrier(String carrier)
Set the (optional) address carrier.
|
void |
setDeliveryType(DeliveryType deliveryType)
Set the delivery type of this address.
|
void |
setEncoding(String encoding)
Set the (optional) charset encoding for the device of this
address.
|
void |
setFailoverAddress(Address addr)
Set failover address.
|
void |
setName(String name)
Set the (optional) name of the address owner.
|
void |
setSuccessStatusType(StatusType successStatusType)
Set the desired success status type for this address.
|
void |
setTimeout(int seconds)
Set the delivery timeout in seconds.
|
void |
setValue(String value)
Set the address value.
|
String |
toExternalFormat()
Get a string representation of this address, ie.
|
getAllNamespaces, getMetaData, getMetaDataNames, logShort, removeMetaData, setMetaData
static final int MAX_ADDRESS_LENGTH
static final int MAX_DELIVERY_TYPE_LENGTH
static final int MAX_ASSOCIATED_KEY_LENGTH
static final int MAX_NAME_LENGTH
static final String ASSOCIATED_KEY
static final String ENCODING
static final String NAME
static final String CARRIER
static final String EMAIL_MODE
static final String EMAIL_MODE_TO
static final String EMAIL_MODE_CC
static final String EMAIL_MODE_BCC
void setValue(String value)
value
- the address value as a string.String getValue()
String getNormalizedValue()
getValue()
.AddressType getAddressType()
void setAddressType(AddressType type)
AddressType
.type
- the address type.DeliveryType getDeliveryType()
void setDeliveryType(DeliveryType deliveryType)
DeliveryType
.deliveryType
- the delivery type.void setEncoding(String encoding)
encoding
- the charset encoding.String getEncoding()
String getCarrier()
void setCarrier(String carrier)
carrier
- the address carrier.void setFailoverAddress(Address addr)
addr
- the failover address.setSuccessStatusType(StatusType)
,
setTimeout(int)
Address getFailoverAddress()
null
if none is
set.void setName(String name)
name
- the optional name of the address owner.String getName()
int getTimeout()
void setTimeout(int seconds)
setSuccessStatusType(StatusType)
)
within the specified timeout period, the system will failover to
the next address in the failover chain (if available).
Note: If no timeout is set, the system will only perform status-triggered failover as and when a "FAILURE" status at or below the desired "SUCCESS" level is received.
seconds
- the timeout value in seconds.setSuccessStatusType(StatusType)
StatusType getSuccessStatusType()
void setSuccessStatusType(StatusType successStatusType)
The default success status type used by the system, if not set,
is StatusType.DELIVERY_TO_GATEWAY_SUCCESS
.
successStatusType
- the desired success status type.IllegalArgumentException
- if successStatusType is not of "SUCCESS" level or if
successStatusType is null.setTimeout(int)
String toExternalFormat()
deliveryType
:address
" Failover
addresses are comma-separated.Object clone() throws CloneNotSupportedException
CloneNotSupportedException
Copyright © 2009,2013 Oracle and/or its affiliates. All rights reserved.