Connection (o4glrt 12.8.0 API)

java.lang.Object
- com.progress.open4gl.javaproxy.Connection

All Implemented Interfaces:

IPoolProps, java.lang.AutoCloseable
```
public class Connection
extends java.lang.Object
implements java.lang.AutoCloseable, IPoolProps
```
The Connection class holds configuration and state data for a client connection to the application server. This class represents a logical connection to the application server and provides setters for the open client application to configure how the java open client is to behave.
When created, the Connection is pre-configured to an initial state using values copied from RunTimeProperties.
Progress Application Server Example:
To run a procedure named "ping.p" on the application server which takes no parameters, use the following exmaple.
```
var conn = new Connection("http://localhost:8810/apsv/", "", "", "");
var appobj = new OpenAppObj(conn);
var paramset  = new ParameterSet(0);
appobj.runProcedure("ping.p", paramset);
 
```

Field Summary
- Fields inherited from interface com.progress.open4gl.dynamicapi.IPoolProps
  _APPLICATION_UUID, _APPSERVER_KEEPALIVE_CAPS, _APPSERVER_VERSION, _APPSERVICE_CONNECTION_MODE, _APPSERVICE_HOST, _APPSERVICE_NAME, _APPSERVICE_PORT, _APPSERVICE_PROTOCOL, _CASK_ACTIVITY_TIMEOUT, _CASK_RESPONSE_TIMEOUT, _COMPRESSION_BUFFER_SIZE, _COMPRESSION_THRESHOLD, _CONN_TIMEOUT, _CONNECTION_LIFETIME, _DATASET_SET_NULL_INITIALS, _DEFAULT_COMPRESSION_LEVEL, _DEFAULT_COMPRESSION_THRESHOLD, _DEFAULT_LOCAL_CLIENT_TYPE, _DEFAULT_LOCAL_MAINT_VERSION, _DEFAULT_LOCAL_MAJOR_VERSION, _DEFAULT_LOCAL_MINOR_VERSION, _DISABLE_READ_THREAD, _ENABLE_COMPRESSION, _ENABLE_TRACING, _IDLE_SESSION_TIMEOUT, _INITIAL_SESSIONS, _LOGFILE_NAME, _LOGGING_ENTRY_TYPES, _MAX_COMPRESSION_LEVEL, _MAX_COMPRESSION_THRESHOLD, _MAX_SESSIONS, _MIN_COMPRESSION_LEVEL, _MIN_COMPRESSION_THRESHOLD, _MIN_IDLE_CONNECTIONS, _MIN_SESSIONS, _NS_CLIENT_MAX_PORT, _NS_CLIENT_MIN_PORT, _NS_CLIENT_PICKLIST, _NS_CLIENT_PICKLIST_EXP, _NS_CLIENT_RETRY, _NS_CLIENT_RETRY_INTERVAL, _POSTPONE_RELATION_INFO, _PROXY_HOST, _PROXY_PASSWORD, _PROXY_PORT, _PROXY_USERID, _REQUEST_WAIT_TIMEOUT, _RUNTIME_PROPERTY_VERSION, _SERIALIZE_DATASET_AS_XML, _SERIALIZE_DSET_TTAB_FORMAT, _SERVICE_AVAILABLE, _SERVICE_FAULT_LEVEL, _SERVICE_LOGGING_ENTRIES, _SERVICE_LOGGING_ENTRY_TYPES, _SERVICE_LOGGING_LEVEL, _SESSION_APPSERVERINFO, _SESSION_PASSWORD, _SESSION_URL, _SESSION_USERID, _SOCKET_TIMEOUT, _SSL_APPLET_CERTIFICATE_STORE, _SSL_CERTIFICATE_STORE, _SSL_CIPHERS, _SSL_NO_HOST_VERIFY, _SSL_NO_SESSION_REUSE, _SSL_PROTOCOLS, _SSL_WIN_CERTIFICATE_STORE, _STALE_OBJECT_TIMEOUT, _TRACE_LEVEL, _WAIT_IF_BUSY, ACTIONAL_GROUP_NAME, ADAPTERTYPE, APPLICATION_UUID, APPNAME, APPSERVER_KEEPALIVE_CAPS, APPSERVICE_CONNECTION_MODE, APPSERVICE_HOST, APPSERVICE_NAME, APPSERVICE_PORT, APPSERVICE_PROTOCOL, ASK_CLIENTASK_ENABLED, ASK_DEFAULT, ASK_DISABLED, ASK_MAJOR_VER, ASK_MINOR_VER, ASK_SERVERASK_ENABLED, ASK_VERSION, askPropNames, AUTO_CHUNKED_REQUESTS, CASK_ACTIVITY_TIMEOUT, CASK_RESPONSE_TIMEOUT, CLIENT_CONTEXT_ID, CLIENT_PRINCIPAL, COMPRESSION_BUFFER_SIZE, COMPRESSION_DEFAULT, COMPRESSION_DISABLED, COMPRESSION_LEVEL, COMPRESSION_THRESHOLD, compressionPropNames, CONN_TIMEOUT, CONNECTION_LIFETIME, D_ACTIONAL_GROUP_NAME, D_APPSERVER_KEEPALIVE_CAPS, D_APPSERVICE_CONNECTION_MODE, D_APPSERVICE_HOST, D_APPSERVICE_NAME, D_APPSERVICE_PORT, D_APPSERVICE_PROTOCOL, D_CASK_ACTIVITY_TIMEOUT, D_CASK_RESPONSE_TIMEOUT, D_CONN_TIMEOUT, D_CONNECTION_LIFETIME, D_DATASET_SET_NULL_INITIALS, D_DISABLE_READ_THREAD, D_IDLE_SESSION_TIMEOUT, D_INITIAL_SESSIONS, D_MAX_SESSIONS, D_MIN_IDLE_CONNECTIONS, D_MIN_SESSIONS, D_NS_CLIENT_MAX_PORT, D_NS_CLIENT_MIN_PORT, D_NS_CLIENT_PICKLIST, D_NS_CLIENT_PICKLIST_EXP, D_NS_CLIENT_RETRY, D_NS_CLIENT_RETRY_INTERVAL, D_POSTPONE_RELATION_INFO, D_REQUEST_WAIT_TIMEOUT, D_SERVICE_AVAILABLE, D_SERVICE_FAULT_LEVEL, D_SERVICE_LOGGING_ENTRIES, D_SERVICE_LOGGING_ENTRY_TYPES, D_SERVICE_LOGGING_LEVEL, D_SSL_CIPHERS, D_SSL_NO_HOST_VERIFY, D_SSL_NO_SESSION_REUSE, D_SSL_PROTOCOLS, D_STALE_OBJECT_TIMEOUT, D_WAIT_IF_BUSY, DATASET_SET_NULL_INITIALS, defaultPropNames, DISABLE_READ_THREAD, ENABLE_COMPRESSION, ENABLE_TRACING, HTTP_TIMEOUT, IDLE_SESSION_TIMEOUT, INITIAL_SESSIONS, INVALID_ASK_VERSION, L_ACTIONAL_GROUP_NAME, L_APPSERVER_KEEPALIVE_CAPS, L_APPSERVICE_CONNECTION_MODE, L_APPSERVICE_HOST, L_APPSERVICE_NAME, L_APPSERVICE_PORT, L_APPSERVICE_PROTOCOL, L_CASK_ACTIVITY_TIMEOUT, L_CASK_RESPONSE_TIMEOUT, L_CONN_TIMEOUT, L_CONNECTION_LIFETIME, L_DATASET_SET_NULL_INITIALS, L_DISABLE_READ_THREAD, L_IDLE_SESSION_TIMEOUT, L_INITIAL_SESSIONS, L_MAX_SESSIONS, L_MIN_IDLE_CONNECTIONS, L_MIN_SESSIONS, L_NS_CLIENT_MAX_PORT, L_NS_CLIENT_MIN_PORT, L_NS_CLIENT_PICKLIST, L_NS_CLIENT_PICKLIST_EXP, L_NS_CLIENT_RETRY, L_NS_CLIENT_RETRY_INTERVAL, L_POSTPONE_RELATION_INFO, L_REQUEST_WAIT_TIMEOUT, L_SERVICE_AVAILABLE, L_SERVICE_FAULT_LEVEL, L_SERVICE_LOGGING_ENTRIES, L_SERVICE_LOGGING_ENTRY_TYPES, L_SERVICE_LOGGING_LEVEL, L_SSL_CIPHERS, L_SSL_NO_HOST_VERIFY, L_SSL_NO_SESSION_REUSE, L_SSL_PROTOCOLS, L_STALE_OBJECT_TIMEOUT, L_WAIT_IF_BUSY, LOCAL_CLIENT_TYPE, LOCAL_MAINT_VERSION, LOCAL_MAJOR_VERSION, LOCAL_MINOR_VERSION, LOGFILE_NAME, LOGGING_ENTRY_TYPES, MAX_SESSIONS, MIN_IDLE_CONNECTIONS, MIN_SESSIONS, NET_BUFFER_SIZE, NS_CLIENT_MAX_PORT, NS_CLIENT_MIN_PORT, NS_CLIENT_PICKLIST, NS_CLIENT_PICKLIST_EXP, NS_CLIENT_RETRY, NS_CLIENT_RETRY_INTERVAL, POSTPONE_RELATION_INFO, PROPNAME_PREFIX, PROXY_HOST, PROXY_PASSWORD, PROXY_PORT, PROXY_USERID, REMOTE_CLIENT_TYPE, REMOTE_MAINT_VERSION, REMOTE_MAJOR_VERSION, REMOTE_MINOR_VERSION, REMOTE_VERSION_INFO, REQUEST_CHUNKING, REQUEST_WAIT_TIMEOUT, ROOT, RUNTIME_PROPERTY_VERSION, runtimePropNames, SEND_CHUNKED_REQUESTS, SERIALIZE_DATASET_AS_XML, SERIALIZE_DSET_TTAB_FORMAT, serialVersionUID, SERVER_NAME, SERVICE_AVAILABLE, SERVICE_FAULT_LEVEL, SERVICE_LOGGING_ENTRIES, SERVICE_LOGGING_ENTRY_TYPES, SERVICE_LOGGING_LEVEL, SERVLET_REQUEST_CTX, SERVLET_RESPONSE_CTX, SESSION_APPSERVERINFO, SESSION_PASSWORD, SESSION_POOL_NAME, SESSION_URL, SESSION_USERID, sessionFreePropNames, sessionManagedPropNames, SM_SESSION_FREE, SM_SESSION_MANAGED, SOCKET_TIMEOUT, SSL_CERTIFICATE_STORE, SSL_CIPHERS, SSL_NO_HOST_VERIFY, SSL_NO_SESSION_REUSE, SSL_PROTOCOLS, STALE_OBJECT_TIMEOUT, SUPPRESS_CHUNKED_REQUESTS, TCP_NODELAY, TRACE_LEVEL, USE_DEPRECATED_GET_CHANGES, V10_COMPRESSION, V9_COMPRESSION, WAIT_IF_BUSY, X_ACTIONAL_GROUP_NAME, X_ADAPTERTYPE, X_APPNAME, X_APPSERVER_KEEPALIVE_CAPS, X_APPSERVICE_CONNECTION_MODE, X_APPSERVICE_HOST, X_APPSERVICE_NAME, X_APPSERVICE_PORT, X_APPSERVICE_PROTOCOL, X_CASK_ACTIVITY_TIMEOUT, X_CASK_RESPONSE_TIMEOUT, X_CLIENT_CONTEXT_ID, X_CLIENT_PRINCIPAL, X_CONN_TIMEOUT, X_CONNECTION_LIFETIME, X_DATASET_SET_NULL_INITIALS, X_DISABLE_READ_THREAD, X_IDLE_SESSION_TIMEOUT, X_INITIAL_SESSIONS, X_LOCAL_CLIENT_TYPE, X_LOCAL_MAINT_VERSION, X_LOCAL_MAJOR_VERSION, X_LOCAL_MINOR_VERSION, X_MAX_SESSIONS, X_MIN_IDLE_CONNECTIONS, X_MIN_SESSIONS, X_NET_BUFFER_SIZE, X_NS_CLIENT_MAX_PORT, X_NS_CLIENT_MIN_PORT, X_NS_CLIENT_PICKLIST, X_NS_CLIENT_PICKLIST_EXP, X_NS_CLIENT_RETRY, X_NS_CLIENT_RETRY_INTERVAL, X_POSTPONE_RELATION_INFO, X_REMOTE_CLIENT_TYPE, X_REMOTE_MAINT_VERSION, X_REMOTE_MAJOR_VERSION, X_REMOTE_MINOR_VERSION, X_REMOTE_VERSION_INFO, X_REQUEST_WAIT_TIMEOUT, X_SERIALIZE_DATASET_AS_XML, X_SERIALIZE_DSET_TTAB_FORMAT, X_SERVICE_AVAILABLE, X_SERVICE_FAULT_LEVEL, X_SERVICE_LOGGING_ENTRIES, X_SERVICE_LOGGING_ENTRY_TYPES, X_SERVICE_LOGGING_LEVEL, X_SERVLET_REQUEST_CTX, X_SERVLET_RESPONSE_CTX, X_SSL_CIPHERS, X_SSL_NO_HOST_VERIFY, X_SSL_NO_SESSION_REUSE, X_SSL_PROTOCOLS, X_STALE_OBJECT_TIMEOUT, X_WAIT_IF_BUSY, XML_TYPE

