Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgConnInfo

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgStructure
          extended by com.genesyslab.platform.applicationblocks.com.objects.CfgConnInfo
All Implemented Interfaces:
ICfgBase, ICfgStructure

public class CfgConnInfo
extends CfgStructure

CfgConnInfo contains information about a connection.
Note:
If client and server exchange large processing instructions, that is, packets larger than 1Mbyte, the values for timeoutLocal and timeoutRemote for this connection should not be set to less than 3 seconds. Otherwise, the connection library will be forced to disconnect the client.


Constructor Summary
CfgConnInfo(IConfService confService, ConfStructure objData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
CfgConnInfo(IConfService confService, ICfgObject parent)
          This constructor is intended for creation of detached objects.
CfgConnInfo(IConfService confService, org.w3c.dom.Node xmlData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
 
Method Summary
 java.lang.String getAppParams()
          Connection protocol's application parameters.
 CfgApplication getAppServer()
          The unique identifier of the Server this application shall connect to as a client when it is started.
 java.lang.Integer getAppServerDBID()
          Retrieves the dbid of the object that is being linked to by the AppServer property.
 java.lang.String getCharField1()
          Optional text field #1.
 java.lang.String getCharField2()
          Optional text field #2.
 java.lang.String getCharField3()
          Optional text field #3.
 java.lang.String getCharField4()
          Optional text field #4.
 java.lang.String getConnProtocol()
          A pointer to the name of the connection control protocol.
 java.lang.String getDescription()
          Optional description of the connection.
 java.lang.String getId()
          An identifier of the server's listening port.
 java.lang.Integer getLongField1()
          Optional integer field #1.
 java.lang.Integer getLongField2()
          Optional integer field #2.
 java.lang.Integer getLongField3()
          Optional integer field #3.
 java.lang.Integer getLongField4()
          Optional integer field #4.
 CfgTraceMode getMode()
          The trace mode dedicated for this connection.
 java.lang.String getProxyParams()
          Connection protocol's proxy parameters.
 java.lang.Integer getTimoutLocal()
          The heart-bit polling interval measured in seconds, on client site.
 java.lang.Integer getTimoutRemote()
          The heart-bit polling interval measured in seconds, on server site.
 java.lang.String getTransportParams()
          Connection protocol's transport parameters.
 void setAppParams(java.lang.String value)
          Connection protocol's application parameters.
 void setAppServer(CfgApplication value)
          The unique identifier of the Server this application shall connect to as a client when it is started.
 void setAppServerDBID(int dbid)
          The unique identifier of the Server this application shall connect to as a client when it is started.
 void setCharField1(java.lang.String value)
          Optional text field #1.
 void setCharField2(java.lang.String value)
          Optional text field #2.
 void setCharField3(java.lang.String value)
          Optional text field #3.
 void setCharField4(java.lang.String value)
          Optional text field #4.
 void setConnProtocol(java.lang.String value)
          A pointer to the name of the connection control protocol.
 void setDescription(java.lang.String value)
          Optional description of the connection.
 void setId(java.lang.String value)
          An identifier of the server's listening port.
 void setLongField1(java.lang.Integer value)
          Optional integer field #1.
 void setLongField2(java.lang.Integer value)
          Optional integer field #2.
 void setLongField3(java.lang.Integer value)
          Optional integer field #3.
 void setLongField4(java.lang.Integer value)
          Optional integer field #4.
 void setMode(CfgTraceMode value)
          The trace mode dedicated for this connection.
 void setProxyParams(java.lang.String value)
          Connection protocol's proxy parameters.
 void setTimoutLocal(java.lang.Integer value)
          The heart-bit polling interval measured in seconds, on client site.
 void setTimoutRemote(java.lang.Integer value)
          The heart-bit polling interval measured in seconds, on server site.
 void setTransportParams(java.lang.String value)
          Connection protocol's transport parameters.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgStructure
getParent, updateChildrenSavedState
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase
clone, ensureDataBackup, equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, reloadObjectWithNewData, resolveLink, setProperty, toString, toStringProperties, toXml
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgBase
getEndpoint, getProperty, getRawObjectData, setProperty, toXml
 

Constructor Detail

CfgConnInfo

public CfgConnInfo(IConfService confService,
                   ConfStructure objData,
                   ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. It is internally used by COM AB for objects and structures deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol structure data
parent - instance of configuration object as a parent for this structure instance

CfgConnInfo

public CfgConnInfo(IConfService confService,
                   org.w3c.dom.Node xmlData,
                   ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. It is internally used by COM AB for objects and structures deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing structure data
parent - instance of configuration object as a parent for this structure instance

CfgConnInfo

public CfgConnInfo(IConfService confService,
                   ICfgObject parent)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance
parent - instance of configuration object as a parent for this structure instance
Method Detail

getAppServer

public final CfgApplication getAppServer()
The unique identifier of the Server this application shall connect to as a client when it is started.

Returns:
instance of referred object or null

setAppServer

public final void setAppServer(CfgApplication value)
The unique identifier of the Server this application shall connect to as a client when it is started.

Parameters:
value - new property value
See Also:
getAppServer()

setAppServerDBID

public final void setAppServerDBID(int dbid)
The unique identifier of the Server this application shall connect to as a client when it is started.

Parameters:
dbid - DBID identifier of referred object
See Also:
getAppServer()

getAppServerDBID

public final java.lang.Integer getAppServerDBID()
Retrieves the dbid of the object that is being linked to by the AppServer property.

Returns:
DBID identifier of referred object or null

getConnProtocol

public final java.lang.String getConnProtocol()
A pointer to the name of the connection control protocol. Available values: addp. Default: none.

Returns:
property value or null

setConnProtocol

public final void setConnProtocol(java.lang.String value)
A pointer to the name of the connection control protocol. Available values: addp. Default: none.

Parameters:
value - new property value
See Also:
getConnProtocol()

getTimoutLocal

public final java.lang.Integer getTimoutLocal()
The heart-bit polling interval measured in seconds, on client site.

Returns:
property value or null

setTimoutLocal

public final void setTimoutLocal(java.lang.Integer value)
The heart-bit polling interval measured in seconds, on client site.

Parameters:
value - new property value
See Also:
getTimoutLocal()

getTimoutRemote

public final java.lang.Integer getTimoutRemote()
The heart-bit polling interval measured in seconds, on server site.

Returns:
property value or null

setTimoutRemote

public final void setTimoutRemote(java.lang.Integer value)
The heart-bit polling interval measured in seconds, on server site.

Parameters:
value - new property value
See Also:
getTimoutRemote()

getMode

public final CfgTraceMode getMode()
The trace mode dedicated for this connection. Refer to CfgTraceMode below. Default value: CFGTMNoTraceMode.

Returns:
property value or null

setMode

public final void setMode(CfgTraceMode value)
The trace mode dedicated for this connection. Refer to CfgTraceMode below. Default value: CFGTMNoTraceMode.

Parameters:
value - new property value
See Also:
getMode()

getId

public final java.lang.String getId()
An identifier of the server's listening port. Should correspond to CfgPortInfo.id.

Returns:
property value or null

setId

public final void setId(java.lang.String value)
An identifier of the server's listening port. Should correspond to CfgPortInfo.id.

Parameters:
value - new property value
See Also:
getId()

getTransportParams

public final java.lang.String getTransportParams()
Connection protocol's transport parameters.

Returns:
property value or null

setTransportParams

public final void setTransportParams(java.lang.String value)
Connection protocol's transport parameters.

Parameters:
value - new property value
See Also:
getTransportParams()

getAppParams

public final java.lang.String getAppParams()
Connection protocol's application parameters.

Returns:
property value or null

setAppParams

public final void setAppParams(java.lang.String value)
Connection protocol's application parameters.

Parameters:
value - new property value
See Also:
getAppParams()

getProxyParams

public final java.lang.String getProxyParams()
Connection protocol's proxy parameters.

Returns:
property value or null

setProxyParams

public final void setProxyParams(java.lang.String value)
Connection protocol's proxy parameters.

Parameters:
value - new property value
See Also:
getProxyParams()

getDescription

public final java.lang.String getDescription()
Optional description of the connection.

Returns:
property value or null

setDescription

public final void setDescription(java.lang.String value)
Optional description of the connection.

Parameters:
value - new property value
See Also:
getDescription()

getCharField1

public final java.lang.String getCharField1()
Optional text field #1.

Returns:
property value or null

setCharField1

public final void setCharField1(java.lang.String value)
Optional text field #1.

Parameters:
value - new property value
See Also:
getCharField1()

getCharField2

public final java.lang.String getCharField2()
Optional text field #2.

Returns:
property value or null

setCharField2

public final void setCharField2(java.lang.String value)
Optional text field #2.

Parameters:
value - new property value
See Also:
getCharField2()

getCharField3

public final java.lang.String getCharField3()
Optional text field #3.

Returns:
property value or null

setCharField3

public final void setCharField3(java.lang.String value)
Optional text field #3.

Parameters:
value - new property value
See Also:
getCharField3()

getCharField4

public final java.lang.String getCharField4()
Optional text field #4.

Returns:
property value or null

setCharField4

public final void setCharField4(java.lang.String value)
Optional text field #4.

Parameters:
value - new property value
See Also:
getCharField4()

getLongField1

public final java.lang.Integer getLongField1()
Optional integer field #1.

Returns:
property value or null

setLongField1

public final void setLongField1(java.lang.Integer value)
Optional integer field #1.

Parameters:
value - new property value
See Also:
getLongField1()

getLongField2

public final java.lang.Integer getLongField2()
Optional integer field #2.

Returns:
property value or null

setLongField2

public final void setLongField2(java.lang.Integer value)
Optional integer field #2.

Parameters:
value - new property value
See Also:
getLongField2()

getLongField3

public final java.lang.Integer getLongField3()
Optional integer field #3.

Returns:
property value or null

setLongField3

public final void setLongField3(java.lang.Integer value)
Optional integer field #3.

Parameters:
value - new property value
See Also:
getLongField3()

getLongField4

public final java.lang.Integer getLongField4()
Optional integer field #4.

Returns:
property value or null

setLongField4

public final void setLongField4(java.lang.Integer value)
Optional integer field #4.

Parameters:
value - new property value
See Also:
getLongField4()

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.