com.progress.open4gl
Class RunTimeProperties

java.lang.Object
  |
  +--com.progress.open4gl.RunTimeProperties

public class RunTimeProperties

extends java.lang.Object

The RunTimeProperties class has a collection of static methods that control properties for the whole Java client session.

Field Summary

static com.progress.open4gl.dynamicapi.Tracer

tracer

Constructor Summary

RunTimeProperties()

Method Summary

static boolean	getBooleanProperty(java.lang.String propName)
static java.lang.String	getCertificateStore() Method Returns the certicate store list
static int	getConnectionLifetime() Method Returns the connection lifetime
static int	getDynamicApiVersion() Returns the "Dynamic API" version.
static int	getIdleConnectionTimeout() Method Returns the Idle Connection Timeout
static int	getInitialConnections() Method Returns the number of initial connections to be made
static int	getIntProperty(java.lang.String propName)
static java.lang.String	getLogEntryTypes() Method Returns the log entry types
static java.lang.String	getLogfileName() Method Returns the logfileName
static long	getLongProperty(java.lang.String propName)
static int	getMaxConnections() Method Returns the maximum number of connections to be made
static int	getMinConnections() Method Returns the minimum number of connections to be made
static boolean	getNoHostVerify() Method returns the optional HTTPS (SSL) server domain authentication .
static boolean	getNoSslSessionReuse() Get the current state of SSL session reuse.
static int	getNsClientMaxPort() Method Returns the maximum nameserver client port
static int	getNsClientMinPort() Method Returns the minimum nameserver client port
static int	getNsClientPicklistSize() Method Returns the number of broker definitions the nameserver client should retrieve from the nameserver each time
static int	getNsClientPortRetry() Method Returns the number of times the nameserver client should retry connecting to the nameserver
static int	getNsClientPortRetryInterval() Method Returns the number of seconds the nameserver client should wait between retrying to connect to the nameserver
static java.lang.String	getProxyHost() Method Returns the proxy host
static java.lang.String	getProxyPassword() Method Returns the proxy authentication password
static int	getProxyPort() Method Returns the proxy port
static java.lang.String	getProxyUserId() Method Returns the proxy authentication user-id
static int	getRequestWaitTimeout() Method Returns the number of seconds the client should wait for a connection to become available to run a request
static int	getSessionModel() Method Returns the session model
static Connection	getStaticProperties() Method Returns all the static properties
static int	getStreamProtocolVersion() Returns the "Stream Protocol" version.
static java.lang.String	getStringProperty(java.lang.String propName)
static int	getTraceLevel() Method Returns the trace level
static java.lang.String	getUUID() Method Returns the uuid
static boolean	getWaitIfBusy() Returns the current "Wait If Busy" setup.
static boolean	isTracing() Method Returns if tracing is on or not
static void	setBooleanProperty(java.lang.String propName, boolean propValue)
static void	setCertificateStore(java.lang.String certStoreList) Method Set the CertificateStore.
static void	setConnectionLifetime(int nSeconds) Method Set the connection lifetime
static void	setIdleConnectionTimeout(int nSeconds) Method Set the Idle Connection Timeout
static void	setInitialConnections(int nConnections) Method Set the number of initial connections to be made
static void	setIntProperty(java.lang.String propName, int propValue)
static void	setLogEntryTypes(java.lang.String logEntryTypes) Method sets the logEntryTypes
static void	setLogfileName(java.lang.String logfileName) Method sets the logfileName
static void	setLongProperty(java.lang.String propName, long propValue)
static void	setMaxConnections(int nMaxConnections) Method Set the maximum number of connections to be made
static void	setMinConnections(int nMinConnections) Method Set the minimum number of connections to be made
static void	setNoHostVerify(boolean trueFalseState) Method sets the optional HTTPS (SSL) server domain authentication option.
static void	setNoSslSessionReuse(boolean trueFalseState) Turns on or off SSL session reuse.
static void	setNoWaitIfBusy() Method calls will throw an exception if the connection is busy.
static void	setNsClientMaxPort(int port) Method Set the maximum nameserver client port
static void	setNsClientMinPort(int port) Method Set the minimum nameserver client port
static void	setNsClientPicklistSize(int nPicklistSize) Method sets the number of broker definitions the nameserver client should retrieve from the nameserver each time
static void	setNsClientPortRetry(int nRetries) Method sets the number of times the nameserver client should retry connecting to the nameserver
static void	setNsClientPortRetryInterval(int nSeconds) Method sets the number of seconds the nameserver client should wait between retrying to connect to the nameserver
static void	setProxyHost(java.lang.String host) Method Set the proxy host.
static void	setProxyPassword(java.lang.String pwd) Method Set the proxy user-id's password.
static void	setProxyPort(int port) Method Set the proxy port.
static void	setProxyUserId(java.lang.String userId) Method Set the proxy user id.
static void	setRequestWaitTimeout(int nRqWaitSec) Method sets the number of seconds the client should wait for a connection to become available to run a request
static void	setSessionModel(int model) Method Set the sessionModel
static void	setStringProperty(java.lang.String propName, java.lang.String propValue) Method Set the specified property
static void	setTraceLevel(int traceLevel) Method sets the traceLevel
static void	setUUID(java.lang.String uuid) Method sets the uuid
static void	setWaitIfBusy() Method calls will wait if the connection is busy.
static void	traceOff() Method Turns tracing off
static void	traceOn() Method Turns tracing on with default tracing level.
static void	traceOn(int level) Method Turns tracing on with specified tracing level.
static void	traceOn(java.lang.String fileName) Method Turns tracing on to a specified file with the default tracing level.
static void	traceOn(java.lang.String fileName, int level) Method Turns tracing on to a specified file with the specified tracing level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