Constructor Summary

Constructors
Constructor and Description
`Connection()`
`Connection(Connection parent)`
`Connection(Connection parent, boolean multiUser)`
`Connection(java.lang.String userId, java.lang.String password, java.lang.String appServerInfo)`
`Connection(java.lang.String userId, java.lang.String password, java.lang.String appServerInfo, boolean multiUser)`
`Connection(java.lang.String urlString, java.lang.String userId, java.lang.String password, java.lang.String appServerInfo)`
`Connection(java.lang.String urlString, java.lang.String userId, java.lang.String password, java.lang.String appServerInfo, boolean multiUser)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addReference(SessionPool sessionPool)`
`void`	`close()` release the connection.
`java.lang.String`	`getAppServerInfo()`
`java.lang.String`	`getAppServerKeepalive()` Method Returns the Keep Alive Capabilities setting
`java.util.Properties`	`getAsProperties()`
`boolean`	`getBooleanProperty(java.lang.String propName)`
`java.lang.String`	`getCertificateStore()` Method Returns the certicate store list
`int`	`getClientASKActivityTimeout()` Method Returns the client Keep Alive activity timeout
`int`	`getClientASKResponseTimeout()` Method Returns the client Keep Alive response timeout
`java.lang.String`	`getClientContextID()` Method get the clientContextID
`com.progress.auth.ClientPrincipal`	`getClientPrincipal()` Method get the client principal
`int`	`getClientType()` Method get the client type
`boolean`	`getCompressionEnabled()` Returns true if compression is enabled for this connection
`int`	`getCompressionLevel()` Returns the compression level set for this connection
`int`	`getCompressionThreshold()` returns the minimum size in bytes of the message body before compression will be done for a particular message.
`int`	`getConnectionLifetime()` Method Returns the connection lifetime
`boolean`	`getDatasetNullInitials()` Method gets the dataset null initials setting
`int`	`getIdleConnectionTimeout()` Method Returns the Idle Connection Timeout
`int`	`getInitialConnections()` Method Returns the number of initial connections to be made
`int`	`getIntProperty(java.lang.String propName)`
`java.lang.String`	`getLocalMaintVersion()` Method get the local maint version
`java.lang.String`	`getLocalMajorVersion()` Method get the local major version
`java.lang.String`	`getLocalMinorVersion()` Method get the local minor version
`OEVersionInfo`	`getLocalVersionInfo()`
`java.lang.String`	`getLogEntryTypes()` Method Returns the log entry types
`java.lang.String`	`getLogfileName()` Method Returns the logfileName
`long`	`getLongProperty(java.lang.String propName)`
`int`	`getMaxConnections()` Method Returns the maximum number of connections to be made
`int`	`getMinConnections()` Method Returns the minimum number of connections to be made
`int`	`getNetworkBufferSize()` Method get the network buffer size
`boolean`	`getNoHostVerify()` Method returns the optional HTTPS (SSL) server domain authentication .
`boolean`	`getNoSslSessionReuse()` Get the current state of SSL session reuse.
`int`	`getNsClientMaxPort()` Method Returns the maximum nameserver client port
`int`	`getNsClientMinPort()` Method Returns the minimum nameserver client port
`int`	`getNsClientPicklistSize()` Method Returns the number of broker definitions the nameserver client should retrieve from the nameserver each time
`int`	`getNsClientPortRetry()` Method Returns the number of times the nameserver client should retry connecting to the nameserver
`int`	`getNsClientPortRetryInterval()` Method Returns the number of seconds the nameserver client should wait between retrying to connect to the nameserver
`java.lang.String`	`getPassword()`
`boolean`	`getPostponeRelationInfo()` Method gets whether the behavior for whether the relational info is built when loading the ProDataGraph's data.
`java.util.Hashtable`	`getProperties()` Deprecated. Use `IPoolProps.getAsProperties()` instead. `Hashtable` is an old java 1.1 style class and should no longer be used.
`java.lang.Object`	`getProperty_prev(java.lang.String propName)`
`java.lang.Object`	`getProperty(java.lang.String propName)`
`java.lang.String`	`getProxyHost()` Method Returns the proxy host
`java.lang.String`	`getProxyPassword()` Method Returns the proxy authentication password
`int`	`getProxyPort()` Method Returns the proxy port
`java.lang.String`	`getProxyUserId()` Method Returns the proxy authentication user-id
`java.lang.String`	`getRemoteMaintVersion()` Method get the remote maint version
`java.lang.String`	`getRemoteMajorVersion()` Method get the remote major version
`java.lang.String`	`getRemoteMinorVersion()` Method get the remote minor version
`OEVersionInfo`	`getRemoteVersionInfo()`
`int`	`getRequestWaitTimeout()` Method Returns the number of seconds the client should wait for a connection to become available to run a request
`java.lang.String`	`getServerName()`
`int`	`getServerType()` Method get the server type
`int`	`getSessionModel()` Method Returns the session model
`SessionPool`	`getSessionPool()`
`java.lang.String`	`getSslCiphers()` Method Returns SSL ciphers list
`java.lang.String`	`getSslVersions()` Method Returns SSL protocol versions
`java.lang.String`	`getStringProperty(java.lang.String propName)`
`int`	`getTraceLevel()` Method Returns the trace level
`java.lang.String`	`getUrl()`
`boolean`	`getUseDeprecatedGetChanges()` Method Returns true if the functionality of ProChangeSummary.getChanges() has been reverted to the original/deprecated functionality, or false if it performs the current (default) functionality.
`java.lang.String`	`getUserId()`
`java.lang.String`	`getUUID()` Method Returns the uuid
`boolean`	`getWaitIfBusy()` Returns the current "Wait If Busy" setup.
`void`	`releaseConnection()`
`void`	`setAppServerInfo(java.lang.String appServerInfo)`
`void`	`setAppServerKeepalive(java.lang.String keepAliveCap)` Method sets the keep Alive Capabilities value
`java.lang.Object`	`setBooleanProperty(java.lang.String propName, boolean propValue)`
`void`	`setCertificateStore(java.lang.String certStoreList)` Method Set the CertificateStore.
`void`	`setClientASKActivityTimeout(int keepAliveActTimeout)` Method sets the client Keep Alive activity timeout
`void`	`setClientASKResponseTimeout(int keepAliveRespTimeout)` Method sets the client Keep Alive Response Timeout
`void`	`setClientContextID(java.lang.String clientContextID)` Method set the clientContextID
`void`	`setClientPrincipal(com.progress.auth.ClientPrincipal clientPrincipal)` Method set the client principal
`void`	`setClientType(int clientType)` Method set the client type
`void`	`setCompressionEnabled(boolean enabled)` Enable message body compression
`void`	`setCompressionLevel(int level)` Set the compression level used to compress messages.
`void`	`setCompressionThreshold(int threshold)` Set the minimum size in bytes for messages before compression is used on the message body.
`void`	`setConnectionLifetime(int nSeconds)` Method Set the connection lifetime
`void`	`setDatasetNullInitials(boolean value)` Method sets the behavior for initial values for int/int64/boolean fields on a dataset Must be set before building ProDataObjectMetaData object.
`void`	`setIdleConnectionTimeout(int nSeconds)` Method Set the Idle Connection Timeout
`void`	`setInitialConnections(int nConnections)` Method Set the number of initial connections to be made
`java.lang.Object`	`setIntProperty(java.lang.String propName, int propValue)`
`void`	`setLocalProperty(java.lang.String propName, java.lang.Object propValue)`
`void`	`setLogEntryTypes(java.lang.String logEntryTypes)` Method sets the logEntryTypes
`void`	`setLogfileName(java.lang.String logfileName)` Method sets the logfileName
`java.lang.Object`	`setLongProperty(java.lang.String propName, long propValue)`
`void`	`setMaxConnections(int nMaxConnections)` Method Set the maximum number of connections to be made
`void`	`setMinConnections(int nMinConnections)` Method Set the minimum number of connections to be made
`void`	`setNetworkBufferSize(int bufferSize)` Method set the network buffer size
`void`	`setNoHostVerify(boolean trueFalseState)` Method sets the optional HTTPS (SSL) server domain authentication option.
`void`	`setNoSslSessionReuse(boolean trueFalseState)` Turns on or off SSL session reuse.
`void`	`setNoWaitIfBusy()` Method calls will throw an exception if the connection is busy.
`void`	`setNsClientMaxPort(int port)` Method Set the maximum nameserver client port
`void`	`setNsClientMinPort(int port)` Method Set the minimum nameserver client port
`void`	`setNsClientPicklistSize(int nPicklistSize)` Method sets the number of broker definitions the nameserver client should retrieve from the nameserver each time
`void`	`setNsClientPortRetry(int nRetries)` Method sets the number of times the nameserver client should retry connecting to the nameserver
`void`	`setNsClientPortRetryInterval(int nSeconds)` Method sets the number of seconds the nameserver client should wait between retrying to connect to the nameserver
`void`	`setPassword(java.lang.String password)`
`void`	`setPostponeRelationInfo(boolean value)` Method sets the behavior for whether the relational info is built when loading the ProDataGraph's data.
`void`	`setProperties(java.util.Properties props)`
`void`	`setProperty(java.lang.String propName, java.lang.Object propValue)`
`void`	`setProxyHost(java.lang.String host)` Method Set the proxy host.
`void`	`setProxyPassword(java.lang.String pwd)` Method Set the proxy user-id's password.
`void`	`setProxyPort(int port)` Method Set the proxy port.
`void`	`setProxyUserId(java.lang.String userId)` Method Set the proxy user id.
`void`	`setRequestWaitTimeout(int nRqWaitSec)` Method sets the number of seconds the client should wait for a connection to become available to run a request
`void`	`setServerName(java.lang.String servername)`
`void`	`setSessionModel(int model)` Method Set the sessionModel
`void`	`setSslCiphers(java.lang.String ciphers)` set SSL ciphers.
`void`	`setSslVersions(java.lang.String version)` set ssl protocol versions.
`java.lang.Object`	`setStringProperty(java.lang.String propName, java.lang.String propValue)`
`void`	`setTraceLevel(int traceLevel)` Method sets the traceLevel
`void`	`setUrl(java.lang.String url)`
`void`	`setUseDeprecatedGetChanges(boolean value)` Method sets the behavior for whether you want to want to use the original/deprecated ProChangeSummary.getChanges() functionality or current functionality
`void`	`setUserId(java.lang.String userid)`
`void`	`setUUID(java.lang.String uuid)` Method sets the uuid
`void`	`setWaitIfBusy()` Method calls will wait if the connection is busy.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Connection
```
public Connection()
```
  - Connection
