com.ibm.as400.access

Class SystemProperties

  • java.lang.Object
    • com.ibm.as400.access.SystemProperties


  • public class SystemProperties
    extends java.lang.Object
    Contains constants representing names of all Java system properties recognized by the IBM Toolbox for Java.

    Note: This class is reserved for internal use within the Toolbox, and is subject to change without notice.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String AS400_GUI_AVAILABLE
      Specifies whether GUI support is available in the current execution environment.
      static java.lang.String AS400_MUST_ADD_LANGUAGE_LIBRARY
      Specifies whether the AS400 class should attempt to add the appropriate secondary language library to the library list.
      static java.lang.String AS400_MUST_USE_NET_SOCKETS
      Specifies whether only Internet domain sockets must be used when communicating with the system.
      static java.lang.String AS400_MUST_USE_SOCKETS
      Specifies whether sockets must be used when communicating with the system.
      static java.lang.String AS400_MUST_USE_SUPPLIED_PROFILE
      Specifies whether the explicitly supplied profile must be used when communicating with the system.
      static java.lang.String AS400_PROXY_SERVER
      Specifies the proxy server host name and port number.
      static java.lang.String AS400_SIGNON_HANDLER
      Specifies the name of the default signon handler class used by the AS400 class.
      static java.lang.String AS400_THREAD_USED
      Specifies whether threads are used when communicating with the host servers.
      static java.lang.String COMMANDCALL_THREADSAFE
      Specifies whether the CommandCall class should assume that called commands are threadsafe.
      static java.lang.String CONNECTIONPOOL_PRETEST
      Specifies whether pooled connections are to be pretested before being allocated to a requester by the connection pool manager.
      static java.lang.String FALLBACK_CCSID
      Specifies the fallback CCSID to use in cases where a text data field with CCSID 65535 is encountered and must be converted.
      static java.lang.String FTP_REUSE_SOCKET
      Specifies whether the socket is reused for multiple file transfers when in "active" mode.
      static java.lang.String LIST_WAIT_TIMEOUT
      Specifies the maximum number of seconds to wait for an object list to be built, before timing out.
      static java.lang.String PROGRAMCALL_THREADSAFE
      Specifies whether the ProgramCall class should assume that called programs are threadsafe.
      static java.lang.String THROW_SAX_EXCEPTION_IF_PARSE_ERROR
      Specifies the behavior of the ProgramCallDocument in the event that XML parsing errors occur.
      static java.lang.String TRACE_CATEGORY
      Specifies which trace categories to enable.
      static java.lang.String TRACE_FILE
      Specifies the file to which the Trace class writes output.
      static java.lang.String TRACE_JDBC_SERVER
      Specifies which trace categories to start on the JDBC server job.
      static java.lang.String TRACE_SHOW_CHARS
      Specifies whether trace should also display the characters associated with the trace information.
      static java.lang.String TUNNELPROXYSERVER_CLIENTCLEANUPINTERVAL
      Specifies how often, in seconds, the proxy server looks for idle connections.
      static java.lang.String TUNNELPROXYSERVER_CLIENTLIFETIME
      Specifies how long, in seconds, a client can be idle before the proxy server removes references to the objects.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static java.lang.String getProperty(java.lang.String propertyName) 
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • AS400_GUI_AVAILABLE

        public static final java.lang.String AS400_GUI_AVAILABLE
        Specifies whether GUI support is available in the current execution environment. If set to true, then the AS400 class may prompt during sign-on to display error conditions, to obtain additional signon information, or to change the password. If set to false, then connection error conditions or missing information will result in exceptions.
        • Property name: com.ibm.as400.access.AS400.guiAvailable
        • Values/syntax: true or false
        • Default: true
        • Overridden by: AS400.setGuiAvailable()
        See Also:
        Constant Field Values
      • AS400_PROXY_SERVER

        public static final java.lang.String AS400_PROXY_SERVER
        Specifies the proxy server host name and port number. The port number is optional.
        • Property name: com.ibm.as400.access.AS400.proxyServer
        • Values/syntax: hostName:portNumber
        • Default: (no default)
        • Overridden by: AS400.setProxyServer()
        See Also:
        Constant Field Values
      • AS400_SIGNON_HANDLER

        public static final java.lang.String AS400_SIGNON_HANDLER
        Specifies the name of the default signon handler class used by the AS400 class.
        See Also:
        Constant Field Values
      • AS400_MUST_ADD_LANGUAGE_LIBRARY

        public static final java.lang.String AS400_MUST_ADD_LANGUAGE_LIBRARY
        Specifies whether the AS400 class should attempt to add the appropriate secondary language library to the library list. This property is ignored if not running on the IBM i system.
        See Also:
        Constant Field Values
      • AS400_MUST_USE_SOCKETS

        public static final java.lang.String AS400_MUST_USE_SOCKETS
        Specifies whether sockets must be used when communicating with the system. Setting this property to true directs the Toolbox to refrain from exploiting native optimizations, when running directly on the system.
        • Property name: com.ibm.as400.access.AS400.mustUseSockets
        • Values/syntax: true or false
        • Default: false
        • Overridden by: AS400.setMustUseSockets()
        See Also:
        Constant Field Values
      • AS400_MUST_USE_NET_SOCKETS

        public static final java.lang.String AS400_MUST_USE_NET_SOCKETS
        Specifies whether only Internet domain sockets must be used when communicating with the system. Setting this property to true directs the Toolbox to refrain from exploiting Unix sockets, when running directly on the system.
        • Property name: com.ibm.as400.access.AS400.mustUseNetSockets
        • Values/syntax: true or false
        • Default: false
        • Overridden by: AS400.setMustUseNetSockets()
        See Also:
        Constant Field Values
      • AS400_MUST_USE_SUPPLIED_PROFILE

        public static final java.lang.String AS400_MUST_USE_SUPPLIED_PROFILE
        Specifies whether the explicitly supplied profile must be used when communicating with the system. Setting this property to true directs the Toolbox to refrain from exploiting the currently signed-on profile by default, when running directly on the system.
        See Also:
        Constant Field Values
      • AS400_THREAD_USED

        public static final java.lang.String AS400_THREAD_USED
        Specifies whether threads are used when communicating with the host servers. By default, the AS400 object creates separate threads to listen on communication sockets to the host servers. Setting this property to false directs the Toolbox to refrain from creating separate threads for host server communications.
        • Property name: com.ibm.as400.access.AS400.threadUsed
        • Values/syntax: true or false
        • Default: true
        • Overridden by: AS400.setThreadUsed()
        See Also:
        Constant Field Values
      • TRACE_CATEGORY

        public static final java.lang.String TRACE_CATEGORY
        Specifies which trace categories to enable. This is a comma-delimited list containing any combination of trace categories.
        • Property name: com.ibm.as400.access.Trace.category
        • Values/syntax: datastream, diagnostic, error, information, ...
          (Refer to the Trace class for complete list.)
        • Default: (no default)
        • Overridden by: Various setTrace... methods in the Trace class.
        See Also:
        Constant Field Values
      • TRACE_SHOW_CHARS

        public static final java.lang.String TRACE_SHOW_CHARS
        Specifies whether trace should also display the characters associated with the trace information.
        • Property name: com.ibm.as400.access.Trace.showChars
        • Values/syntax: true, false
        • Default: false
        • Overridden by: Nothing
        See Also:
        Constant Field Values
      • TRACE_FILE

        public static final java.lang.String TRACE_FILE
        Specifies the file to which the Trace class writes output.
        • Property name: com.ibm.as400.access.Trace.file
        • Values/syntax: true or false
        • Default: System.out.
        • Overridden by: Any of the Trace.setFileName() or Trace.setPrintWriter() methods.
        See Also:
        Constant Field Values
      • TRACE_JDBC_SERVER

        public static final java.lang.String TRACE_JDBC_SERVER
        Specifies which trace categories to start on the JDBC server job.
        • Property name: com.ibm.as400.access.ServerTrace.JDBC
        • Values/syntax: Refer to the javadoc for class AS400JDBCDriver. Follow the link labeled "JDBC properties", and search for the "server trace" property.
        • Default: (no default)
        • Overridden by: Specifying property values in either the connection URL or via one of the connect() methods of class AS400JDBCDriver
        See Also:
        Constant Field Values
      • COMMANDCALL_THREADSAFE

        public static final java.lang.String COMMANDCALL_THREADSAFE
        Specifies whether the CommandCall class should assume that called commands are threadsafe. If true, all called commands are assumed to be threadsafe. If false, all called commands are assumed to be non-threadsafe.
        • Property name: com.ibm.as400.access.CommandCall.threadSafe
        • Values/syntax: true or false
        • Default: false
        • Overridden by: CommandCall.setThreadSafe()
        See Also:
        Constant Field Values
      • PROGRAMCALL_THREADSAFE

        public static final java.lang.String PROGRAMCALL_THREADSAFE
        Specifies whether the ProgramCall class should assume that called programs are threadsafe. If true, all called programs are assumed to be thread-safe. If false, all called programs are assumed to be non-thread-safe.
        • Property name: com.ibm.as400.access.ProgramCall.threadSafe
        • Values/syntax: true or false
        • Default: false
        • Overridden by: ProgramCall.setThreadSafe()
        See Also:
        Constant Field Values
      • TUNNELPROXYSERVER_CLIENTCLEANUPINTERVAL

        public static final java.lang.String TUNNELPROXYSERVER_CLIENTCLEANUPINTERVAL
        Specifies how often, in seconds, the proxy server looks for idle connections. The proxy server starts a thread to look for clients that are no longer communicating. Use this property to set how often the thread looks for idle connections.
        • Property name: com.ibm.as400.access.TunnelProxyServer.clientCleanupInterval
        • Values/syntax: numberOfSeconds
        • Default: 2 hours
        • Overridden by: (none)
        See Also:
        Constant Field Values
      • TUNNELPROXYSERVER_CLIENTLIFETIME

        public static final java.lang.String TUNNELPROXYSERVER_CLIENTLIFETIME
        Specifies how long, in seconds, a client can be idle before the proxy server removes references to the objects. Removing the references allows the JVM to garbage collect the objects. The proxy server starts a thread to look for clients that are no longer communicating. Use this property to set how long a client can be idle before performing garbage collection on it.
        • Property name: com.ibm.as400.access.TunnelProxyServer.clientLifetime
        • Values/syntax: numberOfSeconds
        • Default: 30 minutes
        • Overridden by: (none)
        See Also:
        Constant Field Values
      • FTP_REUSE_SOCKET

        public static final java.lang.String FTP_REUSE_SOCKET
        Specifies whether the socket is reused for multiple file transfers when in "active" mode. This property is referenced by classes FTP and AS400FTP. If true, the socket is reused. If false, a new socket is created for each file transfer. This property is ignored for a given FTP object if FTP.setReuseSocket(true/false) has been performed on the object.
        • Property name: com.ibm.as400.access.FTP.reuseSocket
        • Values/syntax: true or false
        • Default: true
        • Overridden by: FTP.setReuseSocket()
        See Also:
        Constant Field Values
      • FALLBACK_CCSID

        public static final java.lang.String FALLBACK_CCSID
        Specifies the fallback CCSID to use in cases where a text data field with CCSID 65535 is encountered and must be converted. Sometimes, especially in non-English environments, the default CCSID is left at 65535. That causes classes such as AS400Text to make a "best guess" on the CCSID, based on the default locale. This option overrides the best guess with a specific CCSID value. This is useful where the Locale of a client system is different from that of the IBM i system.
        • Property name: com.ibm.as400.access.AS400.fallbackCCSID
        • Values/syntax: 0-65535
        • Default: (no default)
        • Overridden by: (none)
        See Also:
        Constant Field Values
      • CONNECTIONPOOL_PRETEST

        public static final java.lang.String CONNECTIONPOOL_PRETEST
        Specifies whether pooled connections are to be pretested before being allocated to a requester by the connection pool manager.
        See Also:
        Constant Field Values
      • THROW_SAX_EXCEPTION_IF_PARSE_ERROR

        public static final java.lang.String THROW_SAX_EXCEPTION_IF_PARSE_ERROR
        Specifies the behavior of the ProgramCallDocument in the event that XML parsing errors occur. By default, the ProgramCallDocument object simply traces any parse errors. The trace category is PCML. Setting this property to true directs the Toolbox to also throw a SAXException in the event of a parsing error.
        • Property name: com.ibm.as400.data.ProgramCallDocument.throwSAXExceptionIfParseError
        • Values/syntax: true or false
        • Default: false
        • Overridden by: (none)
        See Also:
        Constant Field Values
      • LIST_WAIT_TIMEOUT

        public static final java.lang.String LIST_WAIT_TIMEOUT
        Specifies the maximum number of seconds to wait for an object list to be built, before timing out. Some Toolbox methods (such as JobList.load()) call list-building APIs (such as QGYOLJOB) that build object lists remotely on the IBM i system. If the number of objects being listed is extremely large, the building of the list may take longer than anticipated.
        • Property name: com.ibm.as400.access.ListUtilities.listWaitTimeout
        • Values/syntax: 0 or greater (0 means "wait until complete")
        • Default: 60 seconds
        • Overridden by: (none)
        See Also:
        Constant Field Values
    >
    • Method Detail

      • getProperty

        public static java.lang.String getProperty(java.lang.String propertyName)