Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol
Class ConfServerContext

java.lang.Object
  extended by com.genesyslab.platform.configuration.protocol.ConfServerContext
All Implemented Interfaces:
ServerContext

public class ConfServerContext
extends java.lang.Object
implements ServerContext

Context container for opened Configuration Server Protocol connection.


Field Summary
static java.lang.String SCHEMA_FILE_NAME
           
static int SERVER_ENCODING_DEFAULT
           
static int SERVER_ENCODING_MULTILINGUAL
           
static java.lang.String SERVER_SCHEMA_FILE_NAME
           
 
Method Summary
 int getBackupDbid()
          Gets dbid of the Backup Configuration Server.
 org.w3c.dom.Document getCfgLastLogin()
          Deprecated. The property has been deprecated
 int getDbid()
          Gets dbid of the Primary Configuration Server.
 java.lang.String getDescription()
          Returns description of the protocol's context.
 java.lang.Integer getExternalAuthentication()
          For the external systems authentication.
 KeyValueCollection getLastLoginInfo()
          Returns information about last login.
 int getLastUpdateId()
          LastUpdateId property gets value of the latest object update received by the protocol.
 java.lang.String getLocaleVersion()
          LocaleVersion property provides Locale Version that is used for communication with Configuration Server.
 CfgMetadata getMetadata()
          Configuration server information structures descriptions.
 java.lang.String getProtocolVersion()
          ProtocolVersion property provides Protocol Version that is used for communication with Configuration Server.
 void getSchema(javax.xml.transform.Result result)
          Generates configuration protocol schema.
 java.lang.Integer getServerEncoding()
          Represents internal server encoding.
Possible values are: 0 - system default, 1 - UTF-8.
Always is null if channel is closed.
 org.w3c.dom.Document getServerOptionsDescription()
          ServerOptionsDescription property gets Server Options Description.
 java.lang.String getServerProtocolVersion()
           
 java.lang.String getServerVersion()
          Returns the configuration server version to which the protocol is connected.
 int getSessionId()
          SessionId property gets session value.
 boolean isSessionRestored()
          IsSessionRestored property indicates if session is restored.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SCHEMA_FILE_NAME

public static final java.lang.String SCHEMA_FILE_NAME
See Also:
Constant Field Values

SERVER_SCHEMA_FILE_NAME

public static final java.lang.String SERVER_SCHEMA_FILE_NAME
See Also:
Constant Field Values

SERVER_ENCODING_DEFAULT

public static final int SERVER_ENCODING_DEFAULT
See Also:
Constant Field Values

SERVER_ENCODING_MULTILINGUAL

public static final int SERVER_ENCODING_MULTILINGUAL
See Also:
Constant Field Values
Method Detail

getServerVersion

public java.lang.String getServerVersion()
Returns the configuration server version to which the protocol is connected. Do not confuse with getProtocolVersion().

ServerVersion is initialized during opening the protocol. Always null if the protocol is closed.

Returns:
server version

getProtocolVersion

public java.lang.String getProtocolVersion()
ProtocolVersion property provides Protocol Version that is used for communication with Configuration Server.

ProtocolVersion is initialized during opening the protocol. Always null if the protocol is closed.

Returns:
protocol version

getServerProtocolVersion

public java.lang.String getServerProtocolVersion()

getLocaleVersion

public java.lang.String getLocaleVersion()
LocaleVersion property provides Locale Version that is used for communication with Configuration Server.

LocaleVersion is initialized during opening the protocol. Always null if the protocol is closed.

Returns:
locale version or null

getDescription

public java.lang.String getDescription()
Returns description of the protocol's context.

The description is initialized while opening the protocol and is always null if the protocol is closed. If Configuration Server has an integration with Radius Authentication, this property may contain a Radius meta-message (meta-text). This message enables users to analyze and react to the meta-message (meta-text).

Returns:
description

getMetadata