```
public Connection(Connection parent,
                  boolean multiUser)
```
  - Connection
```
public Connection(Connection parent)
```
  - Connection
```
public Connection(java.lang.String urlString,
                  java.lang.String userId,
                  java.lang.String password,
                  java.lang.String appServerInfo)
```
  - Connection
```
public Connection(java.lang.String urlString,
                  java.lang.String userId,
                  java.lang.String password,
                  java.lang.String appServerInfo,
                  boolean multiUser)
```
  - Connection
```
public Connection(java.lang.String userId,
                  java.lang.String password,
                  java.lang.String appServerInfo)
```
  - Connection
```
public Connection(java.lang.String userId,
                  java.lang.String password,
                  java.lang.String appServerInfo,
                  boolean multiUser)
```
- Method Detail
  - getSessionPool
```
public SessionPool getSessionPool()
```
    Specified by:
    
    getSessionPool in interface IPoolProps
  - addReference
```
public void addReference(SessionPool sessionPool)
```
    Specified by:
    
    addReference in interface IPoolProps
  - releaseConnection
```
public void releaseConnection()
                       throws Open4GLException
```
    Specified by:
    
    releaseConnection in interface IPoolProps
    
    Throws:
    
    Open4GLException
  - close
```
public void close()
```
    release the connection. This is here to support AutoCloseable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - setLocalProperty