tracer

public static final com.progress.open4gl.dynamicapi.Tracer tracer

Constructor Detail

RunTimeProperties

public RunTimeProperties()

Method Detail

getBooleanProperty

public static boolean getBooleanProperty(java.lang.String propName)

getCertificateStore

public static java.lang.String getCertificateStore()

Method Returns the certicate store list

Returns:

The certicate store list as a comma separated string of directory/file values.

getConnectionLifetime

public static int getConnectionLifetime()

Method Returns the connection lifetime

Returns:

int connectionLifetime

getDynamicApiVersion

public static int getDynamicApiVersion()

Returns the "Dynamic API" version. Returns the version of the "Runtime Java Client" (the Dynamic API) - The API of the Java classes that must be present on every Java client platform together with the ProxyGen generated proxies.

getIdleConnectionTimeout

public static int getIdleConnectionTimeout()

Method Returns the Idle Connection Timeout

Returns:

int idleConnectionTimeout

getInitialConnections

public static int getInitialConnections()

Method Returns the number of initial connections to be made

Returns:

int initialConnections

getIntProperty

public static int getIntProperty(java.lang.String propName)

getLogEntryTypes

public static java.lang.String getLogEntryTypes()

Method Returns the log entry types

Returns:

string logEntryTypes

getLogfileName

public static java.lang.String getLogfileName()

Method Returns the logfileName

Returns:

String logfileName

getLongProperty

public static long getLongProperty(java.lang.String propName)

getMaxConnections

public static int getMaxConnections()

Method Returns the maximum number of connections to be made

Returns:

int maxConnections

getMinConnections

public static int getMinConnections()

Method Returns the minimum number of connections to be made

Returns:

int minConnections

getNoHostVerify

public static boolean getNoHostVerify()

Method returns the optional HTTPS (SSL) server domain authentication . option value.

Returns:

The boolean value HTTP/S authentication bitmask

getNoSslSessionReuse

public static boolean getNoSslSessionReuse()

Get the current state of SSL session reuse.

Returns:

a boolean value

getNsClientMaxPort

public static int getNsClientMaxPort()

Method Returns the maximum nameserver client port

Returns:

int nsClientMaxPort

getNsClientMinPort

public static int getNsClientMinPort()

Method Returns the minimum nameserver client port

Returns:

int nsClientMinPort

getNsClientPicklistSize

public static int getNsClientPicklistSize()

Method Returns the number of broker definitions the nameserver client should retrieve from the nameserver each time

Returns:

int nPickListSize

getNsClientPortRetry

public static int getNsClientPortRetry()

Method Returns the number of times the nameserver client should retry connecting to the nameserver

Returns:

int nRetries

getNsClientPortRetryInterval

public static int getNsClientPortRetryInterval()

Method Returns the number of seconds the nameserver client should wait between retrying to connect to the nameserver

Returns:

int nSeconds

getProxyHost

public static java.lang.String getProxyHost()

Method Returns the proxy host

Returns:

Proxy host

getProxyPassword

public static java.lang.String getProxyPassword()

Method Returns the proxy authentication password

Returns:

String user-id's password

getProxyPort

public static int getProxyPort()

Method Returns the proxy port

Returns:

Proxy port

getProxyUserId

public static java.lang.String getProxyUserId()

Method Returns the proxy authentication user-id

Returns:

String user-id

getRequestWaitTimeout

public static 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

getSessionModel

public static int getSessionModel()

Method Returns the session model

Returns:

int session model

getStaticProperties

public static Connection getStaticProperties()

Method Returns all the static properties

Returns:

Connection properties

getStreamProtocolVersion

public static int getStreamProtocolVersion()

