Package com.ibm.di.protocols.rxa

Class SelectProtocol

  • public class SelectProtocol
extends java.lang.Object
    Connect to the target machine using any protocol that is available.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String hostName
      The hostname (address) of the target machine
      protected java.lang.String keystore
      Full path to the file containing the keystore
      protected byte[] passphrase
      The passphrase that protects your private key
      protected byte[] password
      The password for the user
      protected int port
      The port to use to connect to the target machine
      protected java.lang.String sourcefile
      Path to the Source file
      static java.lang.String TYPE
      The connection protocol being used
      protected java.lang.String userName
      The name of a user

    • Constructor Summary

      Constructors 
      Constructor Description
      SelectProtocol​(java.util.Properties p, LogProxy log)
      Construct a SelectProtocol object with the provided properties

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Connection findProtocol()
      Find a suitable protocol that is available on the target machine and create a connection
      Connection findProtocol​(boolean checkAll)
      Find all suitable protocols that is available on the target machine if checkAll is true; otherwise stops at first suitable protocol
      java.lang.String[] getAllProtocols()
      Finds all available protocols that can make a successful connection to target machine using given connection parameters

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • hostName

        protected java.lang.String hostName
        The hostname (address) of the target machine

      • userName

        protected java.lang.String userName
        The name of a user

      • password

        protected byte[] password
        The password for the user

      • passphrase

        protected byte[] passphrase
        The passphrase that protects your private key

      • keystore

        protected java.lang.String keystore
        Full path to the file containing the keystore

      • sourcefile

        protected java.lang.String sourcefile
        Path to the Source file

      • port

        protected int port
        The port to use to connect to the target machine

      • TYPE

        public static final java.lang.String TYPE
        The connection protocol being used
        See Also:
        Constant Field Values

    • Constructor Detail

      • SelectProtocol

        public SelectProtocol​(java.util.Properties p,
                      LogProxy log)
        Construct a SelectProtocol object with the provided properties
        Parameters:
        p - Properties object containing the configured attribute values
        log - LogProxy object to be used for logging

    • Method Detail

      • findProtocol

        public Connection findProtocol()
                        throws RemoteConnectException
        Find a suitable protocol that is available on the target machine and create a connection
        Returns:
        Connection RXA Connection object
        Throws:
        RemoteConnectException - If a connection cannot be established

      • findProtocol

        public Connection findProtocol​(boolean checkAll)
                        throws RemoteConnectException
        Find all suitable protocols that is available on the target machine if checkAll is true; otherwise stops at first suitable protocol
        Parameters:
        checkAll - checks if all suitable protocols needs to be found or only first succcessful protocol
        Returns:
        Connection RXA Connection object
        Throws:
        RemoteConnectException

      • getAllProtocols

        public java.lang.String[] getAllProtocols()
        Finds all available protocols that can make a successful connection to target machine using given connection parameters
        Returns:
        List of All suitable protocols using which a successful connection can be made