```
public void setLocalProperty(java.lang.String propName,
                             java.lang.Object propValue)
```
    Specified by:
    
    setLocalProperty in interface IPoolProps
  - setProperty
```
public void setProperty(java.lang.String propName,
                        java.lang.Object propValue)
```
    Specified by:
    
    setProperty in interface IPoolProps
  - setStringProperty
```
public java.lang.Object setStringProperty(java.lang.String propName,
                                          java.lang.String propValue)
```
    Specified by:
    
    setStringProperty in interface IPoolProps
  - setIntProperty
```
public java.lang.Object setIntProperty(java.lang.String propName,
                                       int propValue)
```
    Specified by:
    
    setIntProperty in interface IPoolProps
  - setLongProperty
```
public java.lang.Object setLongProperty(java.lang.String propName,
                                        long propValue)
```
    Specified by:
    
    setLongProperty in interface IPoolProps
  - setBooleanProperty
```
public java.lang.Object setBooleanProperty(java.lang.String propName,
                                           boolean propValue)
```
    Specified by:
    
    setBooleanProperty in interface IPoolProps
  - getProperty_prev
```
public java.lang.Object getProperty_prev(java.lang.String propName)
```
  - getProperty
```
public java.lang.Object getProperty(java.lang.String propName)
```
    Specified by:
    
    getProperty in interface IPoolProps
  - getStringProperty
