Package com.ibm.di.plugin.proxy

Class Proxy

  • public class Proxy
extends java.lang.Object
    This is the common Java Proxy that is responsible for reading the appropriate configuration file and listening for incoming connections.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_SERVER_PORT
      this is the default port the Proxy will listen to
      static java.lang.String LOG_ENCODING
      The key name for the log encoding
      protected static java.lang.String PREFIX
      the proxy's log prefix
      static java.lang.String PROXY_AUTH_FOLDER
      the key name for the proxy's security folder
      static java.lang.String PROXY_CONFIG_FILE
      the key name for the proxy's configuration file path
      static java.lang.String PROXY_CUSTOM_DATA
      the key name for the proxy's custom data
      static java.lang.String PROXY_DEBUG
      the key name for the proxy's debug flag
      static java.lang.String PROXY_LOG_FILE
      the key name for the proxy's log file
      static java.lang.String PROXY_LOG_ROTATION_PATTERN
      The key name for the log file rotation pattern
      static java.lang.String PROXY_PORT
      the key name for the proxy's listening port
      static java.lang.String PROXY_SYNC_CLASS
      the key name for the proxy's password store class name

    • Constructor Summary

      Constructors 
      Constructor Description
      Proxy()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void init()
      initializes the Proxy class.
      static void main​(java.lang.String[] args)
      This is the entry point of the Java Proxy process when it is run by a plug-in other than the Domino plug-in.
      boolean proxyStopRequested()
      Check whether the Proxy is requested to stop.
      protected static void readProxyConfigurationFile()
      Reads the proxy configuration file given by a System Property with the name PROXY_CONFIG_FILE
      void requestProxyStop()
      Request from the Proxy to stop execution.
      void runProxy()
      The main worker method.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_SERVER_PORT

        public static final int DEFAULT_SERVER_PORT
        this is the default port the Proxy will listen to
        See Also:
        Constant Field Values

      • PROXY_CONFIG_FILE

        public static final java.lang.String PROXY_CONFIG_FILE
        the key name for the proxy's configuration file path
        See Also:
        Constant Field Values

      • PROXY_AUTH_FOLDER

        public static final java.lang.String PROXY_AUTH_FOLDER
        the key name for the proxy's security folder
        See Also:
        Constant Field Values

      • PROXY_SYNC_CLASS

        public static final java.lang.String PROXY_SYNC_CLASS
        the key name for the proxy's password store class name
        See Also:
        Constant Field Values

      • PROXY_PORT

        public static final java.lang.String PROXY_PORT
        the key name for the proxy's listening port
        See Also:
        Constant Field Values

      • PROXY_LOG_FILE

        public static final java.lang.String PROXY_LOG_FILE
        the key name for the proxy's log file
        See Also:
        Constant Field Values

      • PROXY_LOG_ROTATION_PATTERN

        public static final java.lang.String PROXY_LOG_ROTATION_PATTERN
        The key name for the log file rotation pattern
        See Also:
        Constant Field Values

      • LOG_ENCODING

        public static final java.lang.String LOG_ENCODING
        The key name for the log encoding
        See Also:
        Constant Field Values

      • PROXY_DEBUG

        public static final java.lang.String PROXY_DEBUG
        the key name for the proxy's debug flag
        See Also:
        Constant Field Values

      • PROXY_CUSTOM_DATA

        public static final java.lang.String PROXY_CUSTOM_DATA
        the key name for the proxy's custom data
        See Also:
        Constant Field Values

      • PREFIX

        protected static final java.lang.String PREFIX
        the proxy's log prefix
        See Also:
        Constant Field Values

    • Constructor Detail

      • Proxy

        public Proxy()

    • Method Detail

      • requestProxyStop

        public void requestProxyStop()
        Request from the Proxy to stop execution. This method will block to make sure a request does not come before the Proxy is completely initialized.

      • proxyStopRequested

        public boolean proxyStopRequested()
        Check whether the Proxy is requested to stop.
        Returns:
        true if the proxy was asked to stop, false otherwise.

      • main

        public static void main​(java.lang.String[] args)
                 throws java.lang.Exception
        This is the entry point of the Java Proxy process when it is run by a plug-in other than the Domino plug-in.
        Parameters:
        args - no specific arguments are checked or expected.
        Throws:
        java.lang.Exception - if an error occurs.

      • readProxyConfigurationFile

        protected static void readProxyConfigurationFile()
                                          throws java.io.FileNotFoundException,
                                                 java.io.IOException
        Reads the proxy configuration file given by a System Property with the name PROXY_CONFIG_FILE
        Throws:
        java.io.FileNotFoundException - if the file could not be found.
        java.io.IOException - if a read error occurs.
        java.lang.IllegalArgumentException - if the required System Property is missing or malformed.

      • init

        public void init()
          throws java.lang.Exception
        initializes the Proxy class.
        Throws:
        java.lang.Exception - if an error occurs.

      • runProxy

        public void runProxy()
              throws java.lang.Exception
        The main worker method. This method expects that the init() method was called previously and it has succeeded.
        Throws:
        java.lang.Exception - if an error occurs.