oracle.sdp.messaging
Interface Address

All Superinterfaces:

java.lang.Cloneable, MessagingObject, Serializable

public interface Address
extends MessagingObject, java.lang.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.

Since:

11.0.0

Field Summary

static java.lang.String	ASSOCIATED_KEY Pre-defined meta data key name for Associated Key.
static java.lang.String	CARRIER Pre-defined meta data key name for Carrier.
static java.lang.String	EMAIL_MODE Pre-defined meta data key name for Email Mode.
static java.lang.String	EMAIL_MODE_BCC Pre-defined meta data value for Bcc Email Mode.
static java.lang.String	EMAIL_MODE_CC Pre-defined meta data value for Cc Email Mode.
static java.lang.String	EMAIL_MODE_TO Pre-defined meta data value for To Email Mode.
static java.lang.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 java.lang.String	NAME Pre-defined meta data key name for Name.

Fields inherited from interface oracle.sdp.messaging.MessagingObject

NAMESPACE_NOTIFICATION_PREFERENCES, NAMESPACE_SDPM

Method Summary

java.lang.Object	clone()
AddressType	getAddressType() Get the address type.
java.lang.String	getCarrier() Get the address carrier.
DeliveryType	getDeliveryType() Get the delivery type of this address.
java.lang.String	getEncoding() Get the charset encoding for the device of this address.
Address	getFailoverAddress() Get the failover address.
java.lang.String	getName() Get the (optional) name of the address owner.
java.lang.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.
java.lang.String	getValue() Get the address value.
void	setAddressType(AddressType type) Set the address type.
void	setCarrier(java.lang.String carrier) Set the (optional) address carrier.
void	setDeliveryType(DeliveryType deliveryType) Set the delivery type of this address.
void	setEncoding(java.lang.String encoding) Set the (optional) charset encoding for the device of this address.
void	setFailoverAddress(Address addr) Set failover address.
void	setName(java.lang.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(java.lang.String value) Set the address value.
java.lang.String	toExternalFormat() Get a string representation of this address, ie.

Methods inherited from interface oracle.sdp.messaging.MessagingObject

getAllNamespaces, getMetaData, getMetaDataNames, setMetaData

Field Detail

ASSOCIATED_KEY

static final java.lang.String ASSOCIATED_KEY

Pre-defined meta data key name for Associated Key.

See Also:

Constant Field Values

CARRIER

static final java.lang.String CARRIER

Pre-defined meta data key name for Carrier.

See Also:

Constant Field Values

EMAIL_MODE

static final java.lang.String EMAIL_MODE

Pre-defined meta data key name for Email Mode.

See Also:

Constant Field Values

EMAIL_MODE_BCC

static final java.lang.String EMAIL_MODE_BCC

Pre-defined meta data value for Bcc Email Mode.

See Also:

Constant Field Values

EMAIL_MODE_CC

static final java.lang.String EMAIL_MODE_CC

Pre-defined meta data value for Cc Email Mode.

See Also:

Constant Field Values

EMAIL_MODE_TO

static final java.lang.String EMAIL_MODE_TO

Pre-defined meta data value for To Email Mode.

See Also:

Constant Field Values

ENCODING

static final java.lang.String ENCODING

Pre-defined meta data key name for charset encoding.

See Also:

Constant Field Values

MAX_ADDRESS_LENGTH

static final int MAX_ADDRESS_LENGTH

See Also:

Constant Field Values

MAX_ASSOCIATED_KEY_LENGTH

static final int MAX_ASSOCIATED_KEY_LENGTH

See Also:

Constant Field Values

MAX_DELIVERY_TYPE_LENGTH

static final int MAX_DELIVERY_TYPE_LENGTH

See Also:

Constant Field Values

MAX_NAME_LENGTH

static final int MAX_NAME_LENGTH

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

Pre-defined meta data key name for Name.

See Also:

Constant Field Values

Method Detail

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

getAddressType

AddressType getAddressType()

Get the address type.

Returns:

the address type.

getCarrier

java.lang.String getCarrier()

Get the address carrier.

Returns:

the address carrier.

getDeliveryType

DeliveryType getDeliveryType()

Get the delivery type of this address.

Returns:

the delivery type.

getEncoding

java.lang.String getEncoding()

Get the charset encoding for the device of this address.

Returns:

the charset encoding.

getFailoverAddress

Address getFailoverAddress()

Get the failover address.

Returns:

the failover address, or null if none is set.

getName

java.lang.String getName()

Get the (optional) name of the address owner.

Returns:

the name.

getNormalizedValue

java.lang.String getNormalizedValue()

Get the normalized address value based on the address type and delivery type of this address. In case of MSISDN address type, this will return only the digits, stripping out any white space or non-digit characters. In most other cases, the value returned will be the same as obtained using getValue().

Returns:

the normalized address value.

getSuccessStatusType

StatusType getSuccessStatusType()

Get the desired success status type for this address.

Returns:

the desired success status type.

getTimeout

int getTimeout()

Get the delivery timeout in seconds.

Returns:

the timeout in seconds.

getValue

java.lang.String getValue()

Get the address value.

Returns:

the address value.

setAddressType

void setAddressType(AddressType type)

Set the address type. For a list of supported address types, see AddressType.

Parameters:

type - the address type.

setCarrier

void setCarrier(java.lang.String carrier)

Set the (optional) address carrier. For example: Cingular, Verizon, Telenor, etc.

Parameters:

carrier - the address carrier.

setDeliveryType

void setDeliveryType(DeliveryType deliveryType)

Set the delivery type of this address. For a list of supported delivery types, see DeliveryType.

Parameters:

deliveryType - the delivery type.

setEncoding

void setEncoding(java.lang.String encoding)

Set the (optional) charset encoding for the device of this address.

Parameters:

encoding - the charset encoding.

setFailoverAddress

void setFailoverAddress(Address addr)

Set failover address. Failover address is used if the system can't deliver the message to the current address. For example: The home phone number could be failover address of the office phone. Home phone number will be called if and only if the call to office number is not successful.

Parameters:

addr - the failover address.

See Also:

setSuccessStatusType(StatusType), setTimeout(int)

setName

void setName(java.lang.String name)

Set the (optional) name of the address owner.

Parameters:

name - the optional name of the address owner.

setSuccessStatusType

void setSuccessStatusType(StatusType successStatusType)

Set the desired success status type for this address. If the status of delivery to this address does not reach the specified "SUCCESS" level, the system will failover to the next address in the failover chain (if available).

The default success status type used by the system, if not set, is StatusType.DELIVERY_TO_GATEWAY_SUCCESS.

If the successStatusType is not set to a "SUCCESS" status type, the system will ignore this value and use the default success status type mentioned above.

Parameters:

successStatusType - the desired success status type.

See Also:

setTimeout(int)

setTimeout

void setTimeout(int seconds)

Set the delivery timeout in seconds. If the status of delivery to this address does not reach the specified "SUCCESS" level (the level specified by 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.

Parameters:

seconds - the timeout value in seconds.

See Also:

setSuccessStatusType(StatusType)

setValue

void setValue(java.lang.String value)

Set the address value.

Parameters:

value - the address value as a string.

toExternalFormat

java.lang.String toExternalFormat()

Get a string representation of this address, ie. "deliveryType:address" Failover addresses are comma-separated.

Returns:

the string representation of this address.