```
public java.lang.String getStringProperty(java.lang.String propName)
```
    Specified by:
    
    getStringProperty in interface IPoolProps
  - getIntProperty
```
public int getIntProperty(java.lang.String propName)
```
    Specified by:
    
    getIntProperty in interface IPoolProps
  - getLongProperty
```
public long getLongProperty(java.lang.String propName)
```
    Specified by:
    
    getLongProperty in interface IPoolProps
  - getBooleanProperty
```
public boolean getBooleanProperty(java.lang.String propName)
```
    Specified by:
    
    getBooleanProperty in interface IPoolProps
  - setProperties
```
public void setProperties(java.util.Properties props)
```
  - getProperties
```
@Deprecated
public java.util.Hashtable getProperties()
```
    Deprecated. Use IPoolProps.getAsProperties() instead. Hashtable is an old java 1.1 style class and should no longer be used.
    
    Fetch a copy of the internal properties of this connection. Changes to the returned Hashtable will not be reflected in the connection object. Use the setter functions to affect changes in this object.
    
    Returns:
    
    a hashtable containing a copy of all the properties stored in this connection
  - getUrl
```
public java.lang.String getUrl()
```
  - setUrl
```
public void setUrl(java.lang.String url)
```
  - getUserId
```
public java.lang.String getUserId()
```
  - setUserId
```
public void setUserId(java.lang.String userid)
```
  - getPassword
```
public java.lang.String getPassword()
```
  - setPassword
```
public void setPassword(java.lang.String password)
```
  - getAppServerInfo
```
public java.lang.String getAppServerInfo()
```
  - setAppServerInfo
```
public void setAppServerInfo(java.lang.String appServerInfo)
```
  - getWaitIfBusy
```
public boolean getWaitIfBusy()
```
    Returns the current "Wait If Busy" setup. Returns false by default or if setNoWaitIfBusy() was called. Returns true if setWaitIfBusy() was called.
    
    See Also:
    
    setWaitIfBusy(), setNoWaitIfBusy()
  - setWaitIfBusy
```
public void setWaitIfBusy()
```
    Method calls will wait if the connection is busy. If setWaitIfBusy() was called then a request to execute a method in an Application Object, a subApplication Object or a Procedure Object will wait until the connection is not busy. The connection is busy while another method is executing or while there is an open output result set. By default, setNoWaitIfBusy() is on (a BusySessionException method is thrown).
    
    See Also:
    
    setNoWaitIfBusy()
  - setNoWaitIfBusy
```
public void setNoWaitIfBusy()
```
    Method calls will throw an exception if the connection is busy. If setNoWaitIfBusy() was called then A BusySessionException will be thrown for an attempt to execute a method while the connection is busy.
    
    See Also:
    
    setWaitIfBusy()
  - getProxyHost
```
public java.lang.String getProxyHost()
```
    Method Returns the proxy host
    
    Returns:
    
    Proxy host
  - setProxyHost
