com.genesyslab.platform.voice.protocol.tserver
Class TServerPrivateServices
java.lang.Object
com.genesyslab.platform.voice.protocol.tserver.TServerPrivateServices
public class TServerPrivateServices
- extends java.lang.Object
Helper class for initialization of some of the SIPServer private services.
Included interface TServerPrivateServices.TServerPrivateServiceMessages
contains definitions
of specific service IDs with correspondent descriptions about their usage.
Also there are several helper methods designed for proper combination
of particular service request with correspondent set of service parameters.
- See Also:
TServerProtocol
,
RequestPrivateService
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ExtensionsKeyUdataFilter
public static final java.lang.String ExtensionsKeyUdataFilter
- See Also:
- Constant Field Values
ExtensionsKeyEventMask
public static final java.lang.String ExtensionsKeyEventMask
- See Also:
- Constant Field Values
TServerPrivateServices
public TServerPrivateServices()
createRequestRegisterAllKnownDNs
public static RequestPrivateService createRequestRegisterAllKnownDNs(java.lang.String thisDN,
KeyValueCollection udataFilter,
EventMask eventMask)
- Request for the Private Service for the bulk DN registration feature.
It queries SIP Server to register 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 and use the request:
Message resp = protocol.request(
TServerPrivateServices.createRequestRegisterAllKnownDNs(
thisDn, udataFilter, eventMask));
// 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=EventClusterDNStatus
]
for each of the subscribed DNs.
// Analyze asynchronous incoming message after successful registration:
if (TServerPrivateServices.isEventPrivateInfo(
msg, TServerPrivateServiceMessages.EventClusterDNStatus)) {
EventPrivateInfo event = (EventPrivateInfo) msg;
// Analyze content of 'event' as EventPrivateInfo/EventClusterDNStatus
}
}
- Parameters:
thisDN
- udataFilter
- eventMask
-
- Returns:
- initialized instance of the private service request message
createRequestChangeUserDataFilter
public static RequestPrivateService createRequestChangeUserDataFilter(java.lang.String thisDN,
KeyValueCollection udataFilter)
isEventPrivateInfo
public static boolean isEventPrivateInfo(Message message,
int privateMessageId)
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.