oracle.sdp.messaging
Interface AccessPoint

All Superinterfaces:

java.lang.Cloneable, MessagingObject, Serializable

public interface AccessPoint
extends MessagingObject, java.lang.Cloneable, Serializable

AccessPoint represents one or more device addresses to receive incoming messages. An application that wants to receive incoming messages must register one or more access points that represent the recipient addresses of the messages. The server matches the recipient address of an incoming message against the set of registered access points, and routes the incoming message to the application that registered the matching access point.
An AccessPoint has three attributes:

1. AccessPointType: the type of this access point object. The valid types are:
   • SINGLE_ADDRESS - defines a single device address
   • NUMBER_RANGE - defines a range of numerical device addresses, namely, a range of phone numbers or short codes.
2. DeliveryType: the delivery type of the device address(es) such as EMAIL, SMS, IM
3. Value: the value of the device address(es) described in either of these two forms:
   • if AccessPointType is SINGLE_ADDRESS, this value contains a single device address.
     For example, "foo@bar.com" or "16501234567".
   • if AccessPointType is NUMBER_RANGE, this value contains a number range to specify contiguous phone numbers or short codes.
     The range is specified as "<starting number>,<ending number>".
     Note the character "," (comma) is used to separate the starting and ending numbers of the range. You must ensure that the numbers themselves do not contain a comma character.
     <starting number> is the first number in the range (inclusive)
     <ending number> is the last number in the range (inclusive)
     For example, "16501230000,16501234999" means all numbers from 16501230000 to 16501234999 (inclusive).
     

To create AccessPoint objects, use the MessagingFactory.

Since:

11.1.1.0.0

Nested Class Summary

static class

AccessPoint.AccessPointType

Field Summary

static java.lang.String

NUMBER_RANGE_DELIMITER

Fields inherited from interface oracle.sdp.messaging.MessagingObject

NAMESPACE_NOTIFICATION_PREFERENCES, NAMESPACE_SDPM

Method Summary

DeliveryType	getDeliveryType() Get the delivery type of the access point.
java.lang.String	getKeyword() Get the keyword of the access point.
AccessPoint.AccessPointType	getType() Get the type of the access point.
java.lang.String	getValue() Get the value of the access point.

Methods inherited from interface oracle.sdp.messaging.MessagingObject

getAllNamespaces, getMetaData, getMetaDataNames, setMetaData

Field Detail

NUMBER_RANGE_DELIMITER

static final java.lang.String NUMBER_RANGE_DELIMITER

See Also:

Constant Field Values

Method Detail

getDeliveryType

DeliveryType getDeliveryType()

Get the delivery type of the access point.

Returns:

the delivery type of the access point.

getKeyword

java.lang.String getKeyword()

Get the keyword of the access point. Keywords restrict an access point to only receive messages containing the keyword value as the first token of the message's subject (if present) or first text/plain part (if present). Keyword matching is case-insensitive. A "multi-keyword" can also be specified, consisting of n whitespace-separated tokens. In this case the first n tokens of the message must match those of the access point in order for the message to be delivered.

Returns:

getType

AccessPoint.AccessPointType getType()

Get the type of the access point.

Returns:

the type of the access point.

getValue

java.lang.String getValue()

Get the value of the access point.

Returns:

the value of the access point.