Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement
Class RequestPublish

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement.RequestPublish
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestPublish
extends Message

With this request, any client (except a proxy) asks to publish a user event regarding a specified topic. This request combines with RequestSubscribe and RequestUnsubscribe to form a simple publisher-subscriber mechanism that clients can use to communicate through Interaction Server.

Direction: From client application to Interaction Server.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestPublish create()
          Creates instance of RequestPublish with no parameters set.
static RequestPublish create(java.lang.Integer proxyClientId, java.lang.String psTopic, KeyValueCollection psEventContent, java.lang.Boolean distributeToOriginator, KeyValueCollection extension)
          Creates instance of RequestPublish with all parameters set.
static RequestPublish create(java.lang.String psTopic, KeyValueCollection psEventContent)
          Creates instance of RequestPublish with required parameters set.
abstract  java.lang.Boolean getDistributeToOriginator()
          Values: 0 (default)-Publisher does not receive a copy of the topic. nonzero-Publisher receives a copy of the topic, if publisher is subscribed to the topic.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  KeyValueCollection getPsEventContent()
          User event content.
abstract  java.lang.String getPsTopic()
          Name of the topic to be published.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setDistributeToOriginator(java.lang.Boolean distributeToOriginator)
          Values: 0 (default)-Publisher does not receive a copy of the topic. nonzero-Publisher receives a copy of the topic, if publisher is subscribed to the topic.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
abstract  void setPsEventContent(KeyValueCollection psEventContent)
          User event content.
abstract  void setPsTopic(java.lang.String psTopic)
          Name of the topic to be published.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static RequestPublish create()
Creates instance of RequestPublish with no parameters set.

Returns:
instance of RequestPublish

create

public static RequestPublish create(java.lang.Integer proxyClientId,
                                    java.lang.String psTopic,
                                    KeyValueCollection psEventContent,
                                    java.lang.Boolean distributeToOriginator,
                                    KeyValueCollection extension)
Creates instance of RequestPublish with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
psTopic - Name of the topic to publish request for.
psEventContent - User event content.
distributeToOriginator - Default value is zero. Non-zero value indicates that publisher wants to receive a copy of the same user event if he is subscribed to the topic.
extension - Extensions.
Returns:
instance of RequestPublish

create

public static RequestPublish create(java.lang.String psTopic,
                                    KeyValueCollection psEventContent)
Creates instance of RequestPublish with required parameters set.

Parameters:
psTopic - Name of the topic to publish request for.
psEventContent - User event content.
Returns:
instance of RequestPublish

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


getProxyClientId

public abstract java.lang.Integer getProxyClientId()
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(int proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


getPsTopic

public abstract java.lang.String getPsTopic()
Name of the topic to be published.


setPsTopic

public abstract void setPsTopic(java.lang.String psTopic)
Name of the topic to be published.


getPsEventContent

public abstract KeyValueCollection getPsEventContent()
User event content.


setPsEventContent

public abstract void setPsEventContent(KeyValueCollection psEventContent)
User event content.


getDistributeToOriginator

public abstract java.lang.Boolean getDistributeToOriginator()
Values:


setDistributeToOriginator

public abstract void setDistributeToOriginator(java.lang.Boolean distributeToOriginator)
Values:


getExtension

public abstract KeyValueCollection getExtension()
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


setExtension

public abstract void setExtension(KeyValueCollection extension)
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


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.