Returns the "Stream Protocol" version. Returns the version of the "Stream Protocol" the client uses to talk to the AppServer.

getStringProperty

public static java.lang.String getStringProperty(java.lang.String propName)

getTraceLevel

public static int getTraceLevel()

Method Returns the trace level

Returns:

int traceLevel

getUUID

public static java.lang.String getUUID()

Method Returns the uuid

Returns:

String uuid

getWaitIfBusy

public static 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()

isTracing

public static boolean isTracing()

Method Returns if tracing is on or not

Returns:

true if tracing is on, false otherwise.

setBooleanProperty

public static void setBooleanProperty(java.lang.String propName,
                                      boolean propValue)

setCertificateStore

public static 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 ":password". Password may have the word 'null' in place of an actual password.

Open4GLException

setConnectionLifetime

public static void setConnectionLifetime(int nSeconds)

Method Set the connection lifetime

Parameters:

nSeconds - connectionLifetime

setIdleConnectionTimeout

public static void setIdleConnectionTimeout(int nSeconds)

Method Set the Idle Connection Timeout

Parameters:

nSeconds - Idle Connection Timeout

setInitialConnections

public static void setInitialConnections(int nConnections)

Method Set the number of initial connections to be made

Parameters:

nConnections - number of connections

setIntProperty

public static void setIntProperty(java.lang.String propName,
                                  int propValue)

setLogEntryTypes

public static void setLogEntryTypes(java.lang.String logEntryTypes)

Method sets the logEntryTypes

Parameters:

logEntryTypes - the log entry types

setLogfileName

public static void setLogfileName(java.lang.String logfileName)

Method sets the logfileName

Parameters:

logfileName - the logfileName

setLongProperty

public static void setLongProperty(java.lang.String propName,
                                   long propValue)

setMaxConnections

public static void setMaxConnections(int nMaxConnections)

Method Set the maximum number of connections to be made

Parameters:

nMaxConnections - maximum number of connections

setMinConnections

public static void setMinConnections(int nMinConnections)

Method Set the minimum number of connections to be made

Parameters:

nMinConnections - minimum number of connections

setNoHostVerify

public static 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.

Open4GLException

setNoSslSessionReuse

public static void setNoSslSessionReuse(boolean trueFalseState)
                                 throws Open4GLException

Turns on or off SSL session reuse.

Parameters:

trueFalseState - a boolean value

Throws:

Open4GLException - if an error occurs

setNoWaitIfBusy

public static 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()

setNsClientMaxPort

public static void setNsClientMaxPort(int port)

Method Set the maximum nameserver client port

Parameters:

port - port number

setNsClientMinPort

public static void setNsClientMinPort(int port)

Method Set the minimum nameserver client port

Parameters:

port - port number

setNsClientPicklistSize

public static void setNsClientPicklistSize(int nPicklistSize)

Method sets the number of broker definitions the nameserver client should retrieve from the nameserver each time

setNsClientPortRetry

public static void setNsClientPortRetry(int nRetries)

Method sets the number of times the nameserver client should retry connecting to the nameserver

Parameters:

nRetries - number of retries

setNsClientPortRetryInterval

public static 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

setProxyHost

public static 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

Open4GLException

setProxyPassword

public static 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

Open4GLException

setProxyPort

public static 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

Open4GLException

setProxyUserId

public static 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

Open4GLException

setRequestWaitTimeout

public static 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

setSessionModel

public static void setSessionModel(int model)

Method Set the sessionModel

Parameters:

model - The sessionModel

setStringProperty

public static void setStringProperty(java.lang.String propName,
                                     java.lang.String propValue)

Method Set the specified property

Parameters:

propName - the name of the property to be set

propValue - the value of the property to be set

setTraceLevel

public static void setTraceLevel(int traceLevel)

Method sets the traceLevel

Parameters:

traceLevel - the trace level

setUUID

public static void setUUID(java.lang.String uuid)

Method sets the uuid

setWaitIfBusy

public static 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()

traceOff

public static void traceOff()

Method Turns tracing off

traceOn

public static void traceOn()

Method Turns tracing on with default tracing level.

traceOn

public static void traceOn(int level)

Method Turns tracing on with specified tracing level.

Parameters:

level - The tracing level. The higher the level, the more tracing is output.

traceOn

public static void traceOn(java.lang.String fileName)

Method Turns tracing on to a specified file with the default tracing level.

Parameters:

fileName - The file to write trace information to

traceOn

public static void traceOn(java.lang.String fileName,
                           int level)

Method Turns tracing on to a specified file with the specified tracing level.

Parameters:

fileName - The file to write trace information to

level - The tracing level. The higher the level, the more tracing is output.