ProtocolDescriptionSupport
@Generated(value="com.genesyslab.platform.commons.protocol.generator.Generator", date="2021-06-14T15:45:42.723-07:00") public abstract class RequestCloseStatistic extends Message
Name | Description |
---|---|
StatisticId | ReferenceId of the
RequestOpenStatistic or
RequestOpenStatisticEx
that was used to open the statistics. |
Name | Description |
---|---|
EventStatisticClosed |
Indicates that the referenced statistic has been closed. |
EventError |
Indicates that the request encountered an error. |
8.1.200.24
with changed behavior on this request.
It responds to the statistic close request using event with ReferenceId
value equal to correspondent open request.
As a result, "Message resp = protocol.request(requestCloseStat);
" fails to match the server response,
and returns null
after the protocol timeout.MessageHandler
.ReferenceId
of the
RequestOpenStatistic
or
RequestOpenStatisticEx
that was used to open the statistic, as shown here:
StatServerProtocol statProtocol = new StatServerProtocol(statEndpoint);
...
statProtocol.setMessageHandler(new StatMessageHandler());
statProtocol.open();
...
protected class StatMessageHandler implements MessageHandler {
public void onMessage(final Message message) {
if (message.messageId() == EventInfo.ID) {
EventInfo eventInfo = (EventInfo) message;
// TODO handle async statistic data
} else if (message.messageId() == EventStatisticClosed.ID) {
EventStatisticClosed evStatClosed = (EventStatisticClosed) message;
// TODO handle statistic close event
Integer statId = evStatClosed.getIntValue();
if (statId == null || statId.intValue() == 0) {
statId = evStatClosed.getReferenceId();
}
// 'statId' reflects 'referenceIdFromRequestOpenStatistic'
// Note: it's also possible to match the close event using 'Tag' attribute passed to the stat open request
} else {
// TODO handle other statserver events...
}
}
}
Doing asynchronous statistic close request:
RequestCloseStatistic req = RequestCloseStatistic.create();
req.setStatisticId(referenceIdFromRequestOpenStatistic);
statProtocol.send(req); // result of this operation will be delivered to the StatMessageHandler
Note2MessageHandler
component is not compatible with MessageReceiver
.statProtocol.receive();
will be no longer working, and all incoming
protocol events (including EventInfo
statistics notifications) will go to the StatMessageHandler
.Modifier and Type | Method | Description |
---|---|---|
static RequestCloseStatistic |
create() |
Creates instance of RequestCloseStatistic with no parameters set.
|
static RequestCloseStatistic |
create(java.lang.Integer statisticId) |
Creates instance of RequestCloseStatistic with all parameters set.
|
abstract java.lang.Integer |
getReferenceId() |
A unique integer that is specified for identification of requested statistics.
|
abstract java.lang.Integer |
getStatisticId() |
Refers to the ReferenceId of the RequestOpenStatistic or RequestOpenStatisticEx associated with this request: Stat Server needs this information so that it can take action on the appropriate set of statistical information.
|
abstract void |
setReferenceId(int referenceId) |
A unique integer that is specified for identification of requested statistics.
|
abstract void |
setReferenceId(java.lang.Integer referenceId) |
A unique integer that is specified for identification of requested statistics.
|
abstract void |
setStatisticId(int statisticId) |
Refers to the ReferenceId of the RequestOpenStatistic or RequestOpenStatisticEx associated with this request: Stat Server needs this information so that it can take action on the appropriate set of statistical information.
|
abstract void |
setStatisticId(java.lang.Integer statisticId) |
Refers to the ReferenceId of the RequestOpenStatistic or RequestOpenStatisticEx associated with this request: Stat Server needs this information so that it can take action on the appropriate set of statistical information.
|
equals, hashCode, toString, toString
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
public static final int ID
public static final java.lang.String NAME
public static RequestCloseStatistic create()
public static RequestCloseStatistic create(java.lang.Integer statisticId)
statisticId
- StatisticIdpublic abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getStatisticId()
public abstract void setStatisticId(java.lang.Integer statisticId)
public abstract void setStatisticId(int statisticId)
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.