- 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:
- AccessPointType: the type of this access point object. The valid types
- 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.
- DeliveryType: the delivery type of the device address(es) such as EMAIL,
- Value: the value of the device address(es) described in either of these
- if AccessPointType is SINGLE_ADDRESS, this value contains a single
For example, "email@example.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
To create AccessPoint objects, use the
static final java.lang.String NUMBER_RANGE_DELIMITER
- See Also:
- Constant Field Values
- Get the delivery type of the access point.
- the delivery type of the access point.
- Get the type of the access point.
- the type of the access point.
- Get the value of the access point.
- the value of the access point.
- 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.
- Deprecated. 22.214.171.124.0
- Get the original unexpanded access point. If the original access point
was of type NUMBER_RANGE, the server may have expanded it into a list of
SINGLE_ADDRESS access points. This method provides access to the original
unexpanded access point if this is an expanded access point.
- the original registered access point, if available; null,
- Get the normalized address value based on the 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 lower case value of
- the normalized address value.
Copyright © 2009, 2013 Oracle and/or its affiliates. All rights reserved.