|
JSR-043: JTAPI-1.4 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The RouteAddress
interface extends the core
Address
interface and add methods to allow applications the
ability to select destinations for calls coming into this Address.
Applications may register to route calls for this Address via the
registerRouteCallback()
method defined on this interface. This
method takes an instance of an object which implements the
RouteCallback
interface. For each Call which comes into this
Address, a new RouteSession
is created for each callback which
is currently registered. The callbacks will receive routing requests via the
callbacks.
Applications may register to route calls for all RouteAddresses via a special
Address created by the Provider. This Address has the name
RouteAddress.ALL_ROUTE_ADDRESS
and may be obtained via the
Provider.getAddresses()
or Provider.getAddress()
method. When applications invoke the registerRouteCallback()
method on this special address, the callback will receive routing requests
for all routeable Addresses in the Provider's domain.
Field Summary | |
static java.lang.String |
ALL_ROUTE_ADDRESS
The string name of the special Address created by the Provider used by applications to register a callback for all routeable Addresses in the Provider's domain. |
Method Summary | |
void |
cancelRouteCallback(RouteCallback routeCallback)
Cancels a previously registered routing callback for this Address. |
RouteSession[] |
getActiveRouteSessions()
Returns an array of all active route sessions associated with this Address. |
RouteCallback[] |
getRouteCallback()
Returns an array of all callbacks which are registered to route Calls for this Address. |
void |
registerRouteCallback(RouteCallback routeCallback)
Registers a callback to route calls for this Address. |
Methods inherited from interface javax.telephony.Address |
addAddressListener, addCallListener, addCallObserver, addObserver, getAddressCapabilities, getAddressListeners, getCallListeners, getCallObservers, getCapabilities, getConnections, getName, getObservers, getProvider, getTerminals, removeAddressListener, removeCallListener, removeCallObserver, removeObserver |
Field Detail |
public static final java.lang.String ALL_ROUTE_ADDRESS
Method Detail |
public void registerRouteCallback(RouteCallback routeCallback) throws ResourceUnavailableException, MethodNotSupportedException
RouteAddress.ALL_ROUTE_ADDRESS
.
Multiple callbacks may be registered on a single Address. This method
throws ResourceUnavailableException
if the maximum number of
registered callbacks on the Address has been exceeded.
Pre-Conditions
routeCallback
- The callback to be registered.ResourceUnavailableException
- Indicates the maximum number of
registered callbacks for this Address has been exceeded.MethodNotSupportedException
- The implementation does not support
this method.public void cancelRouteCallback(RouteCallback routeCallback) throws MethodNotSupportedException
Pre-Conditions
routeCallback
- The callback to be cancelled.MethodNotSupportedException
- will be thrown if provider does
not support this method.public RouteCallback[] getRouteCallback() throws MethodNotSupportedException
null
if there exists no
registered callbacks.
MethodNotSupportedException
- The implementation does not support
this method.public RouteSession[] getActiveRouteSessions() throws MethodNotSupportedException
null
if there exists no active
route sessions.
MethodNotSupportedException
- The implementation does not support
this method.
|
JSR-043: JTAPI-1.4 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |