ProtocolDescriptionSupport
@Generated(value="com.genesyslab.platform.commons.protocol.generator.Generator", date="2021-06-14T15:44:52.896-07:00") public abstract class RequestReadObjects extends Message
KeyValueCollection
that
allows you to supply information about the objects you want to get information
about. If you want to ask about all of the objects of a particular type in your
configuration layer, you can leave this filter key empty. Otherwise,
you will need to supply information that identifies the objects you are
interested in, such as the name of an agent, as shown here:
KeyValueCollection filterKey = new KeyValueCollection();
filterKey.addObject("user_name", agentUserName);
Note: when "dbid" filter key specified, Configuration Server will ignore other filter keys.Person
, which is
the object type used by Configuration Server for agents. Here is how to do that:
CfgObjectType objectType = CfgObjectType.CFGPerson;
int intPerson = objectType.asInteger();
RequestReadObjects requestReadObjects =
RequestReadObjects.create(
intPerson,
filterKey);
After you have created your request, you can send it to Configuration Server,
as shown here:
confServerProtocol.send(requestReadObjects);
If the request is successful, you will receive one or more
EventObjectsRead
messages, depending on how much data
Configuration Server needs to send. Once the server has finished sending
this data, it will send an EventObjectsSent
message, which
confirms that it has finished.Modifier and Type | Method | Description |
---|---|---|
static RequestReadObjects |
create() |
Creates instance of RequestReadObjects with no parameters set.
|
static RequestReadObjects |
create(java.lang.Integer objectType,
KeyValueCollection filter) |
Creates instance of RequestReadObjects with all parameters set.
|
abstract KeyValueCollection |
getFilter() |
Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection.
|
abstract java.lang.Integer |
getObjectType() |
Type of configuration object as defined in ConfServerObject enum
|
abstract java.lang.Integer |
getReferenceId() |
Reference ID to connect response to request.
|
abstract void |
setFilter(KeyValueCollection filter) |
Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection.
|
abstract void |
setObjectType(int objectType) |
Type of configuration object as defined in ConfServerObject enum
|
abstract void |
setObjectType(java.lang.Integer objectType) |
Type of configuration object as defined in ConfServerObject enum
|
abstract void |
setReferenceId(int referenceId) |
Reference ID to connect response to request.
|
abstract void |
setReferenceId(java.lang.Integer referenceId) |
Reference ID to connect response to request.
|
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 RequestReadObjects create()
public static RequestReadObjects create(java.lang.Integer objectType, KeyValueCollection filter)
objectType
- Type of configuration object as defined in ConfServerObject enumfilter
- Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection. Filter keys are defined as variables of integer type unless otherwise notedpublic abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getObjectType()
public abstract void setObjectType(java.lang.Integer objectType)
objectType
- new value of the propertypublic abstract void setObjectType(int objectType)
objectType
- new value of the propertypublic abstract KeyValueCollection getFilter()
public abstract void setFilter(KeyValueCollection filter)
filter
- new value of the propertySend comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.