oracle.sdp.messaging
Class AddressFactory

java.lang.Object
  oracle.sdp.messaging.AddressFactory

public class AddressFactory
extends java.lang.Object

Factory (singleton) class to create Address objects.

This is the recommended factory for creating basic Address objects for use with the Messaging API.

Sample usage:

• Create a single Address object - "Email:john.doe@oracle.com":
  Address recipient = AddressFactory.getInstance().createAddress("Email:john.doe@oracle.com");
• Create multiple Address objects in a batch - "Email:john.doe@oracle.com", "IM:jabber|john.doe@oracle.com":
  String[] recipientsStr = {"Email:john.doe@oracle.com", "IM:jabber|john.doe@oracle.com"};
Address[] recipients = AddressFactory.getInstance().createAddress(recipientsStr);
• Create a single Address object with Failover - "Email:john.doe@oracle.com, IM:jabber|john.doe@oracle.com":
  String recipientWithFailoverStr = "Email:john.doe@oracle.com, IM:jabber|john.doe@oracle.com";
Address recipient = AddressFactory.getInstance().createAddress(recipientWithFailoverStr);

Since:

11.0.0

Method Summary

Address	buildAddress(java.lang.String deviceAddress, DeliveryType deliveryType, java.lang.String emailMode) Build a Address object.
Address	buildAddress(java.lang.String deviceAddress, java.lang.String deliveryType, java.lang.String emailMode) Build a Address object.
Address	createAddress(java.lang.String address) Create a new Address object from address.
Address[]	createAddress(java.lang.String[] addresses) Create a list of Address objects from addresses.
static AddressFactory	getInstance() Get singleton instance

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

buildAddress

public Address buildAddress(java.lang.String deviceAddress,
                            DeliveryType deliveryType,
                            java.lang.String emailMode)

Build a Address object.

Parameters:

deviceAddress - the device address

deliveryType - the delivery type

emailMode - the email mode of the address - available options are: null OR Address.EMAIL_MODE_TO, Address.EMAIL_MODE_CC, Address.EMAIL_MODE_BCC for Email delivery type.

Returns:

an Address object.

buildAddress

public Address buildAddress(java.lang.String deviceAddress,
                            java.lang.String deliveryType,
                            java.lang.String emailMode)

Build a Address object.

Parameters:

deviceAddress - the device address

deliveryType - the delivery type

emailMode - the email mode of the address - available options are: null OR Address.EMAIL_MODE_TO, Address.EMAIL_MODE_CC, Address.EMAIL_MODE_BCC for Email delivery type.

Returns:

an Address object.

createAddress

public Address createAddress(java.lang.String address)

Create a new Address object from address.

Parameters:

address - a well-formatted address in String form. The format must be of the form "deliveryType:address". For example: "Email:john.doe@oracle.com". Alternatively, to address users or groups, you may specify "User:username" or "Group:groupname". For example: "User:johndoe" or "Group:johndoe_team".
Failover addresses can be specified using a comma separator. For example: "SMS:1234,Email:john.doe@oracle.com" will construct an address object with the "SMS:1234" as the first address, and "Email:john.doe@oracle.com" as the failover address.

Returns:

the corresponding Address object.

createAddress

public Address[] createAddress(java.lang.String[] addresses)

Create a list of Address objects from addresses.

Parameters:

addresses - a list of well-formatted addresses in String form.

Returns:

corresponding list of Address objects.

getInstance

public static AddressFactory getInstance()

Get singleton instance