com.ibm.soa.parlayx21.call_direction
Class CallDirectionProxy

java.lang.Object
  extended by com.ibm.soa.parlayx21.call_direction.CallDirectionProxy
All Implemented Interfaces:
CallDirection, java.rmi.Remote

public class CallDirectionProxy
extends java.lang.Object
implements CallDirection


Constructor Summary
CallDirectionProxy()
           
 
Method Summary
 CallDirection getCallDirection()
           
 java.lang.String getEndpoint()
           
 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.
 void setEndpoint(java.lang.String endpoint)
           
 void useJNDI(boolean useJNDI)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CallDirectionProxy

public CallDirectionProxy()
Method Detail

useJNDI

public void useJNDI(boolean useJNDI)

getEndpoint

public java.lang.String getEndpoint()

setEndpoint

public void setEndpoint(java.lang.String endpoint)

getCallDirection

public CallDirection getCallDirection()

handleBusy

public Action handleBusy(java.lang.String correlator,
                         java.net.URI callingParty,
                         java.lang.String callingPartyName,
                         java.net.URI calledParty)
                  throws java.rmi.RemoteException,
                         PolicyException,
                         ServiceException
Description copied from interface: CallDirection

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.

Specified by:
handleBusy in interface CallDirection
Parameters:
correlator - xsd:string Correlator provided in the request to set up this notification
callingParty - xsd:anyURI It contains the address of the caller
callingPartyName - xsd:string It contains the name of the caller
calledParty - 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

public Action handleNotReachable(java.lang.String correlator,
                                 java.net.URI callingParty,
                                 java.lang.String callingPartyName,
                                 java.net.URI calledParty)
                          throws java.rmi.RemoteException,
                                 PolicyException,
                                 ServiceException
Description copied from interface: CallDirection

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.

Specified by:
handleNotReachable in interface CallDirection
Parameters:
correlator - xsd:string Correlator provided in the request to set up this notification
callingParty - xsd:anyURI It contains the address of the caller
callingPartyName - xsd:string It contains the name of the caller
calledParty - 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

public Action handleNoAnswer(java.lang.String correlator,
                             java.net.URI callingParty,
                             java.lang.String callingPartyName,
                             java.net.URI calledParty)
                      throws java.rmi.RemoteException,
                             PolicyException,
                             ServiceException
Description copied from interface: CallDirection

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.

Specified by:
handleNoAnswer in interface CallDirection
Parameters:
correlator - xsd:string Correlator provided in the request to set up this notification
callingParty - xsd:anyURI It contains the address of the caller
callingPartyName - xsd:string It contains the name of the caller
calledParty - 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

public Action handleCalledNumber(java.lang.String correlator,
                                 java.net.URI callingParty,
                                 java.lang.String callingPartyName,
                                 java.net.URI calledParty)
                          throws java.rmi.RemoteException,
                                 PolicyException,
                                 ServiceException
Description copied from interface: CallDirection

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.

Specified by:
handleCalledNumber in interface CallDirection
Parameters:
correlator - xsd:string Correlator provided in the request to set up this notification
callingParty - xsd:anyURI It contains the address of the caller
callingPartyName - xsd:string It contains the name of the caller
calledParty - 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.