Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver
Interface TServerPrivateServices.TServerPrivateServiceMessages

Enclosing class:
TServerPrivateServices

public static interface TServerPrivateServices.TServerPrivateServiceMessages

Interface describing some of TServer/SIPServer private services.

See Also:
RequestPrivateService, RequestPrivateService.setPrivateMsgID(int), EventPrivateInfo, EventPrivateInfo.getPrivateMsgID()

Field Summary
static int EventClusterDNStatus
          Event from SIPServer about DN status after successful registration with RequestRegisterAllKnownDNs.
static int EventEndOfSnapshot
          Server sends EventPrivateInfo(PrivateMsgId = EventEndOfSnapshot) after last EventPrivateInfo(PrivateMsgId = EventClusterDNStatus) to indicate end of the snapshot transmission.
static int RequestChangeUserDataFilter
          Changes User data filter for client.
static int RequestRegisterAllKnownDNs
          Service ID for the bulk DN registration feature.
 

Field Detail

RequestRegisterAllKnownDNs

static final int RequestRegisterAllKnownDNs
Service ID for the bulk DN registration feature. It registers for all known DNs on TController.

Usage sample:

 // Prepare request parameters:
 String thisDn = "";
 KeyValueCollection udataFilter = new KeyValueCollection();
 udataFilter.addString("key-1", "ABC");
 udataFilter.addString("key-2", "QWE");
 EventMask eventMask = new EventMask();
 eventMask.setAll();

 // Create the request:
 RequestPrivateService rqPrvSr =
         TServerPrivateServices.createRequestRegisterAllKnownDNs(
                 thisDn, udataFilter, eventMask);

 // Use the request:
 Message resp = protocol.request(rqPrvSr);

 // Result analysis:
 if (resp instanceof EventACK) {
     // the request executed ok...
 } else if (resp instanceof EventError) {
     // the request execution failed...
 }
 

Server successful response is presented with EventACK. Then server may send EventPrivateInfo [PrivateMsgID=<this-id>] for each of the subscribed DNs.

See Also:
TServerPrivateServices.createRequestRegisterAllKnownDNs(String, KeyValueCollection, EventMask), RequestPrivateService, RequestPrivateService.setPrivateMsgID(int), EventPrivateInfo, EventPrivateInfo.getPrivateMsgID(), EventClusterDNStatus, Constant Field Values

EventClusterDNStatus

static final int EventClusterDNStatus
Event from SIPServer about DN status after successful registration with RequestRegisterAllKnownDNs. Server sends EventPrivateInfo(PrivateMsgId = EventEndOfSnapshot) after last EventClusterDNStatus to indicate end of the snapshot transmission.

See Also:
TServerPrivateServices.isEventPrivateInfo(Message, int), EventPrivateInfo, EventPrivateInfo.getPrivateMsgID(), RequestRegisterAllKnownDNs, EventEndOfSnapshot, Constant Field Values

EventEndOfSnapshot

static final int EventEndOfSnapshot
Server sends EventPrivateInfo(PrivateMsgId = EventEndOfSnapshot) after last EventPrivateInfo(PrivateMsgId = EventClusterDNStatus) to indicate end of the snapshot transmission.

See Also:
EventPrivateInfo, EventPrivateInfo.getPrivateMsgID(), RequestRegisterAllKnownDNs, EventClusterDNStatus, Constant Field Values

RequestChangeUserDataFilter

static final int RequestChangeUserDataFilter
Changes User data filter for client. Client will receive user data only for specified keys.

Usage sample:

 // Prepare request parameters:
 String thisDn = "";
 KeyValueCollection udataFilter = new KeyValueCollection();
 udataFilter.addString("key-1", "ABC");
 udataFilter.addString("key-2", "QWE");

 // Create the request:
 RequestPrivateService rqPrvSr =
         TServerPrivateServices.createRequestChangeUserDataFilter(
                 thisDn, udataFilter);

 // Use the request:
 Message resp = protocol.request(rqPrvSr);

 // Result analysis:
 if (resp instanceof EventACK) {
     // the request executed ok...
 } else if (resp instanceof EventError) {
     // the request execution failed...
 }
 

Server successful response is presented with EventACK.

See Also:
TServerPrivateServices.createRequestChangeUserDataFilter(String, KeyValueCollection), RequestPrivateService, RequestPrivateService.setPrivateMsgID(int), Constant Field Values

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.