com.ibm.di.plugin.proxy
Class Proxy

java.lang.Object
  extended by com.ibm.di.plugin.proxy.Proxy

public class Proxy
extends Object

This is the common Java Proxy that is responsible for reading the appropriate configuration file and listening for incoming connections.


Field Summary
static int DEFAULT_SERVER_PORT
          this is the default port the Proxy will listen to
protected static String PREFIX
          the proxy's log prefix
static String PROXY_AUTH_FOLDER
          the key name for the proxy's security folder
static String PROXY_CONFIG_FILE
          the key name for the proxy's configuration file path
static String PROXY_DEBUG
          the key name for the proxy's debug flag
static String PROXY_LOG_FILE
          the key name for the proxy's log file
static String PROXY_PORT
          the key name for the proxy's listening port
static String PROXY_SYNC_CLASS
          the key name for the proxy's password store class name
 
Constructor Summary
Proxy()
           
 
Method Summary
 void init()
          initializes the Proxy class.
static void main(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 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 String PROXY_AUTH_FOLDER
the key name for the proxy's security folder

See Also:
Constant Field Values

PROXY_SYNC_CLASS

public static final 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 String PROXY_PORT
the key name for the proxy's listening port

See Also:
Constant Field Values

PROXY_LOG_FILE

public static final String PROXY_LOG_FILE
the key name for the proxy's log file

See Also:
Constant Field Values

PROXY_DEBUG

public static final String PROXY_DEBUG
the key name for the proxy's debug flag

See Also:
Constant Field Values

PREFIX

protected static final 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(String[] args)
                 throws 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:
Exception - if an error occurs.

readProxyConfigurationFile

protected static void readProxyConfigurationFile()
                                          throws FileNotFoundException,
                                                 IOException
Reads the proxy configuration file given by a System Property with the name PROXY_CONFIG_FILE

Throws:
FileNotFoundException - if the file could not be found.
IOException - if a read error occurs.
IllegalArgumentException - if the required System Property is missing or malformed.

init

public void init()
          throws Exception
initializes the Proxy class.

Throws:
Exception - if an error occurs.

runProxy

public void runProxy()
              throws Exception
The main worker method. This method expects that the init() method was called previously and it has succeeded.

Throws:
Exception - if an error occurs.