|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement.RequestPublish
public abstract class RequestPublish
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static RequestPublish create()
public static RequestPublish create(java.lang.Integer proxyClientId, java.lang.String psTopic, KeyValueCollection psEventContent, java.lang.Boolean distributeToOriginator, KeyValueCollection extension)
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.
public static RequestPublish create(java.lang.String psTopic, KeyValueCollection psEventContent)
psTopic
- Name of the topic to publish request for.psEventContent
- User event content.
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract java.lang.String getPsTopic()
public abstract void setPsTopic(java.lang.String psTopic)
public abstract KeyValueCollection getPsEventContent()
public abstract void setPsEventContent(KeyValueCollection psEventContent)
public abstract java.lang.Boolean getDistributeToOriginator()
public abstract void setDistributeToOriginator(java.lang.Boolean distributeToOriginator)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |