Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.confserver.runtime.channel
Class EventClientRegistered

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

public abstract class EventClientRegistered
extends Message


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventClientRegistered create()
          Creates instance of EventClientRegistered with no parameters set.
static EventClientRegistered create(java.lang.Integer sessionId, java.lang.String oldProtocolVersion, java.lang.Integer externalAuthentication, java.lang.String description, java.lang.String protocolVersion, java.lang.Integer serverDbid, java.lang.Integer backupServerDbid, java.lang.Integer unsolisitedEventNumber, java.lang.Integer cryptedPassword, java.lang.String schemaVersion, KeyValueCollection parameters2, java.lang.Integer serverEncoding, java.lang.String localeVersion)
          Creates instance of EventClientRegistered with all parameters set.
static EventClientRegistered create(java.lang.Integer sessionId, java.lang.String oldProtocolVersion, java.lang.String protocolVersion)
          Creates instance of EventClientRegistered with required parameters set.
abstract  java.lang.Integer getBackupServerDbid()
          Backup Configuration Server identifier
abstract  java.lang.Integer getCryptedPassword()
          None
abstract  java.lang.String getDescription()
          Used for description of an error if type of event is error
abstract  java.lang.Integer getExternalAuthentication()
          For the external systems authentication
abstract  java.lang.String getLocaleVersion()
          None
abstract  java.lang.String getOldProtocolVersion()
          Old Protocol Version
abstract  KeyValueCollection getParameters2()
          None
abstract  java.lang.String getProtocolVersion()
          Protocol Version
abstract  java.lang.Integer getReferenceId()
          Reference ID to connect response to request.
abstract  java.lang.String getSchemaVersion()
          Schema Version
abstract  java.lang.Integer getServerDbid()
          Configuration Server identifier
abstract  java.lang.Integer getServerEncoding()
          Represents internal server encoding.
abstract  java.lang.Integer getSessionId()
          Session identifier
abstract  java.lang.Integer getUnsolisitedEventNumber()
          Unsolicited notification event's number
abstract  void setBackupServerDbid(int backupServerDbid)
          Backup Configuration Server identifier
abstract  void setBackupServerDbid(java.lang.Integer backupServerDbid)
          Backup Configuration Server identifier
abstract  void setCryptedPassword(int cryptedPassword)
          None
abstract  void setCryptedPassword(java.lang.Integer cryptedPassword)
          None
abstract  void setDescription(java.lang.String description)
          Used for description of an error if type of event is error
abstract  void setExternalAuthentication(int externalAuthentication)
          For the external systems authentication
abstract  void setExternalAuthentication(java.lang.Integer externalAuthentication)
          For the external systems authentication
abstract  void setLocaleVersion(java.lang.String localeVersion)
          None
abstract  void setOldProtocolVersion(java.lang.String oldProtocolVersion)
          Old Protocol Version
abstract  void setParameters2(KeyValueCollection parameters2)
          None
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 setSchemaVersion(java.lang.String schemaVersion)
          Schema Version
abstract  void setServerDbid(int serverDbid)
          Configuration Server identifier
abstract  void setServerDbid(java.lang.Integer serverDbid)
          Configuration Server identifier
abstract  void setServerEncoding(int serverEncoding)
          Represents internal server encoding.
abstract  void setServerEncoding(java.lang.Integer serverEncoding)
          Represents internal server encoding.
abstract  void setSessionId(int sessionId)
          Session identifier
abstract  void setSessionId(java.lang.Integer sessionId)
          Session identifier
abstract  void setUnsolisitedEventNumber(int unsolisitedEventNumber)
          Unsolicited notification event's number
abstract  void setUnsolisitedEventNumber(java.lang.Integer unsolisitedEventNumber)
          Unsolicited notification event's number
 
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 EventClientRegistered create()
Creates instance of EventClientRegistered with no parameters set.

Returns:
instance of EventClientRegistered

create

public static EventClientRegistered create(java.lang.Integer sessionId,
                                           java.lang.String oldProtocolVersion,
                                           java.lang.Integer externalAuthentication,
                                           java.lang.String description,
                                           java.lang.String protocolVersion,
                                           java.lang.Integer serverDbid,
                                           java.lang.Integer backupServerDbid,
                                           java.lang.Integer unsolisitedEventNumber,
                                           java.lang.Integer cryptedPassword,
                                           java.lang.String schemaVersion,
                                           KeyValueCollection parameters2,
                                           java.lang.Integer serverEncoding,
                                           java.lang.String localeVersion)
Creates instance of EventClientRegistered with all parameters set.

Parameters:
sessionId - Session identifier
oldProtocolVersion - Old Protocol Version
externalAuthentication - For the external systems authentication
description - Used for description of an error if type of event is error
protocolVersion - Protocol Version
serverDbid - Configuration Server identifier
backupServerDbid - Backup Configuration Server identifier
unsolisitedEventNumber - Unsolicited notification event's number
cryptedPassword - None
schemaVersion - Schema Version
parameters2 - None
serverEncoding - Represents internal server encoding. Supported values are: 0 - system default, 1 - UTF-8.
localeVersion - None
Returns:
instance of EventClientRegistered

create

public static EventClientRegistered create(java.lang.Integer sessionId,
                                           java.lang.String oldProtocolVersion,
                                           java.lang.String protocolVersion)
Creates instance of EventClientRegistered with required parameters set.

Parameters:
sessionId - Session identifier
oldProtocolVersion - Old Protocol Version
protocolVersion - Protocol Version
Returns:
instance of EventClientRegistered

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.


getSessionId

public abstract java.lang.Integer getSessionId()
Session identifier

Returns:
property value

setSessionId

public abstract void setSessionId(java.lang.Integer sessionId)
Session identifier

Parameters:
sessionId - new value of the property

setSessionId

public abstract void setSessionId(int sessionId)
Session identifier

Parameters:
sessionId - 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

getExternalAuthentication

public abstract java.lang.Integer getExternalAuthentication()
For the external systems authentication

Returns:
property value

setExternalAuthentication

public abstract void setExternalAuthentication(java.lang.Integer externalAuthentication)
For the external systems authentication

Parameters:
externalAuthentication - new value of the property

setExternalAuthentication

public abstract void setExternalAuthentication(int externalAuthentication)
For the external systems authentication

Parameters:
externalAuthentication - new value of the property

getDescription

public abstract java.lang.String getDescription()
Used for description of an error if type of event is error

Returns:
property value

setDescription

public abstract void setDescription(java.lang.String description)
Used for description of an error if type of event is error

Parameters:
description - new value of the property

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

getServerDbid

public abstract java.lang.Integer getServerDbid()
Configuration Server identifier

Returns:
property value

setServerDbid

public abstract void setServerDbid(java.lang.Integer serverDbid)
Configuration Server identifier

Parameters:
serverDbid - new value of the property

setServerDbid

public abstract void setServerDbid(int serverDbid)
Configuration Server identifier

Parameters:
serverDbid - new value of the property

getBackupServerDbid

public abstract java.lang.Integer getBackupServerDbid()
Backup Configuration Server identifier

Returns:
property value

setBackupServerDbid

public abstract void setBackupServerDbid(java.lang.Integer backupServerDbid)
Backup Configuration Server identifier

Parameters:
backupServerDbid - new value of the property

setBackupServerDbid

public abstract void setBackupServerDbid(int backupServerDbid)
Backup Configuration Server identifier

Parameters:
backupServerDbid - new value of the property

getUnsolisitedEventNumber

public abstract java.lang.Integer getUnsolisitedEventNumber()
Unsolicited notification event's number

Returns:
property value

setUnsolisitedEventNumber

public abstract void setUnsolisitedEventNumber(java.lang.Integer unsolisitedEventNumber)
Unsolicited notification event's number

Parameters:
unsolisitedEventNumber - new value of the property

setUnsolisitedEventNumber

public abstract void setUnsolisitedEventNumber(int unsolisitedEventNumber)
Unsolicited notification event's number

Parameters:
unsolisitedEventNumber - new value of the property

getCryptedPassword

public abstract java.lang.Integer getCryptedPassword()
None

Returns:
property value

setCryptedPassword

public abstract void setCryptedPassword(java.lang.Integer cryptedPassword)
None

Parameters:
cryptedPassword - new value of the property

setCryptedPassword

public abstract void setCryptedPassword(int cryptedPassword)
None

Parameters:
cryptedPassword - new value of the property

getSchemaVersion

public abstract java.lang.String getSchemaVersion()
Schema Version

Returns:
property value

setSchemaVersion

public abstract void setSchemaVersion(java.lang.String schemaVersion)
Schema Version

Parameters:
schemaVersion - new value of the property

getParameters2

public abstract KeyValueCollection getParameters2()
None

Returns:
property value

setParameters2

public abstract void setParameters2(KeyValueCollection parameters2)
None

Parameters:
parameters2 - new value of the property

getServerEncoding

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

Returns:
property value

setServerEncoding

public abstract void setServerEncoding(java.lang.Integer serverEncoding)
Represents internal server encoding. Supported values are: 0 - system default, 1 - UTF-8.

Parameters:
serverEncoding - new value of the property

setServerEncoding

public abstract void setServerEncoding(int serverEncoding)
Represents internal server encoding. Supported values are: 0 - system default, 1 - UTF-8.

Parameters:
serverEncoding - new value of the property

getLocaleVersion

public abstract java.lang.String getLocaleVersion()
None

Returns:
property value

setLocaleVersion

public abstract void setLocaleVersion(java.lang.String localeVersion)
None

Parameters:
localeVersion - new value of the property

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.