com.ibm.soa.parlayx21.call_notification
Class CallNotificationManagerBindingStub

java.lang.Object
  extended by com.ibm.ws.webservices.engine.client.Stub
      extended by com.ibm.soa.parlayx21.call_notification.CallNotificationManagerBindingStub
All Implemented Interfaces:
CallNotificationManager, java.rmi.Remote, javax.xml.rpc.Stub

public class CallNotificationManagerBindingStub
extends com.ibm.ws.webservices.engine.client.Stub
implements CallNotificationManager


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.ws.webservices.engine.client.Stub
com.ibm.ws.webservices.engine.client.Stub.Invoke
 
Field Summary
 
Fields inherited from class com.ibm.ws.webservices.engine.client.Stub
cachedEndpoint, cachedhttpProxyHost, cachedhttpProxyPassword, cachedhttpProxyPort, cachedhttpProxyUser, cachedhttpRedirectEnabled, cachedhttpsProxyHost, cachedhttpsProxyPassword, cachedhttpsProxyPort, cachedhttpsProxyUser, cachedPassword, cachedPortName, cachedProperties, cachedRequestSoapHeaders, cachedRequestTransportHeaders, cachedResponseSoapHeaders, cachedResponseSoapHeaderTemplates, cachedResponseTransportHeaders, cachedResponseTransportHeadersTemplate, cachedSessionContext, cachedsslCfgName, cachedTimeout, cachedUsername, cachedWriteTimeout, connection, engine, maintainSession, maintainSessionSet, messageContexts, service
 
Fields inherited from interface javax.xml.rpc.Stub
ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY
 
Constructor Summary
CallNotificationManagerBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)
           
 
Method Summary
 void startCallNotification(SimpleReference reference, java.lang.String[] addresses, CallEvents[] criteria)
          This operation initiates notifications to the application for a given the specified addresses.
 void stopCallNotification(java.lang.String correlator)
          The application may end a call notification using this operation.
 
Methods inherited from class com.ibm.ws.webservices.engine.client.Stub
_getProperty, _getPropertyNames, _setProperty, convert, getPassword, getPortName, getTimeout, getTypeMapping, getUsername, primeMessageContext, setMaintainSession, setPassword, setPortName, setPortName, setTimeout, setUsername, setWriteTimeout, validateSoapHeadersHashMap, validateTransportPropertiesHashMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CallNotificationManagerBindingStub

public CallNotificationManagerBindingStub(java.net.URL endpointURL,
                                          javax.xml.rpc.Service service)
                                   throws com.ibm.ws.webservices.engine.WebServicesFault
Throws:
com.ibm.ws.webservices.engine.WebServicesFault
Method Detail

startCallNotification

public void startCallNotification(SimpleReference reference,
                                  java.lang.String[] addresses,
                                  CallEvents[] criteria)
                           throws java.rmi.RemoteException,
                                  PolicyException,
                                  ServiceException
Description copied from interface: CallNotificationManager

This operation initiates notifications to the application for a given the specified addresses. The address is an, which are Address Data items as defined in ES 202 391-1 [2].

The correlator provided in the reference must be unique for the application Web Service at the time the notification is initiated, otherwise a fault (SVC0005) will be returned to the application.

The criteria specifies the event-specific criteria used by application to define the call event(s) required. Only events that meet this criteria are notified. If the criteria parameter is not present, all call events will be notified.

Referenced Faults

ServiceException from ES 202 391-1 [2]
  * SVC0001 Service error
  * SVC0002 Invalid input value
  * SVC0005 Duplicate correlator

PolicyException from ES 202 391-1 [2]
  * POL0001 Policy error

Specified by:
startCallNotification in interface CallNotificationManager
Parameters:
reference - common:SimpleReference Notification endpoint definition
addresses - xsd:anyURI [1..unbounded] Addresses for which to receive notifications
criteria - CallEvents [0..unbounded]

Call events for which a notification is required. If not specified, all call events are notified.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

stopCallNotification

public void stopCallNotification(java.lang.String correlator)
                          throws java.rmi.RemoteException,
                                 PolicyException,
                                 ServiceException
Description copied from interface: CallNotificationManager
The application may end a call notification using this operation.

Referenced Faults

ServiceException from ES 202 391-1 [2]
  * SVC0001 Service error
  * SVC0002 Invalid input value

PolicyException from ES 202 391-1 [2]
  * POL0001 Policy error

Specified by:
stopCallNotification in interface CallNotificationManager
Parameters:
correlator - xsd:string Correlator of request to end
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.