|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.configuration.protocol.ConfServerContext
public class ConfServerContext
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 |
---|
public static final java.lang.String SCHEMA_FILE_NAME
public static final java.lang.String SERVER_SCHEMA_FILE_NAME
public static final int SERVER_ENCODING_DEFAULT
public static final int SERVER_ENCODING_MULTILINGUAL
Method Detail |
---|
public java.lang.String getServerVersion()
getProtocolVersion()
.
ServerVersion is initialized during opening the protocol. Always null if
the protocol is closed.
public java.lang.String getProtocolVersion()
public java.lang.String getServerProtocolVersion()
public java.lang.String getLocaleVersion()
public java.lang.String getDescription()
public CfgMetadata getMetadata()
ConfSchemaLoadException
- in case of failure of schema loadingpublic KeyValueCollection getLastLoginInfo()
public org.w3c.dom.Document getCfgLastLogin()
getLastLoginInfo()
public java.lang.Integer getServerEncoding()
0
- system default, 1
- UTF-8.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
.
public java.lang.Integer getExternalAuthentication()
ExternalAuthentication
attribute
with internal EventClientRegistered
.null
if channel is closed.
public boolean isSessionRestored()
ConfServerProtocol.getUseSession()
public int getSessionId()
ConfServerProtocol.getUseSession()
,
isSessionRestored()
,
getLastUpdateId()
public int getLastUpdateId()
ConfServerProtocol.getUseSession()
,
isSessionRestored()
,
getSessionId()
public void getSchema(javax.xml.transform.Result result) throws javax.xml.transform.TransformerException
result
- transformation result document to generate schema into
javax.xml.transform.TransformerException
- document generation error
ChannelNotOpenedException
- when channel isn't openendpublic int getDbid()
public int getBackupDbid()
public org.w3c.dom.Document getServerOptionsDescription() throws ProtocolException, javax.xml.parsers.ParserConfigurationException, javax.xml.transform.TransformerException
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 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |