public class NotificationProducerImpl extends java.lang.Object implements NotificationProducer
This service offers clients the ability to subscribe for contact center notifications.
In effect notifications are possible using a back to back web service model. I.e. This
NotificationProducer service is paired with a NotificationConsumer
service running
on the client. When a client issues a subscribe request, it provides the endpoint information
of its NotificationConsumer service implementation such that when a notification occurs, the
NotificationProducer service can invoke the clients NotificationConsumers notify operation.
This service exposes operations that allow clients to subscribe, renew and unsubscribe contact
center notification subscriptions. Each subscription is associated with a specific CCT User.
Subscription details:
Consumers invoke subscribe on the NotificationProducer service when they want to be notified of
contact center events. The subscribe method offers clients the ability to create subscriptions
based on specific events, event types, contact center entities or contact center entity types.
The following sections details the general rules that apply to subscription topics;
I.e. the following must hold true...
NotificationTopicType
) XML where a client would
specify their subscription details.<complexType name="NotificationTopicType"> <sequence> <element name="AddressPropertyListener" type="tns:AddressPropertyListenerType" minOccurs="0" maxOccurs="1"/> <element name="TerminalPropertyListener" type="tns:TerminalPropertyListenerType" minOccurs="0" maxOccurs="1"/> : : </sequence> </complexType>Normally each listener type allows the user to specify 0, 1 or many Entities as well as 0, 1 or many Events specific to that listener type. For example, the AddressPropertyListenerType allows the user to specify specific AddressEntities and AddressPropertyEvents. The ConnectionStateListenerType allows the user to specify specific AddressEntities and ConnectionStateEvents, and so on for all the other listener types. This allows the user to indicate exactly the specific entities and specific events per listener type that they want to receive notification events for. If no entity is detailed as part of the listener type, it assumes wildcard status. I.e. all entities associated with the specific CCT User will trigger notifications. Likewise, if no event is detailed as part of the listener type, it also assumes wildcard status, i.e. all events associated with the listener type in question will be notified on their occurrance.
<complexType name="AddressPropertyListenerType"> <sequence> <element name="AddressEntity" type="types:address" minOccurs="0" maxOccurs="unbounded"/> <element name="AddressPropertyEvent" type="types:addressProperty" minOccurs="0" maxOccurs="unbounded"/> <:sequence> <:complexType> <complexType name="address"> <sequence> <element name="addressName" type="xsd:string" /> <element name="addressType" type="tns:addressType" /> <element name="provider" type="tns:provider" /> <element name="status" type="xsd:string" /> <:sequence> <:complexType> <simpleType name="addressProperty"> <restriction base="xsd:string"> <enumeration value="FORWARDING" /> <enumeration value="DO_NOT_DISTURB" /> <enumeration value="MESSAGE_WAITING" /> <enumeration value="ADDRESS_TERMINAL_ASSOCIATION" /> <enumeration value="ACQUIRE_STATUS" /> <enumeration value="URI" /> <enumeration value="CONTROLLED" /> <:restriction> <:simpleType>
Prerequisites to usage: This represents the minimal data artifacts required to successfully invoke this web service.
SsoToken
(Represents a valid CCT user session)
EndpointReferenceType
(Represents a valid client web endpoint)
TopicExpressionType
(Represents the clients subscription request information)
Operations: View WSDL TODO
Constructor and Description |
---|
NotificationProducerImpl() |
Modifier and Type | Method and Description |
---|---|
GetVersionResponse |
getVersion(GetVersionRequest parameters) |
void |
renew(org.xmlsoap.schemas.ws._2003._03.addressing.EndpointReferenceType subscriptionReference,
SsoToken ssoToken,
javax.xml.ws.Holder<javax.xml.datatype.XMLGregorianCalendar> terminationTime,
javax.xml.ws.Holder<javax.xml.datatype.XMLGregorianCalendar> currentTime) |
org.xmlsoap.schemas.ws._2003._03.addressing.EndpointReferenceType |
subscribe(org.xmlsoap.schemas.ws._2003._03.addressing.EndpointReferenceType consumerReference,
com.nortel.soa.oi.cct.basenotification.TopicExpressionType topicExpression,
java.lang.Boolean useNotify,
org.oasis_open.docs.wsrf._2004._06.wsrf_ws_resourceproperties_1_2_draft_01.QueryExpressionType precondition,
org.oasis_open.docs.wsrf._2004._06.wsrf_ws_resourceproperties_1_2_draft_01.QueryExpressionType selector,
com.nortel.soa.oi.cct.notification.SubscriptionPolicyType subscriptionPolicy,
javax.xml.datatype.XMLGregorianCalendar initialTerminationTime,
SsoToken ssoToken) |
boolean |
unsubscribe(org.xmlsoap.schemas.ws._2003._03.addressing.EndpointReferenceType subscriptionReference,
SsoToken ssoToken) |
public org.xmlsoap.schemas.ws._2003._03.addressing.EndpointReferenceType subscribe(org.xmlsoap.schemas.ws._2003._03.addressing.EndpointReferenceType consumerReference, com.nortel.soa.oi.cct.basenotification.TopicExpressionType topicExpression, java.lang.Boolean useNotify, org.oasis_open.docs.wsrf._2004._06.wsrf_ws_resourceproperties_1_2_draft_01.QueryExpressionType precondition, org.oasis_open.docs.wsrf._2004._06.wsrf_ws_resourceproperties_1_2_draft_01.QueryExpressionType selector, com.nortel.soa.oi.cct.notification.SubscriptionPolicyType subscriptionPolicy, javax.xml.datatype.XMLGregorianCalendar initialTerminationTime, SsoToken ssoToken) throws com.nortel.soa.oi.cct.notification.faults.TopicPathDialectUnknownFault, com.nortel.soa.oi.cct.notification.faults.SubscribeCreationFailedFault, com.nortel.soa.oi.cct.notification.faults.ResourceUnknownFault
subscribe
in interface NotificationProducer
com.nortel.soa.oi.cct.notification.faults.TopicPathDialectUnknownFault
com.nortel.soa.oi.cct.notification.faults.SubscribeCreationFailedFault
com.nortel.soa.oi.cct.notification.faults.ResourceUnknownFault
public boolean unsubscribe(org.xmlsoap.schemas.ws._2003._03.addressing.EndpointReferenceType subscriptionReference, SsoToken ssoToken) throws com.nortel.soa.oi.cct.notification.faults.UnableToDestroySubscriptionFault, com.nortel.soa.oi.cct.notification.faults.ResourceUnknownFault
unsubscribe
in interface NotificationProducer
com.nortel.soa.oi.cct.notification.faults.UnableToDestroySubscriptionFault
com.nortel.soa.oi.cct.notification.faults.ResourceUnknownFault
public void renew(org.xmlsoap.schemas.ws._2003._03.addressing.EndpointReferenceType subscriptionReference, SsoToken ssoToken, javax.xml.ws.Holder<javax.xml.datatype.XMLGregorianCalendar> terminationTime, javax.xml.ws.Holder<javax.xml.datatype.XMLGregorianCalendar> currentTime) throws com.nortel.soa.oi.cct.notification.faults.UnacceptableTerminationTimeFault, com.nortel.soa.oi.cct.notification.faults.ResourceUnknownFault, com.nortel.soa.oi.cct.notification.faults.RenewSubscriptionFailedFault
renew
in interface NotificationProducer
com.nortel.soa.oi.cct.notification.faults.UnacceptableTerminationTimeFault
com.nortel.soa.oi.cct.notification.faults.ResourceUnknownFault
com.nortel.soa.oi.cct.notification.faults.RenewSubscriptionFailedFault
public GetVersionResponse getVersion(GetVersionRequest parameters) throws GetVersionFault
getVersion
in interface NotificationProducer
GetVersionFault
Copyright © 2010 All Rights Reserved.