public CfgMetadata getMetadata()
Configuration server information structures descriptions. Configuration Metadata is based on actual configuration server schema.

It is been initialized during the protocol open procedure (handshake).

Always null if the protocol connection is closed.

Returns:
Metadata structure representing actual configuration server schema information
Throws:
ConfSchemaLoadException - in case of failure of schema loading

getLastLoginInfo

public KeyValueCollection getLastLoginInfo()
Returns information about last login.

Returns:
information about last login

getCfgLastLogin

public org.w3c.dom.Document getCfgLastLogin()
Deprecated. The property has been deprecated

See Also:
getLastLoginInfo()

getServerEncoding

public java.lang.Integer getServerEncoding()
Represents internal server encoding.
Possible values are: 0 - system default, 1 - UTF-8.
Always is null if channel is closed.

Currently 1 value means that the configuration server supports multilanguage configuration.

Note: This property is new for the Genesys Management Framework v8.1.2. So, in earlier configuration server versions this value is null.

Returns:
server encoding or null

getExternalAuthentication

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

Configuration Server may provide ExternalAuthentication attribute with internal EventClientRegistered.
This value will be available here after successful protocol open procedure.
Always null if channel is closed.

Returns:
ExternalAuthentication value provided by Configuration Server or null

isSessionRestored

public boolean isSessionRestored()
IsSessionRestored property indicates if session is restored.

Always false if the protocol is closed. Always false if session usage is not enforced.

Returns:
true is session is restored
See Also:
ConfServerProtocol.getUseSession()

getSessionId

public int getSessionId()
SessionId property gets session value.

Protocol tries to restore session only if session usage is enforced (UseProtocol = true). SessionId is updated during opening the protocol to be used (if session usage is enforced) when the next attempt to open the protocol happens.

Returns:
session ID
See Also:
ConfServerProtocol.getUseSession(), isSessionRestored(), getLastUpdateId()

getLastUpdateId

public int getLastUpdateId()
LastUpdateId property gets value of the latest object update received by the protocol.

Protocol tries to restore session only if session usage is enforced (UseProtocol = true). LastUpdateId is updated during opening the protocol to be used (if session usage is enforced) when the next attempt to open the protocol happens.

Returns:
last update ID
See Also:
ConfServerProtocol.getUseSession(), isSessionRestored(), getSessionId()

getSchema

public void getSchema(javax.xml.transform.Result result)
               throws javax.xml.transform.TransformerException
Generates configuration protocol schema.

Parameters:
result - transformation result document to generate schema into
Throws:
javax.xml.transform.TransformerException - document generation error
ChannelNotOpenedException - when channel isn't openend

getDbid

public int getDbid()
Gets dbid of the Primary Configuration Server. Primary Configuration Server is the server the protocol is connected to. Dbid is initialized during opening the protocol. Always 0 if the protocol is closed.

Returns:
Dbid of the Primary Configuration Server

getBackupDbid

public int getBackupDbid()
Gets dbid of the Backup Configuration Server. Backup Configuration Server is the backup server for the Configuration Server the protocol is connected to. BackupDbid is initialized during opening the protocol. Always 0 if the protocol is closed.

Returns:
Dbid of the Backup Configuration Server.

getServerOptionsDescription

public org.w3c.dom.Document getServerOptionsDescription()
                                                 throws ProtocolException,
                                                        javax.xml.parsers.ParserConfigurationException,
                                                        javax.xml.transform.TransformerException
ServerOptionsDescription property gets Server Options Description. Always null when the protocol is closed. Supported by Config Server version 8.0.000.07 or later. In case of Config Servers with versions earlier then 8.0.000.07 ServerOptionsDescription returns null even when connection to such a server is open.

Returns:
server options description XML document
Throws:
ProtocolException - exception while requesting description from the server or parsing xml data
javax.xml.parsers.ParserConfigurationException - exception on creation of XML structure
javax.xml.transform.TransformerException - exception while parsing XML description data

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.