ca.idms.proxy
Class ProxyOptions

java.lang.Object
  ca.idms.io.TraceObject
      ca.idms.proxy.ProxyOptions

All Implemented Interfaces:

Trace

public class ProxyOptions
extends TraceObject

This class defines options for the JDBC Server. On Windows, proxy options are usually specified in the registry. The most commonly used options can be set using the ODBC Administrator. All options can be set by manually editing the registry. The property names defined in this class are the value names.

On OS/390, z/OS, and Linux on both the mainframe and PC, proxy options can be specified in the IDMS configuration file, which is formatted like a Windows "ini" file. The property names defined in this class are the key names.

On all platforms, proxy options can be specified in the IDMS properties file, which is formatted as a standard Java properties file. The property names defined in this are appended to "Options." to form the key in the properties file. These properties can also be specified as system properites when prefixed with the system propery prefix.

When an option is specified in more than one place, a value from the registry or configuration file overrides a value from the properties file, which overrides the value set as a system property. For compatibility with the registry and ini file conventions, boolean options are usually set as "integer" values, where 1 is "true" and 0 is "false".

Author:

Dave Ross

Field Summary

static java.lang.String	KEY_BACKLOG Property name to specify the listener backlog.
static java.lang.String	KEY_CLIENT_AUTH Property name to enable SSL client authorization.
static java.lang.String	KEY_ENCODING Property name to specify the preferred character encoding.
static java.lang.String	KEY_HOST Property name to specify the listener host name.
static java.lang.String	KEY_LOG_LEVEL Property name to specify the level of messages sent to syslog.
static java.lang.String	KEY_LOG_TRACE Property name to specify the level of syslog messages sent to the trace.
static java.lang.String	KEY_PORT Property name to specify the listener port.
static java.lang.String	KEY_PROXY Prefix for JDBC Server options.
static java.lang.String	KEY_REMOTE_CONTROL Property name to enable server to respond to a remote controller.
static java.lang.String	KEY_REMOTE_HOST Property name to specify the remote server host name.
static java.lang.String	KEY_REMOTE_PORT Property name to specify the remote server port.
static java.lang.String	KEY_REMOTE_SSL Property name to enable SSL to the remote server.
static java.lang.String	KEY_REPLY_TIMEOUT Property name to specify reply wait timeout.
static java.lang.String	KEY_SNAP Property name to enable display of buffers in the trace.
static java.lang.String	KEY_SOCKET_TIMEOUT Property name to specify socket wait timeout.
static java.lang.String	KEY_SSL Property name to enable SSL for the listener.
static java.lang.String	KEY_TRACE Property name to enable tracing.
static java.lang.String	KEY_UNICODE Property name to force specify the use of UNICODE.
static java.lang.String	KEY_WAIT_TIMEOUT Property name to specify the client wait timeout.
static int	LOG_DEBUG Send debugging messages to system log, value = 12.
static int	LOG_ERROR Send error messages to system log, value = 4.
static int	LOG_INFO Send information messages to system log, value = 8.
static int	LOG_OFF Disable system log messages, value = 0.
static int	LOG_VERBOSE Send "verbose" information messages to system log, value = 10.
static int	LOG_WARNING Send warning messages to system log, value = 6.
static java.lang.String	NAME Product name = "CA JDBC Server".
static java.lang.String	VERSION Product version = "17.0".

Fields inherited from class ca.idms.io.TraceObject

exclude, EXCLUDE, FALSE, include, INCLUDE, logWriter, PREFIX, PROPERTIES_FILE, PROPERTIES_KEY, snap, SNAP, SNAP_BYTES, SNAP_NATIVE, SNAP_OBJECT, SNAP_SQL, snapBytes, snapNative, snapObject, snapSql, stub, trace, TRACE, TRACE_FILE, TRACE_LIFE, TRACE_NATIVE, TRACE_PRODUCT, traceLife, traceNative, traceStream, TRUE

Method Summary

Methods inherited from class ca.idms.io.TraceObject

finalize, get, getBoolean, getClasses, getInteger, getProperty, listProperties, message, parseList, print, print, print, println, println, snap, snap, snap, snap, snap, snap, snap, toHex, toHex, toHex, toHex, toHex, toString, trace, trace, trace, trace, trace, trace, traceEntry, unloadProperties

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

Product name = "CA JDBC Server".

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

Product version = "17.0".

See Also:

Constant Field Values

KEY_PROXY

public static final java.lang.String KEY_PROXY

Prefix for JDBC Server options. "Proxy" is used for:

• subkey in the Windows registry
• section name in the IDMS configuration file
• prefix for options in the IDMS properties file

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_HOST

public static final java.lang.String KEY_HOST

Property name to specify the listener host name. Set "Host" to the DNS name or TCP/IP address of the host.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_PORT

public static final java.lang.String KEY_PORT

