|
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.RequestRegisterClient
public abstract class RequestRegisterClient
With this request, a client can register with Interaction Server.
Direction: From client to Interaction Server.
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.Integer proxyClientId,
java.lang.String mediaType,
KeyValueCollection extension,
InteractionClient clientType,
java.lang.String clientName)
Creates instance of RequestRegisterClient with all parameters set. |
static RequestRegisterClient |
create(InteractionClient clientType,
java.lang.String clientName)
Creates instance of RequestRegisterClient with required parameters set. |
abstract java.lang.String |
getClientName()
Name of the client. |
abstract InteractionClient |
getClientType()
Type of the new client: 1-proxy 2-agent application 3-media server 4-reporting engine 5-routing engine 8-ESP client |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract java.lang.String |
getMediaType()
Intended for media server to specify the primary media type of the interaction it will submit to Interaction Server. |
abstract java.lang.Integer |
getProxyClientId()
Proxy client identifier. |
abstract java.lang.Integer |
getReferenceId()
Reference identifier of the request. |
abstract void |
setClientName(java.lang.String clientName)
Name of the client. |
abstract void |
setClientType(InteractionClient clientType)
Type of the new client: 1-proxy 2-agent application 3-media server 4-reporting engine 5-routing engine 8-ESP client |
abstract void |
setExtension(KeyValueCollection extension)
A key-value list of extensions. |
abstract void |
setMediaType(java.lang.String mediaType)
Intended for media server to specify the primary media type of the interaction it will submit to Interaction Server. |
abstract void |
setProxyClientId(int proxyClientId)
Proxy client identifier. |
abstract void |
setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. |
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 RequestRegisterClient create()
public static RequestRegisterClient create(java.lang.Integer proxyClientId, java.lang.String mediaType, KeyValueCollection extension, InteractionClient clientType, java.lang.String clientName)
proxyClientId
- The identifier of the client of proxy.mediaType
- Interaction media type as defined in media types enumerator (system name of enumerator).extension
- Extensions.clientType
- Client type of the new client: 1-proxy, 2-agent application, 3-media server, 4-reporting engine, 5-routing engine, 8-ESP clientclientName
- Name of the client. The client name should be unique in general. The Interaction Server requires media server names to be unique because notifications to media servers are distributed based on their names.
public static RequestRegisterClient create(InteractionClient clientType, java.lang.String clientName)
clientType
- Client type of the new client: 1-proxy, 2-agent application, 3-media server, 4-reporting engine, 5-routing engine, 8-ESP clientclientName
- Name of the client. The client name should be unique in general. The Interaction Server requires media server names to be unique because notifications to media servers are distributed based on their names.
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 getMediaType()
public abstract void setMediaType(java.lang.String mediaType)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract InteractionClient getClientType()
public abstract void setClientType(InteractionClient clientType)
public abstract java.lang.String getClientName()
public abstract void setClientName(java.lang.String clientName)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |