Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.configuration
Class GApplicationConfiguration.GAppConnConfiguration

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.configuration.GApplicationConfiguration.GAppConnConfiguration
All Implemented Interfaces:
IGApplicationConfiguration.IGAppConnConfiguration, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
GCOMApplicationConfiguration.GCOMAppConnConfiguration
Enclosing class:
GApplicationConfiguration

public static class GApplicationConfiguration.GAppConnConfiguration
extends java.lang.Object
implements IGApplicationConfiguration.IGAppConnConfiguration, java.lang.Cloneable, java.io.Serializable

The application connection configuration structure reflects COM AB CfgConnInfo information.
It contains reference to connected server with related connection properties.

See Also:
CfgConnInfo, Serialized Form

Constructor Summary
GApplicationConfiguration.GAppConnConfiguration()
          Default empty constructor.
GApplicationConfiguration.GAppConnConfiguration(IGApplicationConfiguration.IGAppConnConfiguration conf)
          Coping constructor.
Note: it does not clone referred structure TargetServerConfiguration.
 
Method Summary
 GApplicationConfiguration.GAppConnConfiguration clone()
           
protected  java.lang.String contentToString()
          This method is used from toString() to build string representation of the internal content (configuration properties names and values).
 java.lang.String getAppParams()
          Returns connection protocol's application parameters.
 java.lang.String getConnProtocol()
          Returns name of the connection control protocol.
 java.lang.String getDescription()
          Returns optional description of the connection.
 java.lang.String getPortId()
          Returns identifier of the server's listening port.
 java.lang.String getProxyParams()
          Returns connection protocol's proxy parameters.
 IGApplicationConfiguration getTargetServerConfiguration()
          Returns application configuration of the connected server.
 java.lang.Integer getTimeoutLocal()
          Returns the heart-bit polling interval measured in seconds, on client site.
Valuable if connection protocol (getConnProtocol()) is "addp".
 java.lang.Integer getTimeoutRemote()
          Returns the heart-bit polling interval measured in seconds, on server site.
Valuable if connection protocol (getConnProtocol()) is "addp".
 CfgTraceMode getTraceMode()
          Returns the ADDP trace mode dedicated for this connection.
 java.lang.String getTransportParams()
          Returns connection protocol's transport parameters.
 void setAppParams(java.lang.String appParams)
          Sets connection protocol's application parameters.
 void setConnProtocol(java.lang.String connProtocol)
          Sets name of the connection control protocol.
 void setDescription(java.lang.String description)
          Sets optional description of the connection.
 void setPortId(java.lang.String portId)
          Sets identifier of the server's listening port.
 void setProxyParams(java.lang.String proxyParams)
          Sets connection protocol's proxy parameters.
 void setTargetServerConfiguration(IGApplicationConfiguration targetServer)
          Sets reference to application configuration of the connected server.
 void setTimeoutLocal(java.lang.Integer timeout)
          Sets the heart-bit polling interval measured in seconds, on client site.
Valuable if connection protocol (getConnProtocol()) is "addp".
 void setTimeoutRemote(java.lang.Integer timeout)
          Sets the heart-bit polling interval measured in seconds, on server site.
Valuable if connection protocol (getConnProtocol()) is "addp".
 void setTraceMode(CfgTraceMode traceMode)
          Sets the ADDP trace mode dedicated for this connection.
 void setTransportParams(java.lang.String transportParams)
          Sets connection protocol's transport parameters.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GApplicationConfiguration.GAppConnConfiguration

public GApplicationConfiguration.GAppConnConfiguration()
Default empty constructor. Creates uninitialized configuration object.


GApplicationConfiguration.GAppConnConfiguration

public GApplicationConfiguration.GAppConnConfiguration(IGApplicationConfiguration.IGAppConnConfiguration conf)
Coping constructor.
Note: it does not clone referred structure TargetServerConfiguration.

Parameters:
conf - original configuration
Method Detail

getTargetServerConfiguration

public IGApplicationConfiguration getTargetServerConfiguration()
Returns application configuration of the connected server.

Specified by:
getTargetServerConfiguration in interface IGApplicationConfiguration.IGAppConnConfiguration
Returns:
application configuration of the connected server
See Also:
CfgConnInfo.getAppServer()

getPortId

public java.lang.String getPortId()
Returns identifier of the server's listening port. Should correspond to IGApplicationConfiguration.IGPortInfo.getId().

Specified by:
getPortId in interface IGApplicationConfiguration.IGAppConnConfiguration
Returns:
connection port name/identifier
See Also:
CfgConnInfo.getId()

getConnProtocol

public java.lang.String getConnProtocol()
Returns name of the connection control protocol. Available values: "addp". Default: none.

Specified by:
getConnProtocol in interface IGApplicationConfiguration.IGAppConnConfiguration
Returns:
name of the connection control protocol
See Also:
CfgConnInfo.getConnProtocol()

getTimeoutLocal

public java.lang.Integer getTimeoutLocal()
Returns the heart-bit polling interval measured in seconds, on client site.
Valuable if connection protocol (getConnProtocol()) is "addp".