```
public void setProxyHost(java.lang.String host)
                  throws Open4GLException
```
    Method Set the proxy host. Used if a proxy server is known to be in between the Open Client and the Internet.
    
    Parameters:
    
    host - The host name
    
    Throws:
    
    Open4GLException
  - getProxyPort
```
public int getProxyPort()
```
    Method Returns the proxy port
    
    Returns:
    
    Proxy port
  - setProxyPort
```
public void setProxyPort(int port)
                  throws Open4GLException
```
    Method Set the proxy port. Used if a proxy server is known to be in between the Open Client and the Internet.
    
    Parameters:
    
    port - The port number
    
    Throws:
    
    Open4GLException
  - getCertificateStore
```
public java.lang.String getCertificateStore()
```
    Method Returns the certicate store list
    
    Returns:
    
    The certicate store list as a comma separated string of directory/file values.
  - setCertificateStore
```
public void setCertificateStore(java.lang.String certStoreList)
                         throws Open4GLException
```
    Method Set the CertificateStore. Allows the developer to specify storage locations for digital certificates. These are used when the AppServer connect URL uses the https protocol.
    
    Parameters:
    
    certStoreList - Directory and/or file name[s]. If more than one directory/file is specified then the list will be separated by semi-colons. The format of the parameter is <file>:password and/or <directory>:password. Password may have the word 'null' in place of an actual password.
    
    Throws:
    
    Open4GLException
  - getNoHostVerify
```
public boolean getNoHostVerify()
```
    Method returns the optional HTTPS (SSL) server domain authentication . option value.
    
    Returns:
    
    The boolean value HTTP/S authentication bitmask
  - setNoHostVerify
```
public void setNoHostVerify(boolean trueFalseState)
                     throws Open4GLException
```
    Method sets the optional HTTPS (SSL) server domain authentication option.
    
    Parameters:
    
    trueFalseState - The boolean value that holds the new authentication state.
    
    Throws:
    
    Open4GLException
  - getNoSslSessionReuse
```
public boolean getNoSslSessionReuse()
```
    Get the current state of SSL session reuse.
    
    Returns:
    
    a boolean value
  - setNoSslSessionReuse
```
public void setNoSslSessionReuse(boolean trueFalseState)
                          throws Open4GLException
```
    Turns on or off SSL session reuse.
    
    Parameters:
    
    trueFalseState - a boolean value
    
    Throws:
    
    Open4GLException - if an error occurs
  - setServerName
```
public void setServerName(java.lang.String servername)
```
    Parameters:
    
    servername - is set the server name indiication .
  - getServerName
```
public java.lang.String getServerName()
```
    Returns:
    
    String SNI name
  - setSslVersions
```
public void setSslVersions(java.lang.String version)
```
    set ssl protocol versions.
    
    Parameters:
    
    version - a String value
  - getSslVersions
```
public java.lang.String getSslVersions()
```
    Method Returns SSL protocol versions
    
    Returns:
    
    String SSL version
  - setSslCiphers
```
public void setSslCiphers(java.lang.String ciphers)
```
    set SSL ciphers.
    
    Parameters:
    
    ciphers - a String value
  - getSslCiphers
```
public java.lang.String getSslCiphers()
```
    Method Returns SSL ciphers list
    
    Returns:
    
    String SSL ciphers
  - getProxyUserId
```
public java.lang.String getProxyUserId()
```
    Method Returns the proxy authentication user-id
    
    Returns:
    
    String user-id
  - setProxyUserId
```
public void setProxyUserId(java.lang.String userId)
                    throws Open4GLException
```
    Method Set the proxy user id. Used if a proxy server is known to be in between the Open Client and the Internet and it requires HTTP Basic authentication.
    
    Parameters:
    
    userId - The userId for authentication
    
    Throws:
    
    Open4GLException
  - getProxyPassword
```
public java.lang.String getProxyPassword()
```
    Method Returns the proxy authentication password
    
    Returns:
    
    String user-id's password
  - setProxyPassword
```
public void setProxyPassword(java.lang.String pwd)
                      throws Open4GLException
```
    Method Set the proxy user-id's password. Used if a proxy server is known to be in between the Open Client and the Internet and it requires HTTP Basic authentication.
    
    Parameters:
    
    pwd - The user-id password for authentication
    
    Throws:
    
    Open4GLException
  - getSessionModel
```
public int getSessionModel()
```
    Method Returns the session model
    
    Returns:
    
    int session model
  - setSessionModel
```
public void setSessionModel(int model)
```
    Method Set the sessionModel
    
    Parameters:
    
    model - The sessionModel
  - getInitialConnections
```
public int getInitialConnections()
```
    Method Returns the number of initial connections to be made
    
    Returns:
    
    int initialConnections
  - setInitialConnections
```
public void setInitialConnections(int nConnections)
```
    Method Set the number of initial connections to be made
    
    Parameters:
    
    nConnections - number of connections
  - getMinConnections
```
public int getMinConnections()
```
    Method Returns the minimum number of connections to be made
    
    Returns:
    
    int minConnections
  - setMinConnections
```
public void setMinConnections(int nMinConnections)
```
    Method Set the minimum number of connections to be made
    
    Parameters:
    
    nMinConnections - minimum number of connections
  - getMaxConnections
```
public int getMaxConnections()
```
    Method Returns the maximum number of connections to be made
    
    Returns:
    
    int maxConnections
  - setMaxConnections
```
public void setMaxConnections(int nMaxConnections)
```
    Method Set the maximum number of connections to be made
    
    Parameters:
    
    nMaxConnections - maximum number of connections
  - getIdleConnectionTimeout
```
public int getIdleConnectionTimeout()
```
    Method Returns the Idle Connection Timeout
    
    Returns:
    
    int idleConnectionTimeout
  - setIdleConnectionTimeout
```
public void setIdleConnectionTimeout(int nSeconds)
```
    Method Set the Idle Connection Timeout
    
    Parameters:
    
    nSeconds - Idle Connection Timeout
  - getConnectionLifetime
```
public int getConnectionLifetime()
```
    Method Returns the connection lifetime
    
    Returns:
    
    int connectionLifetime
  - setConnectionLifetime
