Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.configuration.protocol
Class ConfServerContext

java.lang.Object
  extended bycom.genesyslab.platform.configuration.protocol.ConfServerContext

public class ConfServerContext
extends java.lang.Object


Method Summary
 int getBackupDbid()
          Get dbid of the Backup Configuration Server.
 int getDbid()
          Get dbid of the Primary Configuration Server.
 java.lang.String getDescription()
          Contains a description of the protocol's context.
 int getLastUpdateId()
          LastUpdateId property gets value of the latest object update received by the protocol.
 java.lang.String getProtocolVersion()
          ProtocolVersion property provides Protocol Version that is used for communication with Configuration Server.
 void getSchema(javax.xml.transform.Result result)
          Generate configuration protocol schema.
 org.w3c.dom.Document getServerOptionsDescription()
          ServerOptionsDescription property gets Server Options Description.
 com.genesyslab.platform.configuration.protocol.runtime.binding.ServerSchema getServerSchema()
          Schema property provides XmlSchema description of Configuration Server objects.
 java.lang.String getServerVersion()
          Configuration server the protocol is connected to.
 int getSessionId()
          SessionId property gets session value.
 boolean isSessionRestored()
          IsSessionRestored property indicates if session is restored.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getServerVersion

public java.lang.String getServerVersion()
Configuration server the protocol is connected to. 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

getDescription

public java.lang.String getDescription()
Contains a 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

getServerSchema

public com.genesyslab.platform.configuration.protocol.runtime.binding.ServerSchema getServerSchema()
Schema property provides XmlSchema description of Configuration Server objects. Schema is initialized during opening the protocol. Always null if the protocol is closed.

Returns:
schema document

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
Generate configuration protocol schema.

Parameters:
result - transformation result document to generate schema into
Throws:
javax.xml.transform.TransformerException - document generation error

getDbid

public int getDbid()
Get 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()
Get 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

Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.