com.ibm.soa.parlayx21.call_direction
Interface CallDirection
- All Superinterfaces:
- java.rmi.Remote
- All Known Subinterfaces:
- CallDirection_RI
- All Known Implementing Classes:
- CallDirectionBindingStub, CallDirectionProxy
public interface CallDirection
- extends java.rmi.Remote
This clause describes an initial set of capabilities in terms of message invocations (parameters and data types).
The message-based invocations are:
* handleBusy.
* handleNotReachable.
* handleNoAnswer.
* handleCalledNumber.
These messages are initiated by the Call Notification Web Service (running in a Parlay X 2 Gateway) and invoke an application Web Service(s), as a result of activity in the network. The result of the invocation of a handle operation is used as an indication on how the call should be handled in the network. The application can not keep control over the call after handling the event; every event handling is a separate occurrence.
Note that because the results of the invocations of the application Web Service(s) determine call handling in the network, the names of the methods are prefixed with 'handle', rather than 'notify'. The prefix 'notify' would imply a more asynchronous behaviour, whereas 'handle' shows the synchronous nature of these invocations.
The criteria for which the application Web Service(s) should be invoked, such as type of events (busy, answer, etc.), a URI to the Web Service and triggered addresses should be provisioned by the operator in an off-line process.
Method Summary |
Action |
handleBusy(java.lang.String correlator,
java.net.URI callingParty,
java.lang.String callingPartyName,
java.net.URI calledParty)
The invocation of handleBusy requests the application to inform the gateway how to handle the call between two addresses, the callingParty and the calledParty, where the calledParty is busy when the call is received. |
Action |
handleCalledNumber(java.lang.String correlator,
java.net.URI callingParty,
java.lang.String callingPartyName,
java.net.URI calledParty)
The invocation of handleCalledNumber requests the application to inform the gateway how to handle the call between two addresses, the callingParty and the calledParty. |
Action |
handleNoAnswer(java.lang.String correlator,
java.net.URI callingParty,
java.lang.String callingPartyName,
java.net.URI calledParty)
The invocation of handleNoAnswer requests the application to inform the gateway how to handle the call between two addresses, the callingParty and the calledParty, where the calledParty does not answer the received call. |
Action |
handleNotReachable(java.lang.String correlator,
java.net.URI callingParty,
java.lang.String callingPartyName,
java.net.URI calledParty)
The invocation of handleNotReachable requests the application to inform the gateway how to handle the call between two addresses, the callingParty and the calledParty, where the calledParty is not reachable when the call is received. |
handleBusy
Action handleBusy(java.lang.String correlator,
java.net.URI callingParty,
java.lang.String callingPartyName,
java.net.URI calledParty)
throws java.rmi.RemoteException,
PolicyException,
ServiceException
The invocation of handleBusy requests the application to inform the gateway how to handle the call between two addresses, the callingParty and the calledParty, where the calledParty is busy when the call is received. Optionally, the caller’s name is provided. The application returns the action, which directs the gateway to perform one of the following actions:
* "Continue", resulting in normal handling of the busy event in the network, for example, playing of a busy tone to the callingParty.
* "EndCall", resulting in the call being terminated; the exact tone or announcement that will be played to the callingParty is operator-specific.
* "Route", resulting in the call being re-routed to a calledParty specified by the application.
Optionally, in the action parameter, the application can also indicate the charging information.
Referenced faults
None.
- Parameters:
correlator
- xsd:string
Correlator provided in the request to set up this notificationcallingParty
- xsd:anyURI
It contains the address of the callercallingPartyName
- xsd:string
It contains the name of the callercalledParty
- xsd:anyURI
It contains the address of the called party. This party is busy
- Returns:
- result
Action
It indicates the action to be performed by the gateway
- Throws:
java.rmi.RemoteException
PolicyException
ServiceException
handleNotReachable
Action handleNotReachable(java.lang.String correlator,
java.net.URI callingParty,
java.lang.String callingPartyName,
java.net.URI calledParty)
throws java.rmi.RemoteException,
PolicyException,
ServiceException
The invocation of handleNotReachable requests the application to inform the gateway how to handle the call between two addresses, the callingParty and the calledParty, where the calledParty is not reachable when the call is received. Optionally, the caller’s name is provided. The application returns the action, which directs the gateway to perform one of the following actions:
* "Continue", resulting in normal handling of the 'not reachable' event in the network, for example, playing of a busy tone to the callingParty.
* "EndCall", resulting in the call being terminated; the exact tone or announcement that will be played to the callingParty is operator-specific.
* "Route", resulting in the call being re-routed to a calledParty specified by the application.
Optionally, in the action parameter, the application can also indicate the charging information.
Referenced faults
None.
- Parameters:
correlator
- xsd:string
Correlator provided in the request to set up this notificationcallingParty
- xsd:anyURI
It contains the address of the callercallingPartyName
- xsd:string
It contains the name of the callercalledParty
- xsd:anyURI
It contains the address of the called party. This party is not reachable
- Returns:
- result
Action
It indicates the action to be performed by the gateway
- Throws:
java.rmi.RemoteException
PolicyException
ServiceException
handleNoAnswer
Action handleNoAnswer(java.lang.String correlator,
java.net.URI callingParty,
java.lang.String callingPartyName,
java.net.URI calledParty)
throws java.rmi.RemoteException,
PolicyException,
ServiceException
The invocation of handleNoAnswer requests the application to inform the gateway how to handle the call between two addresses, the callingParty and the calledParty, where the calledParty does not answer the received call. Optionally, the caller’s name is provided. The application returns the action, which directs the gateway to perform one of the following actions:
* "Continue", resulting in normal handling of the 'no answer' event in the network, for example, playing of a busy tone to the callingParty.
* "EndCall", resulting in the call being terminated; the exact tone or announcement that will be played to the callingParty is operator-specific.
* "Route", resulting in the call being re-routed to a calledParty specified by the application.
Optionally, in the action parameter, the application can also indicate the charging information.
Referenced faults
None.
- Parameters:
correlator
- xsd:string
Correlator provided in the request to set up this notificationcallingParty
- xsd:anyURI
It contains the address of the callercallingPartyName
- xsd:string
It contains the name of the callercalledParty
- xsd:anyURI
It contains the address of the called party. This party does not answer the call
- Returns:
- result
Action
It indicates the action to be performed by the gateway
- Throws:
java.rmi.RemoteException
PolicyException
ServiceException
handleCalledNumber
Action handleCalledNumber(java.lang.String correlator,
java.net.URI callingParty,
java.lang.String callingPartyName,
java.net.URI calledParty)
throws java.rmi.RemoteException,
PolicyException,
ServiceException
The invocation of handleCalledNumber requests the application to inform the gateway how to handle the call between two addresses, the callingParty and the calledParty. The method is invoked when the callingParty tries to call the calledParty, but before the network routes the call to the calledParty. For example, the calledParty does not have to refer to a real end user, for example, it could be a service number. Optionally, the caller’s name is provided. The application returns the action, which directs the gateway to perform one of the following actions:
* "Continue", resulting in normal handling in the network, for example, the call will be routed to the calledParty number, as originally dialled.
* "EndCall", resulting in the call being terminated; the exact tone or announcement that will be played to the callingParty is operator-specific.
* "Route", resulting in the call being re-routed to a calledParty specified by the application.
Optionally, in the action parameter, the application can also indicate the charging information.
Referenced faults
None.
- Parameters:
correlator
- xsd:string
Correlator provided in the request to set up this notificationcallingParty
- xsd:anyURI
It contains the address of the callercallingPartyName
- xsd:string
It contains the name of the callercalledParty
- xsd:anyURI
It contains the address of the called party
- Returns:
- result
Action
It indicates the action to be performed by the gateway
- Throws:
java.rmi.RemoteException
PolicyException
ServiceException
Copyright © 2003 IBM Corp. All Rights Reserved.