```
public void setConnectionLifetime(int nSeconds)
```
    Method Set the connection lifetime
    
    Parameters:
    
    nSeconds - connectionLifetime
  - getNsClientMinPort
```
public int getNsClientMinPort()
```
    Method Returns the minimum nameserver client port
    
    Returns:
    
    int nsClientMinPort
  - setNsClientMinPort
```
public void setNsClientMinPort(int port)
```
    Method Set the minimum nameserver client port
    
    Parameters:
    
    port - port number
  - getNsClientMaxPort
```
public int getNsClientMaxPort()
```
    Method Returns the maximum nameserver client port
    
    Returns:
    
    int nsClientMaxPort
  - setNsClientMaxPort
```
public void setNsClientMaxPort(int port)
```
    Method Set the maximum nameserver client port
    
    Parameters:
    
    port - port number
  - getNsClientPortRetry
```
public int getNsClientPortRetry()
```
    Method Returns the number of times the nameserver client should retry connecting to the nameserver
    
    Returns:
    
    int nRetries
  - setNsClientPortRetry
```
public void setNsClientPortRetry(int nRetries)
```
    Method sets the number of times the nameserver client should retry connecting to the nameserver
    
    Parameters:
    
    nRetries - number of retries
  - getNsClientPortRetryInterval
```
public int getNsClientPortRetryInterval()
```
    Method Returns the number of seconds the nameserver client should wait between retrying to connect to the nameserver
    
    Returns:
    
    int nSeconds
  - setNsClientPortRetryInterval
```
public void setNsClientPortRetryInterval(int nSeconds)
```
    Method sets the number of seconds the nameserver client should wait between retrying to connect to the nameserver
    
    Parameters:
    
    nSeconds - number of seconds
  - getNsClientPicklistSize
```
public int getNsClientPicklistSize()
```
    Method Returns the number of broker definitions the nameserver client should retrieve from the nameserver each time
    
    Returns:
    
    int nPickListSize
  - setNsClientPicklistSize
```
public void setNsClientPicklistSize(int nPicklistSize)
```
    Method sets the number of broker definitions the nameserver client should retrieve from the nameserver each time
    
    Parameters:
    
    nPicklistSize - number of brokers
  - getRequestWaitTimeout
```
public int getRequestWaitTimeout()
```
    Method Returns the number of seconds the client should wait for a connection to become available to run a request
    
    Returns:
    
    int nRqWaitSec
  - setRequestWaitTimeout
```
public void setRequestWaitTimeout(int nRqWaitSec)
```
    Method sets the number of seconds the client should wait for a connection to become available to run a request
    
    Parameters:
    
    nRqWaitSec - number of seconds
  - getUUID
```
public java.lang.String getUUID()
```
    Method Returns the uuid
    
    Returns:
    
    String uuid
  - setUUID
```
public void setUUID(java.lang.String uuid)
```
    Method sets the uuid
    
    Parameters:
    
    uuid - the unique uuid
  - getLogfileName
```
public java.lang.String getLogfileName()
```
    Method Returns the logfileName
    
    Returns:
    
    String logfileName
  - setLogfileName
```
public void setLogfileName(java.lang.String logfileName)
```
    Method sets the logfileName
    
    Parameters:
    
    logfileName - the logfileName
  - getTraceLevel
```
public int getTraceLevel()
```
    Method Returns the trace level
    
    Returns:
    
    int traceLevel
  - setTraceLevel
```
public void setTraceLevel(int traceLevel)
```
    Method sets the traceLevel
    
    Parameters:
    
    traceLevel - the trace level
  - getLogEntryTypes
```
public java.lang.String getLogEntryTypes()
```
    Method Returns the log entry types
    
    Returns:
    
    string logEntryTypes
  - setLogEntryTypes
```
public void setLogEntryTypes(java.lang.String logEntryTypes)
```
    Method sets the logEntryTypes
    
    Parameters:
    
    logEntryTypes - the log entry types
  - getAppServerKeepalive
```
public java.lang.String getAppServerKeepalive()
```
    Method Returns the Keep Alive Capabilities setting
    
    Returns:
    
    String keepAliveCaps
  - setAppServerKeepalive
```
public void setAppServerKeepalive(java.lang.String keepAliveCap)
```
    Method sets the keep Alive Capabilities value
    
    Parameters:
    
    keepAliveCap - the keep alive value
  - getClientASKActivityTimeout
```
public int getClientASKActivityTimeout()
```
    Method Returns the client Keep Alive activity timeout
    
    Returns:
    
    String keepAliveActTimeout
  - setClientASKActivityTimeout
```
public void setClientASKActivityTimeout(int keepAliveActTimeout)
```
    Method sets the client Keep Alive activity timeout
    
    Parameters:
    
    keepAliveActTimeout - the client keep alive activity timeout
  - getClientASKResponseTimeout
```
public int getClientASKResponseTimeout()
```
    Method Returns the client Keep Alive response timeout
    
    Returns:
    
    String keepAliveRespTimeout
  - setClientASKResponseTimeout
```
public void setClientASKResponseTimeout(int keepAliveRespTimeout)
```
    Method sets the client Keep Alive Response Timeout
    
    Parameters:
    
    keepAliveRespTimeout - the client keep alive response timeout
  - setDatasetNullInitials
```
public void setDatasetNullInitials(boolean value)
```
    Method sets the behavior for initial values for int/int64/boolean fields on a dataset Must be set before building ProDataObjectMetaData object.
    
    Parameters:
    
    value - True if wants to change default behavior and have integer, int64 and boolean fields on a dataset to initialize to null.
  - getDatasetNullInitials
```
public boolean getDatasetNullInitials()
```
    Method gets the dataset null initials setting
    
    Returns:
    
    boolean datasetSetNullInitials
  - setPostponeRelationInfo
```
public void setPostponeRelationInfo(boolean value)
```
    Method sets the behavior for whether the relational info is built when loading the ProDataGraph's data.
    
    Parameters:
    
    value - True if wants to change default behavior and postpone building the relational info until getChildRows() is called for a particular ProDataObject
  - getPostponeRelationInfo
