oracle.panama.messaging.push
Class IMAddressData

java.lang.Object
oracle.panama.messaging.push.AddressData
oracle.panama.messaging.push.DeviceAddressData
oracle.panama.messaging.push.IMAddressData

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class IMAddressData

extends DeviceAddressData

IM (Instant Messaging) address.
IM address has an IM specific attribute: network.
Predefined network values are: 'yahoo','msn', 'aim', 'icq' and 'jabber' (default). The network value is required to identify the IM network of the recipients and sender.

Sample Usage:
IMAddressData imd1 = new IMAddressData("foo@bar.com", "msn");
IMAddressData imd2 = new IMAddressData("foo", "yahoo");
IMAddressData imd3 = new IMAddressData("foo", "aim");
IMAddressData imd4 = new IMAddressData("foo@bar.com", "jabber");
IMAddressData imd5 = new IMAddressData("foo@bar.com", "");
IMAddressData imd6 = new IMAddressData("foo@bar.com", null);
IMAddressData imd7 = new IMAddressData("foo@bar.com");
IMAddressData imd8 = new IMAddressData("aim|foo");

See Also:

Serialized Form

Field Summary

java.lang.String	addressType
static java.lang.String	IM_AIM_TYPE
static java.lang.String	IM_ICQ_TYPE
static java.lang.String	IM_JABBER_TYPE
static java.lang.String	IM_MSN_TYPE
static java.lang.String	IM_YAHOO_TYPE

Fields inherited from class oracle.panama.messaging.push.AddressData

failoverOrder, MAX_ADDRESS_LENGTH, MAX_ASSOCIATED_KEY_LENGTH, MAX_NAME_LENGTH, MAX_TRANSPORT_TYPE_LENGTH, totalFailovers

Constructor Summary

IMAddressData()
Basic Constructor

IMAddressData(java.lang.String addr)
Raw address constructor

IMAddressData(java.lang.String addr, java.lang.String network)
Smart constructor.

Method Summary

static java.lang.String	constructIMAddress(java.lang.String id, java.lang.String network) Construct a String representation of an IM address.
boolean	equals(java.lang.Object other)
java.lang.String	getAddressType() "IM" is returned to indicate that it's an IM address.
static java.lang.String	getID(java.lang.String fulladdr) Returns the ID component of a full IM address
static java.lang.String	getNetwork(java.lang.String fulladdr) Returns the network component of a full IM address
int	hashCode()

Methods inherited from class oracle.panama.messaging.push.DeviceAddressData

getOriginalDeviceAddressData, getOwner, setOriginalDeviceAddressData, setOwner

Methods inherited from class oracle.panama.messaging.push.AddressData

clone, getAddress, getAssociatedKey, getEncoding, getFailoverAddress, getFailoverDeliveryChannels, getFailoverTransportTypes, getFirstName, getLastName, getPrimaryDeliveryChannel, getPrimaryTransportType, setAddress, setAddressType, setAssociatedKey, setEncoding, setFailoverAddress, setFailoverDeliveryChannels, setFailoverTransportTypes, setFirstName, setLastName, setPrimaryDeliveryChannel, setPrimaryTransportType, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

addressType

public final java.lang.String addressType

See Also:

Constant Field Values

IM_AIM_TYPE

public static final java.lang.String IM_AIM_TYPE

See Also:

Constant Field Values

IM_ICQ_TYPE

public static final java.lang.String IM_ICQ_TYPE

See Also:

Constant Field Values

IM_JABBER_TYPE

public static final java.lang.String IM_JABBER_TYPE

See Also:

Constant Field Values

IM_MSN_TYPE

public static final java.lang.String IM_MSN_TYPE

See Also:

Constant Field Values

IM_YAHOO_TYPE

public static final java.lang.String IM_YAHOO_TYPE

See Also:

Constant Field Values

Constructor Detail

IMAddressData

public IMAddressData()

Basic Constructor

IMAddressData

public IMAddressData(java.lang.String addr)

Raw address constructor

Parameters:

addr - IM address in format: <networkname&gt|<userid>
Required format:

For user of this IM Network...	Use this Address Format
Jabber	jabber|<jabber id> OR simply, <jabber id>
Yahoo	yahoo|<yahoo userid>
MSN	msn|<msn userid>
AOL IM	aim|<aim userid>
ICQ	icq|<icq userid>

IMAddressData

public IMAddressData(java.lang.String addr,
                     java.lang.String network)

Smart constructor. See sample usage of this constructor above.

Parameters:

addr - the account ID on a particular IM network

network - could be "yahoo" (for Yahoo network), "msn" (for MSN Network), "aim" (for AOL IM Network), "icq" (for ICQ IM Network), "jabber" OR "" OR null (for Jabber Network)

Method Detail

constructIMAddress

public static java.lang.String constructIMAddress(java.lang.String id,
                                                  java.lang.String network)

Construct a String representation of an IM address.

Parameters:

id - the account ID on a particular IM network

network - could be

• IMAddressData.IM_YAHOO_TYPE (for Yahoo network)
• IMAddressData.IM_MSN_TYPE (for MSN Network)
• IMAddressData.IM_AIM_TYPE (for AOL IM Network)
• IMAddressData.IM_ICQ_TYPE (for ICQ IM Network)
• IMAddressData.IM_JABBER_TYPE OR "" OR null (for Jabber Network)

Returns:

a String representation of the IM address, or null if id is null.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class DeviceAddressData

getAddressType

public java.lang.String getAddressType()

"IM" is returned to indicate that it's an IM address.

Overrides:

getAddressType in class AddressData

getID

public static java.lang.String getID(java.lang.String fulladdr)

Returns the ID component of a full IM address

Parameters:

fulladdr - a full IM address

Returns:

the ID component of fulladdr or null if fulladdr is null.

getNetwork

public static java.lang.String getNetwork(java.lang.String fulladdr)

Returns the network component of a full IM address

Parameters:

fulladdr - a full IM address

Returns:

the network component of fulladdr or null if fulladdr is null.

hashCode

public int hashCode()

Overrides:

hashCode in class DeviceAddressData