Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.requests
Class RequestRegisterClient

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.RequestRegisterClient
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestRegisterClient
extends Message

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

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 RequestRegisterClient create()
Creates instance of RequestRegisterClient with no parameters set.

Returns:
instance of RequestRegisterClient

create

public 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.

Parameters:
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 client
clientName - 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.
Returns:
instance of RequestRegisterClient

create

public static RequestRegisterClient create(InteractionClient clientType,
                                           java.lang.String clientName)
Creates instance of RequestRegisterClient with required parameters set.

Parameters:
clientType - Client type of the new client: 1-proxy, 2-agent application, 3-media server, 4-reporting engine, 5-routing engine, 8-ESP client
clientName - 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.
Returns:
instance of RequestRegisterClient

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.


getMediaType

public abstract java.lang.String getMediaType()
Intended for media server to specify the primary media type of the interaction it will submit to Interaction Server.


setMediaType

public 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.


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:


getClientType

public abstract InteractionClient getClientType()
Type of the new client:


setClientType

public abstract void setClientType(InteractionClient clientType)
Type of the new client:


getClientName

public abstract java.lang.String getClientName()
Name of the client. In general, the client name should be unique. The Interaction Server requires media server names to be unique because notifications to media servers are distributed based on their names.


setClientName

public abstract void setClientName(java.lang.String clientName)
Name of the client. In general, the client name should be unique. The Interaction Server requires media server names to be unique because notifications to media servers are distributed based on their names.


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.