Property name to specify the listener port. Set "Port" to the TCP/IP port.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_SSL

public static final java.lang.String KEY_SSL

Property name to enable SSL for the listener. Set "SSL" to 1 to enable, 0 to disable.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_CLIENT_AUTH

public static final java.lang.String KEY_CLIENT_AUTH

Property name to enable SSL client authorization. Set "ClientAuth" to 1 to enable, 0 to disable.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_BACKLOG

public static final java.lang.String KEY_BACKLOG

Property name to specify the listener backlog. Set "Backlog" to the maximum length of the listener queue.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_REMOTE_HOST

public static final java.lang.String KEY_REMOTE_HOST

Property name to specify the remote server host name. Set "RemoteHost" to the DNS name or TCP/IP address of the remote server.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_REMOTE_PORT

public static final java.lang.String KEY_REMOTE_PORT

Property name to specify the remote server port. Set "RemotePort" to the TCP/IP port of the remote server.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_REMOTE_SSL

public static final java.lang.String KEY_REMOTE_SSL

Property name to enable SSL to the remote server. Set "RemoteSSL" to 1 to enable, 0 to disable.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_REMOTE_CONTROL

public static final java.lang.String KEY_REMOTE_CONTROL

Property name to enable server to respond to a remote controller. Normally the proxy server will honor only status commands when sent from a remote "controller". This enables the others. Set "RemoteControl" to 1 to enable, 0 to disable.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_ENCODING

public static final java.lang.String KEY_ENCODING

Property name to specify the preferred character encoding. Set "Encoding" to the encoding name as included in a converter class.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_UNICODE

public static final java.lang.String KEY_UNICODE

Property name to force specify the use of UNICODE. Set "Unicode" to 1 to use UNICODE if the preferred encoding not available, 0 to use UTF-8 (the default).

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_REPLY_TIMEOUT

public static final java.lang.String KEY_REPLY_TIMEOUT

Property name to specify reply wait timeout. Set "ReplyTimeOut" to the number of seconds for the server to wait for a reply from the database before assuming that the session has been lost. The default is 0, which means there is no limit.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_SOCKET_TIMEOUT

public static final java.lang.String KEY_SOCKET_TIMEOUT

Property name to specify socket wait timeout. Set "SocketTimeOut" to the number of seconds that the server waits for data to be available each time it reads the socket connected to the client. When this interval expires the server retries the read.

A high value reduces server overhead, a low value allows the server to respond to shutdown events more quickly. Setting this to 0 will cause the the thread to block forever, and is not recommended. The default is 60 seconds.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_WAIT_TIMEOUT

public static final java.lang.String KEY_WAIT_TIMEOUT

Property name to specify the client wait timeout. Set "WaitTimeOut" to the number of seconds for the server to wait for a request from a connected client before assuming that the connection has been lost. The default is 0, which means there is no limit.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_LOG_LEVEL

public static final java.lang.String KEY_LOG_LEVEL

Property name to specify the level of messages sent to syslog. Set "LogLevel" to level, the default is (@link #LOG_INFO}.

See Also:

LOG_OFF, LOG_ERROR, LOG_WARNING, LOG_INFO, LOG_VERBOSE, LOG_DEBUG, "Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_LOG_TRACE

public static final java.lang.String KEY_LOG_TRACE

Property name to specify the level of syslog messages sent to the trace. Set "LogTrace" to level, the default is LOG_ERROR.

See Also:

LOG_OFF, LOG_ERROR, LOG_WARNING, LOG_INFO, LOG_VERBOSE, LOG_DEBUG, "Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_TRACE

public static final java.lang.String KEY_TRACE

Property name to enable tracing. Set "Trace" to 1 to enable, 0 to disable.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

KEY_SNAP

public static final java.lang.String KEY_SNAP

Property name to enable display of buffers in the trace. Set "Snap" to 1 to enable, 0 to disable.

See Also:

"Advantage CA-IDMS Database Server Option User Guide", Constant Field Values

LOG_OFF

public static final int LOG_OFF

Disable system log messages, value = 0.

See Also:

Constant Field Values

LOG_ERROR

public static final int LOG_ERROR

Send error messages to system log, value = 4.

See Also:

Constant Field Values

LOG_WARNING

public static final int LOG_WARNING

Send warning messages to system log, value = 6.

See Also:

Constant Field Values

LOG_INFO

public static final int LOG_INFO

Send information messages to system log, value = 8. These include server start and stop events

See Also:

Constant Field Values

LOG_VERBOSE

public static final int LOG_VERBOSE

Send "verbose" information messages to system log, value = 10. These include client thread start and stop events

See Also:

Constant Field Values

LOG_DEBUG

public static final int LOG_DEBUG

Send debugging messages to system log, value = 12. These do not include general trace output.

See Also:

Constant Field Values