Package com.progress.open4gl

Class RunTimeProperties

java.lang.Object
com.progress.open4gl.RunTimeProperties
public class RunTimeProperties extends Object
The RunTimeProperties class has a collection of static methods that control properties for the whole Java client session.

  • Field Details

    • tracer

      public static final Tracer tracer

  • Constructor Details

    • RunTimeProperties

      public RunTimeProperties()

  • Method Details

    • 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.

    • 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.

    • 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(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(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.

    • traceOff

      public static void traceOff()
      Method Turns tracing off

    • isTracing

      public static boolean isTracing()
      Method Returns if tracing is on or not
      Returns:
      true if tracing is on, false otherwise.

    • 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

      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:

    • 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:

    • setProxyHost

      public static void setProxyHost(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

    • getProxyHost

      public static String getProxyHost()
      Method Returns the proxy host
      Returns:
      Proxy host

    • 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
      Throws:
      Open4GLException

    • getProxyPort

      public static int getProxyPort()
      Method Returns the proxy port
      Returns:
      Proxy port

    • setCertificateStore

      public static void setCertificateStore(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 <path>/file:password and/or <directory path>:password. Password may have the word 'null' in place of an actual password.
      Throws:
      Open4GLException

    • getCertificateStore

      public static String getCertificateStore()
      Method Returns the certicate store list
      Returns:
      The certicate store list as a comma separated string of directory/file values.

    • 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.
      Throws:
      Open4GLException

    • getNoHostVerify

      public static boolean getNoHostVerify()
      Method returns the optional HTTPS (SSL) server domain authentication . option value.
      Returns:
      The boolean value HTTP/S authentication bitmask

    • 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

    • getNoSslSessionReuse

      public static boolean getNoSslSessionReuse()
      Get the current state of SSL session reuse.
      Returns:
      a boolean value

    • setProxyUserId

      public static void setProxyUserId(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

    • getProxyUserId

      public static String getProxyUserId()
      Method Returns the proxy authentication user-id
      Returns:
      String user-id

    • setProxyPassword

      public static void setProxyPassword(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

    • getProxyPassword

      public static String getProxyPassword()
      Method Returns the proxy authentication password
      Returns:
      String user-id's password

    • getSessionModel

      public static int getSessionModel()
      Method Returns the session model
      Returns:
      int session model

    • setSessionModel

      public static void setSessionModel(int model)
      Method Set the sessionModel
      Parameters:
      model - The sessionModel

    • getInitialConnections

      public static int getInitialConnections()
      Method Returns the number of initial connections to be made
      Returns:
      int initialConnections

    • setInitialConnections

      public static void setInitialConnections(int nConnections)
      Method Set the number of initial connections to be made
      Parameters:
      nConnections - number of connections

    • getMinConnections

      public static int getMinConnections()
      Method Returns the minimum number of connections to be made
      Returns:
      int minConnections

    • setMinConnections

      public static void setMinConnections(int nMinConnections)
      Method Set the minimum number of connections to be made
      Parameters:
      nMinConnections - minimum number of connections

    • getMaxConnections

      public static int getMaxConnections()
      Method Returns the maximum number of connections to be made
      Returns:
      int maxConnections

    • setMaxConnections

      public static void setMaxConnections(int nMaxConnections)
      Method Set the maximum number of connections to be made
      Parameters:
      nMaxConnections - maximum number of connections

    • getIdleConnectionTimeout

      public static int getIdleConnectionTimeout()
      Method Returns the Idle Connection Timeout
      Returns:
      int idleConnectionTimeout

    • setIdleConnectionTimeout

      public static void setIdleConnectionTimeout(int nSeconds)
      Method Set the Idle Connection Timeout
      Parameters:
      nSeconds - Idle Connection Timeout

    • getConnectionLifetime

      public static int getConnectionLifetime()
      Method Returns the connection lifetime
      Returns:
      int connectionLifetime

    • setConnectionLifetime

      public static void setConnectionLifetime(int nSeconds)
      Method Set the connection lifetime
      Parameters:
      nSeconds - connectionLifetime

    • getNsClientMinPort

      public static int getNsClientMinPort()
      Method Returns the minimum nameserver client port
      Returns:
      int nsClientMinPort

    • setNsClientMinPort

      public static void setNsClientMinPort(int port)
      Method Set the minimum nameserver client port
      Parameters:
      port - port number

    • getNsClientMaxPort

      public static int getNsClientMaxPort()
      Method Returns the maximum nameserver client port
      Returns:
      int nsClientMaxPort

    • setNsClientMaxPort

      public static void setNsClientMaxPort(int port)
      Method Set the maximum nameserver client port
      Parameters:
      port - port number

    • getNsClientPortRetry

      public static int getNsClientPortRetry()
      Method Returns the number of times the nameserver client should retry connecting to the nameserver
      Returns:
      int nRetries

    • 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

    • 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

    • 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

    • 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

    • setNsClientPicklistSize

      public static void setNsClientPicklistSize(int pickListSize)
      Method sets the number of broker definitions the nameserver client should retrieve from the nameserver each time
      Parameters:
      pickListSize - number of brokers

    • 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

    • 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

    • getUUID

      public static String getUUID()
      Method Returns the uuid
      Returns:
      String uuid

    • setUUID

      public static void setUUID(String uuid)
      Method sets the uuid
      Parameters:
      uuid - the unique uuid

    • getLogfileName

      public static String getLogfileName()
      Method Returns the logfileName
      Returns:
      String logfileName

    • setLogfileName

      public static void setLogfileName(String logfileName)
      Method sets the logfileName
      Parameters:
      logfileName - the logfileName

    • getTraceLevel

      public static int getTraceLevel()
      Method Returns the trace level
      Returns:
      int traceLevel

    • setTraceLevel

      public static void setTraceLevel(int traceLevel)
      Method sets the traceLevel
      Parameters:
      traceLevel - the trace level

    • getLogEntryTypes

      public static String getLogEntryTypes()
      Method Returns the log entry types
      Returns:
      string logEntryTypes

    • setLogEntryTypes

      public static void setLogEntryTypes(String logEntryTypes)
      Method sets the logEntryTypes
      Parameters:
      logEntryTypes - the log entry types

    • getAppServerKeepalive

      public static String getAppServerKeepalive()
      Method gets the AppServer Keepalive capabilities value
      Returns:
      string KeepaliveCap

    • setAppServerKeepalive

      public static void setAppServerKeepalive(String AppServerKeepalive)
      Method sets the AppServer Keepalive value
      Parameters:
      AppServerKeepalive - the keepalive value

    • getClientASKActivityTimeout

      public static int getClientASKActivityTimeout()
      Method gets the AppServer client Keepalive Activity Timeout
      Returns:
      string KeepaliveActTimeout

    • setClientASKActivityTimeout

      public static void setClientASKActivityTimeout(int AppServerKeepaliveTimeout)
      Method sets the AppServer client Keepalive Activity Timeout
      Parameters:
      AppServerKeepaliveTimeout - the keepalive timeout value

    • getClientASKResponseTimeout

      public static int getClientASKResponseTimeout()
      Method gets the AppServer client Keepalive Response Timeout
      Returns:
      string KeepaliveRespTimeout

    • setClientASKResponseTimeout

      public static void setClientASKResponseTimeout(int AppServerKeepaliveResponseTimeout)
      Method sets the AppServer client Keepalive Response Timeout
      Parameters:
      AppServerKeepaliveResponseTimeout - the keepalive response timeout value

    • setDatasetNullInitials

      public static 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 static boolean getDatasetNullInitials()
      Method gets the dataset null initials setting
      Returns:
      boolean datasetSetNullInitials

    • setSslVersions

      public static void setSslVersions(String sslVersions)
      Parameters:
      sslVersions -

    • getSslVersions

      public static String getSslVersions()
      Method gets the ssl protocol versions
      Returns:
      boolean datasetSetNullInitials

    • setSslCiphers

      public static void setSslCiphers(String sslCiphers)
      Parameters:
      sslCiphers -

    • setServerName

      public static void setServerName(String sniServerName)
      Parameters:
      sniServerName - SNI server name

    • getServerName

      public static void getServerName()
      return server name

    • getSslCiphers

      public static String getSslCiphers()
      Method gets the ssl ciphers
      Returns:
      string value ssl ciphers

    • setPostponeRelationInfo

      public static void setPostponeRelationInfo(boolean value)
      Method sets the behavior for whether the relationship info is built when loading the ProDataGraph's data.
      Parameters:
      value - True if wants to change default behavior and postpone building the relationship info until getChildRows() is called for a particular ProDataObject

    • getPostponeRelationInfo

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

    • getUseDeprecatedGetChanges

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

    • setCompressionEnabled

      public static void setCompressionEnabled(boolean enabled)
      Method enables or disables compression of message bodies
      Parameters:
      enabled -

    • getCompressionEnabled

      public static boolean getCompressionEnabled()
      Method returns true if compression is enabled
      Returns:

    • setCompressionLevel

      public static void setCompressionLevel(int level)
      Method sets the compression level for messages. Valid values are 1 - 9 inclusive.
      Parameters:
      level -

    • getCompressionLevel

      public static int getCompressionLevel()
      Method returns the compression level for compressing message bodies
      Returns:

    • setCompressionThreshold

      public static void setCompressionThreshold(int threshold)
      Method sets the minimum size in bytes of the message before it is compressed. Minimum value is 256.
      Parameters:
      threshold -

    • getCompressionThreshold

      public static int getCompressionThreshold()
      Returns the minimum required size in bytes before a message is compressed.
      Returns:

    • getLocalMajorVersion

      public static String getLocalMajorVersion()
      Method get the local major version
      Returns:
      majorVersion

    • getLocalMinorVersion

      public static String getLocalMinorVersion()
      Method get the local minor version
      Returns:
      minorVersion

    • getLocalMaintVersion

      public static String getLocalMaintVersion()
      Method get the local maint version
      Returns:
      maintVersion

    • getLocalVersionInfo

      public static OEVersionInfo getLocalVersionInfo()
      Method get the local version info
      Returns:
      localVersionInfo

    • setClientContextID

      public static void setClientContextID(String clientContextID)
      Method set the clientContextID
      Parameters:
      clientContextID -

    • getClientContextID

      public static String getClientContextID()
      Method get the clientContextID
      Returns:
      clientContextID

    • getClientType

      public static int getClientType()
      Method get the client type

    • setClientType

      public static void setClientType(int clientType)
      Method set the client type
      Parameters:
      clientType -

    • getClientPrincipal

      public static com.progress.auth.ClientPrincipal getClientPrincipal()
      Method get the client principal

    • setClientPrincipal

      public static void setClientPrincipal(com.progress.auth.ClientPrincipal clientPrincipal)
      Method set the client principal
      Parameters:
      clientPrincipal -

    • getNetworkBufferSize

      public static int getNetworkBufferSize()
      Method get the network buffer size

    • setNetworkBufferSize

      public static void setNetworkBufferSize(int netBufferSize)
      Method set the network buffer size
      Parameters:
      netBufferSize -

    • setStringProperty

      public static void setStringProperty(String propName, 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

    • setIntProperty

      public static void setIntProperty(String propName, int propValue)

    • setLongProperty

      public static void setLongProperty(String propName, long propValue)

    • setBooleanProperty

      public static void setBooleanProperty(String propName, boolean propValue)

    • getStringProperty

      public static String getStringProperty(String propName)

    • getIntProperty

      public static int getIntProperty(String propName)

    • getLongProperty

      public static long getLongProperty(String propName)

    • getBooleanProperty

      public static boolean getBooleanProperty(String propName)

    • getStaticProperties

      public static Connection getStaticProperties()
      Method Returns all the static properties
      Returns:
      Connection properties