Specified by:
getTimeoutLocal in interface IGApplicationConfiguration.IGAppConnConfiguration
Returns:
local ADDP timeout or null
See Also:
getConnProtocol(), CfgConnInfo.getTimoutLocal()

getTimeoutRemote

public java.lang.Integer getTimeoutRemote()
Returns the heart-bit polling interval measured in seconds, on server site.
Valuable if connection protocol (getConnProtocol()) is "addp".

Specified by:
getTimeoutRemote in interface IGApplicationConfiguration.IGAppConnConfiguration
Returns:
remote ADDP timeout or null
See Also:
getConnProtocol(), CfgConnInfo.getTimoutRemote()

getTraceMode

public CfgTraceMode getTraceMode()
Returns the ADDP trace mode dedicated for this connection. Default value is CFGTMNoTraceMode ("no addp trace logs").

Specified by:
getTraceMode in interface IGApplicationConfiguration.IGAppConnConfiguration
Returns:
trace mode or null
See Also:
CfgConnInfo.getMode()

getTransportParams

public java.lang.String getTransportParams()
Returns connection protocol's transport parameters.

Specified by:
getTransportParams in interface IGApplicationConfiguration.IGAppConnConfiguration
Returns:
the connection transport parameters
See Also:
CfgConnInfo.getTransportParams()

getAppParams

public java.lang.String getAppParams()
Returns connection protocol's application parameters.

Specified by:
getAppParams in interface IGApplicationConfiguration.IGAppConnConfiguration
Returns:
the connection application parameters
See Also:
CfgConnInfo.getAppParams()

getProxyParams

public java.lang.String getProxyParams()
Returns connection protocol's proxy parameters.

Specified by:
getProxyParams in interface IGApplicationConfiguration.IGAppConnConfiguration
Returns:
the connection proxy parameters
See Also:
CfgConnInfo.getProxyParams()

getDescription

public java.lang.String getDescription()
Returns optional description of the connection.

Specified by:
getDescription in interface IGApplicationConfiguration.IGAppConnConfiguration
Returns:
connection description or null
See Also:
CfgConnInfo.getDescription()

setTargetServerConfiguration

public void setTargetServerConfiguration(IGApplicationConfiguration targetServer)
Sets reference to application configuration of the connected server.

Parameters:
targetServer - application configuration of the connected server
See Also:
CfgConnInfo.getAppServer()

setPortId

public void setPortId(java.lang.String portId)
Sets identifier of the server's listening port. Should correspond to IGApplicationConfiguration.IGPortInfo.getId().

Parameters:
portId - connection port name/identifier
See Also:
CfgConnInfo.getId()

setConnProtocol

public void setConnProtocol(java.lang.String connProtocol)
Sets name of the connection control protocol. Available values: "addp". Default: none.

Parameters:
connProtocol - name of the connection control protocol
See Also:
CfgConnInfo.getConnProtocol()

setTimeoutLocal

public void setTimeoutLocal(java.lang.Integer timeout)
Sets the heart-bit polling interval measured in seconds, on client site.
Valuable if connection protocol (getConnProtocol()) is "addp".

Parameters:
timeout - local ADDP timeout or null
See Also:
setConnProtocol(String), CfgConnInfo.getTimoutLocal()

setTimeoutRemote

public void setTimeoutRemote(java.lang.Integer timeout)
Sets the heart-bit polling interval measured in seconds, on server site.
Valuable if connection protocol (getConnProtocol()) is "addp".

Parameters:
timeout - remote ADDP timeout or null
See Also:
setConnProtocol(String), CfgConnInfo.getTimoutRemote()

setTraceMode

public void setTraceMode(CfgTraceMode traceMode)
Sets the ADDP trace mode dedicated for this connection. Default value is CFGTMNoTraceMode ("no addp trace logs").

Parameters:
traceMode - trace mode or null
See Also:
setConnProtocol(String), CfgConnInfo.getMode()

setTransportParams

public void setTransportParams(java.lang.String transportParams)
Sets connection protocol's transport parameters.

Parameters:
transportParams - connection transport parameters
See Also:
CfgConnInfo.getTransportParams()

setAppParams

public void setAppParams(java.lang.String appParams)
Sets connection protocol's application parameters.

Parameters:
appParams - connection application parameters
See Also:
CfgConnInfo.getAppParams()

setProxyParams

public void setProxyParams(java.lang.String proxyParams)
Sets connection protocol's proxy parameters.

Parameters:
proxyParams - connection proxy parameters
See Also:
CfgConnInfo.getProxyParams()

setDescription

public void setDescription(java.lang.String description)
Sets optional description of the connection.

Parameters:
description - connection description or null
See Also:
CfgConnInfo.getDescription()

clone

public GApplicationConfiguration.GAppConnConfiguration clone()
Overrides:
clone in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

contentToString

protected java.lang.String contentToString()
This method is used from toString() to build string representation of the internal content (configuration properties names and values).

Returns:
string representation of the configuration content
See Also:
toString()

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.