Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.confserver.runtime.channel
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.configuration.protocol.confserver.runtime.channel.RequestRegisterClient
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestRegisterClient
extends Message


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 clientType, java.lang.String clientName, java.lang.String userName, java.lang.String userPassword, java.lang.String protocolVersion)
          Deprecated. Use create() without arguments and then call needed setters.
abstract  java.lang.Integer getClientEncoding()
          Represents client encoding.
abstract  java.lang.String getClientName()
          Client application's name
abstract  java.lang.String getClientPassword()
          Deprecated.  
abstract  java.lang.Integer getClientType()
          Type of client application as defined in ConfServerClient enum
abstract  java.lang.String getGSSToken()
          A GSS token bytes hex presentation of Kerberos ticket identifies an user.
abstract  java.lang.String getKerberosTicket()
          A Kerberos ticket bytes hex presentation identifies an user.
abstract  java.lang.String getOldProtocolVersion()
          Old Protocol Version
abstract  java.lang.String getProtocolVersion()
          Protocol Version
abstract  java.lang.Integer getReferenceId()
          Reference ID to connect response to request.
abstract  java.lang.String getUserName()
          The name of a user in the Genesys Configuration Layer.
abstract  java.lang.String getUserPassword()
          The password of a user in the Genesys Configuration Layer.
abstract  void setClientEncoding(int clientEncoding)
          Represents client encoding.
abstract  void setClientEncoding(java.lang.Integer clientEncoding)
          Represents client encoding.
abstract  void setClientName(java.lang.String clientName)
          Client application's name
abstract  void setClientPassword(java.lang.String clientPassword)
          Deprecated.  
abstract  void setClientType(int clientType)
          Type of client application as defined in ConfServerClient enum
abstract  void setClientType(java.lang.Integer clientType)
          Type of client application as defined in ConfServerClient enum
abstract  void setGSSToken(java.lang.String gSSToken)
          A GSS token bytes hex presentation of Kerberos ticket identifies an user.
abstract  void setKerberosTicket(java.lang.String kerberosTicket)
          A Kerberos ticket bytes hex presentation identifies an user.
abstract  void setOldProtocolVersion(java.lang.String oldProtocolVersion)
          Old Protocol Version
abstract  void setProtocolVersion(java.lang.String protocolVersion)
          Protocol Version
abstract  void setReferenceId(int referenceId)
          Reference ID to connect response to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference ID to connect response to request.
abstract  void setUserName(java.lang.String userName)
          The name of a user in the Genesys Configuration Layer.
abstract  void setUserPassword(java.lang.String userPassword)
          The password of a user in the Genesys Configuration Layer.
 
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 clientType,
                                           java.lang.String clientName,
                                           java.lang.String userName,
                                           java.lang.String userPassword,
                                           java.lang.String protocolVersion)
Deprecated. Use create() without arguments and then call needed setters.

Creates instance of RequestRegisterClient.

Parameters:
clientType - Type of client application as defined in ConfServerClient enum
clientName - Client application's name
userName - User Name - required only for the applications that are not treated as daemon applications (servers) by Configuration Server
userPassword - User Password - required only for the applications that are not treated as daemon applications (servers) by Configuration Server
protocolVersion - Protocol Version
Returns:
instance of RequestRegisterClient

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


getClientType

public abstract java.lang.Integer getClientType()
Type of client application as defined in ConfServerClient enum

Returns:
property value

setClientType

public abstract void setClientType(java.lang.Integer clientType)
Type of client application as defined in ConfServerClient enum

Parameters:
clientType - new value of the property

setClientType

public abstract void setClientType(int clientType)
Type of client application as defined in ConfServerClient enum

Parameters:
clientType - new value of the property

getClientName

public abstract java.lang.String getClientName()
Client application's name

Returns:
property value

setClientName

public abstract void setClientName(java.lang.String clientName)
Client application's name

Parameters:
clientName - new value of the property

getUserName

public abstract java.lang.String getUserName()
The name of a user in the Genesys Configuration Layer.


setUserName

public abstract void setUserName(java.lang.String userName)
The name of a user in the Genesys Configuration Layer.


getUserPassword

public abstract java.lang.String getUserPassword()
The password of a user in the Genesys Configuration Layer. Do not try to read back its value. Method 'get' always returns empty string if any value has been set, otherwise it returns null.


setUserPassword

public abstract void setUserPassword(java.lang.String userPassword)
The password of a user in the Genesys Configuration Layer. Do not try to read back its value. Method 'get' always returns empty string if any value has been set, otherwise it returns null.


getProtocolVersion

public abstract java.lang.String getProtocolVersion()
Protocol Version

Returns:
property value

setProtocolVersion

public abstract void setProtocolVersion(java.lang.String protocolVersion)
Protocol Version

Parameters:
protocolVersion - new value of the property

getOldProtocolVersion

public abstract java.lang.String getOldProtocolVersion()
Old Protocol Version

Returns:
property value

setOldProtocolVersion

public abstract void setOldProtocolVersion(java.lang.String oldProtocolVersion)
Old Protocol Version

Parameters:
oldProtocolVersion - new value of the property

getClientPassword

@Deprecated
public abstract java.lang.String getClientPassword()
Deprecated. 

Client application's password. Obsolete and does not need to be specified

Returns:
property value

setClientPassword

@Deprecated
public abstract void setClientPassword(java.lang.String clientPassword)
Deprecated. 

Client application's password. Obsolete and does not need to be specified

Parameters:
clientPassword - new value of the property

getClientEncoding

public abstract java.lang.Integer getClientEncoding()
Represents client encoding. Supported values are: 0 - system default, 1 - UTF-8.

Returns:
property value

setClientEncoding

public abstract void setClientEncoding(java.lang.Integer clientEncoding)
Represents client encoding. Supported values are: 0 - system default, 1 - UTF-8.

Parameters:
clientEncoding - new value of the property

setClientEncoding

public abstract void setClientEncoding(int clientEncoding)
Represents client encoding. Supported values are: 0 - system default, 1 - UTF-8.

Parameters:
clientEncoding - new value of the property

getKerberosTicket

public abstract java.lang.String getKerberosTicket()
A Kerberos ticket bytes hex presentation identifies an user.


setKerberosTicket

public abstract void setKerberosTicket(java.lang.String kerberosTicket)
A Kerberos ticket bytes hex presentation identifies an user.


getGSSToken

public abstract java.lang.String getGSSToken()
A GSS token bytes hex presentation of Kerberos ticket identifies an user.


setGSSToken

public abstract void setGSSToken(java.lang.String gSSToken)
A GSS token bytes hex presentation of Kerberos ticket identifies an user.


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.