```
public boolean getPostponeRelationInfo()
```
    Method gets whether the behavior for whether the relational info is built when loading the ProDataGraph's data. If true, building relational info is postponed until getChildRows(). When getChildRows() is called, the child rows for this particular row are hooked up (referenced)
    
    Returns:
    
    boolean postponeRelationInfo
  - setUseDeprecatedGetChanges
```
public void setUseDeprecatedGetChanges(boolean value)
```
    Method sets the behavior for whether you want to want to use the original/deprecated ProChangeSummary.getChanges() functionality or current functionality
    
    Parameters:
    
    value - True if you want to use the original/deprecated ProChangeSummary.getChanges() functionality. It's defaulted to False.
  - getUseDeprecatedGetChanges
```
public boolean getUseDeprecatedGetChanges()
```
    Method Returns true if the functionality of ProChangeSummary.getChanges() has been reverted to the original/deprecated functionality, or false if it performs the current (default) functionality.
    
    Returns:
    
    boolean useDeprecatedGetChanges
  - getCompressionEnabled
```
public boolean getCompressionEnabled()
```
    Returns true if compression is enabled for this connection
    
    Returns:
  - getCompressionLevel
```
public int getCompressionLevel()
```
    Returns the compression level set for this connection
    
    Returns:
  - getCompressionThreshold
```
public int getCompressionThreshold()
```
    returns the minimum size in bytes of the message body before compression will be done for a particular message.
    
    Returns:
  - setCompressionEnabled
```
public void setCompressionEnabled(boolean enabled)
```
    Enable message body compression
    
    Parameters:
    
    enabled -
  - setCompressionThreshold
```
public void setCompressionThreshold(int threshold)
```
    Set the minimum size in bytes for messages before compression is used on the message body. Minimum value is 256.
    
    Parameters:
    
    threshold -
  - setCompressionLevel
```
public void setCompressionLevel(int level)
```
    Set the compression level used to compress messages. Valid values are 1 - 9 inclusive.
    
    Parameters:
    
    level -
  - getRemoteMajorVersion
```
public java.lang.String getRemoteMajorVersion()
```
    Method get the remote major version
    
    Returns:
    
    majorVersion
  - getRemoteMinorVersion
```
public java.lang.String getRemoteMinorVersion()
```
    Method get the remote minor version
    
    Returns:
    
    minorVersion
  - getRemoteMaintVersion
```
public java.lang.String getRemoteMaintVersion()
```
    Method get the remote maint version
    
    Returns:
    
    maintVersion
  - getRemoteVersionInfo
```
public OEVersionInfo getRemoteVersionInfo()
```
  - getLocalMajorVersion
```
public java.lang.String getLocalMajorVersion()
```
    Method get the local major version
    
    Returns:
    
    majorVersion
  - getLocalMinorVersion
```
public java.lang.String getLocalMinorVersion()
```
    Method get the local minor version
    
    Returns:
    
    minorVersion
  - getLocalMaintVersion
```
public java.lang.String getLocalMaintVersion()
```
    Method get the local maint version
    
    Returns:
    
    maintVersion
  - getLocalVersionInfo
```
public OEVersionInfo getLocalVersionInfo()
```
  - setClientContextID
```
public void setClientContextID(java.lang.String clientContextID)
```
    Method set the clientContextID
    
    Parameters:
    
    clientContextID -
  - getClientContextID
```
public java.lang.String getClientContextID()
```
    Method get the clientContextID
  - getClientType
```
public int getClientType()
```
    Method get the client type
  - setClientType
```
public void setClientType(int clientType)
```
    Method set the client type
    
    Parameters:
    
    clientType -
  - getServerType
```
public int getServerType()
```
    Method get the server type
  - getClientPrincipal
```
public com.progress.auth.ClientPrincipal getClientPrincipal()
```
    Method get the client principal
  - setClientPrincipal
```
public void setClientPrincipal(com.progress.auth.ClientPrincipal clientPrincipal)
```
    Method set the client principal
    
    Parameters:
    
    clientPrincipal -
  - getNetworkBufferSize
```
public int getNetworkBufferSize()
```
    Method get the network buffer size
  - setNetworkBufferSize
```
public void setNetworkBufferSize(int bufferSize)
```
    Method set the network buffer size
    
    Parameters:
    
    bufferSize -
  - getAsProperties
```
public java.util.Properties getAsProperties()
```
    Specified by:
    
    getAsProperties in interface IPoolProps

Class Connection

Field Summary

Fields inherited from interface com.progress.open4gl.dynamicapi.IPoolProps

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Connection

Connection

Connection

Connection

Connection

Connection

Connection

Method Detail

getSessionPool

addReference

releaseConnection

close

setLocalProperty

setProperty

setStringProperty

setIntProperty

setLongProperty

setBooleanProperty

getProperty_prev

getProperty

getStringProperty

getIntProperty

getLongProperty

getBooleanProperty

setProperties

getProperties

getUrl

setUrl

getUserId

setUserId

getPassword

setPassword

getAppServerInfo

setAppServerInfo

getWaitIfBusy

setWaitIfBusy

setNoWaitIfBusy

getProxyHost

setProxyHost

getProxyPort

setProxyPort

getCertificateStore

setCertificateStore

getNoHostVerify

setNoHostVerify

getNoSslSessionReuse

setNoSslSessionReuse

setServerName

getServerName

setSslVersions

getSslVersions

setSslCiphers

getSslCiphers

getProxyUserId

setProxyUserId

getProxyPassword

setProxyPassword

getSessionModel

setSessionModel

getInitialConnections

setInitialConnections

getMinConnections

setMinConnections

getMaxConnections

setMaxConnections

getIdleConnectionTimeout

setIdleConnectionTimeout

getConnectionLifetime

setConnectionLifetime

getNsClientMinPort

setNsClientMinPort

getNsClientMaxPort

setNsClientMaxPort