Package com.ibm.di.plugin.domino.agents.common

Class DominoCommandEmitter

  • public abstract class DominoCommandEmitter
extends java.lang.Object
    Common library class used for sending password commands to the remote proxy.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      protected static boolean executeProxyCommand​(java.lang.String uid, java.lang.String password, int aOpCode)
      This method is the actual worker.
      static PWSyncLog getLog​(java.lang.String propName)
      Gets the common for all the domino agents log.
      static boolean readyToSync​(java.lang.String uid, java.lang.String password)
      This method only checks that the remote proxy is up and the Password Store is ready.
      static void stopProxy()
      sends a request to the running Java Proxy to stop.
      static boolean syncPass​(java.lang.String uid, java.lang.String password)
      this method is used to synchronized the provided as parameters user credentials.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DominoCommandEmitter

        public DominoCommandEmitter()

    • Method Detail

      • syncPass

        public static boolean syncPass​(java.lang.String uid,
                               java.lang.String password)
        this method is used to synchronized the provided as parameters user credentials.
        Parameters:
        uid - the user's name.
        password - the user's password.
        Returns:
        true if the synchronization completed successfully, false otherwise.

      • readyToSync

        public static boolean readyToSync​(java.lang.String uid,
                                  java.lang.String password)
        This method only checks that the remote proxy is up and the Password Store is ready.
        Parameters:
        uid - not required.
        password - not required.
        Returns:
        true if the password synchronization operation is ready to proceed, false otherwise.

      • executeProxyCommand

        protected static boolean executeProxyCommand​(java.lang.String uid,
                                             java.lang.String password,
                                             int aOpCode)
        This method is the actual worker. Connects to the remote Java Proxy and sends the specified command, credentials and reads the response.
        Parameters:
        uid - the user to send
        password - the password to send
        aOpCode - the operation code to send.
        Returns:
        true if the operation returned success (1), false if it returned failed (0).

      • getLog

        public static PWSyncLog getLog​(java.lang.String propName)
        Gets the common for all the domino agents log. This method will do a lazy loading of the configuration parameters. If the specified file could not be opened the System.in shall be used as output.
        Parameters:
        propName - the name of the property which points to the log file which will be used to log in.
        Returns:
        PWSyncLog instance.

      • stopProxy

        public static void stopProxy()
        sends a request to the running Java Proxy to stop.