|
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.outbound.protocol.outboundserver.runtime.channel.RequestRegisterClient
public abstract class RequestRegisterClient
Sent to OCS to register the client upon connection. For internal use only.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestRegisterClient |
create()
Creates instance of RequestRegisterClient with no parameters set. |
static RequestRegisterClient |
create(java.lang.String libraryProtocol)
Creates instance of RequestRegisterClient with required parameters set. |
static RequestRegisterClient |
create(java.lang.String libraryProtocol,
KeyValueCollection requestProperties)
Creates instance of RequestRegisterClient with all parameters set. |
abstract java.lang.String |
getLibraryProtocol()
Specifies the library protocol (internal use) |
abstract java.lang.Integer |
getReferenceId()
The reference id by which requests are associated with corresponding events. |
abstract KeyValueCollection |
getRequestProperties()
A KeyValue list of additional information passed to the request |
abstract void |
setLibraryProtocol(java.lang.String libraryProtocol)
Specifies the library protocol (internal use) |
abstract void |
setReferenceId(int referenceId)
The reference id by which requests are associated with corresponding events. |
abstract void |
setReferenceId(java.lang.Integer referenceId)
The reference id by which requests are associated with corresponding events. |
abstract void |
setRequestProperties(KeyValueCollection requestProperties)
A KeyValue list of additional information passed to 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 RequestRegisterClient create()
public static RequestRegisterClient create(java.lang.String libraryProtocol, KeyValueCollection requestProperties)
libraryProtocol
- Specifies the library protocol (internal use)requestProperties
- A KeyValue list of additional information passed to the request
public static RequestRegisterClient create(java.lang.String libraryProtocol)
libraryProtocol
- Specifies the library protocol (internal use)
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.String getLibraryProtocol()
public abstract void setLibraryProtocol(java.lang.String libraryProtocol)
libraryProtocol
- new value of the propertypublic abstract KeyValueCollection getRequestProperties()
public abstract void setRequestProperties(KeyValueCollection requestProperties)
requestProperties
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |