Package org.pentaho.di.trans.steps.ssh

Class SSHMeta

    • Constructor Detail

      • SSHMeta

        public SSHMeta()

    • Method Detail

      • loadXML

        public void loadXML​(Node stepnode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.KettleXMLException
        Description copied from interface: StepMetaInterface
        Load the values for this step from an XML Node
        Specified by:
        loadXML in interface StepMetaInterface
        Overrides:
        loadXML in class BaseStepMeta
        Parameters:
        stepnode - the Node to get the info from
        databases - The available list of databases to reference to
        metaStore - the metastore to optionally load external reference metadata from
        Throws:
        org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

      • getServerName

        public String getServerName()
        Returns:
        Returns the serverName.

      • setServerName

        public void setServerName​(String serverName)
        Parameters:
        serverName - The serverName to set.

      • getuserName

        public String getuserName()
        Returns:
        Returns the userName.

      • setuserName

        public void setuserName​(String userName)
        Parameters:
        userName - The userName to set.

      • setpassword

        public void setpassword​(String password)
        Parameters:
        password - The password to set.

      • getpassword

        public String getpassword()
        Returns:
        Returns the password.

      • setcommandfieldname

        public void setcommandfieldname​(String commandfieldname)
        Parameters:
        commandfieldname - The commandfieldname to set.

      • getcommandfieldname

        public String getcommandfieldname()
        Returns:
        Returns the commandfieldname.

      • setCommand

        public void setCommand​(String value)
        Parameters:
        command - The commandfieldname to set.

      • getCommand

        public String getCommand()
        Returns:
        Returns the command.

      • setDynamicCommand

        public void setDynamicCommand​(boolean value)
        Parameters:
        value - The dynamicCommandField to set.

      • isDynamicCommand

        public boolean isDynamicCommand()
        Returns:
        Returns the dynamicCommandField.

      • getPort

        public String getPort()
        Returns:
        Returns the port.

      • setPort

        public void setPort​(String port)
        Parameters:
        port - The port to set.

      • usePrivateKey

        public void usePrivateKey​(boolean value)

      • isusePrivateKey

        public boolean isusePrivateKey()
        Returns:
        Returns the usePrivateKey.

      • setKeyFileName

        public void setKeyFileName​(String value)
        Parameters:
        value - The keyFileName to set.

      • getKeyFileName

        public String getKeyFileName()
        Returns:
        Returns the keyFileName.

      • setPassphrase

        public void setPassphrase​(String value)
        Parameters:
        value - The passPhrase to set.

      • getPassphrase

        public String getPassphrase()
        Returns:
        Returns the passPhrase.

      • setTimeOut

        public void setTimeOut​(String timeOut)

      • getTimeOut

        public String getTimeOut()
        Returns:
        Returns the timeOut.

      • setstdOutFieldName

        public void setstdOutFieldName​(String value)
        Parameters:
        value - The stdOutFieldName to set.

      • getStdOutFieldName

        public String getStdOutFieldName()
        Returns:
        Returns the stdOutFieldName.

      • setStdErrFieldName

        public void setStdErrFieldName​(String value)
        Parameters:
        value - The stdErrFieldName to set.

      • getStdErrFieldName

        public String getStdErrFieldName()
        Returns:
        Returns the stdErrFieldName.

      • setProxyHost

        public void setProxyHost​(String value)
        Parameters:
        value - The proxyHost to set.

      • getProxyHost

        public String getProxyHost()
        Returns:
        Returns the proxyHost.

      • setProxyPort

        public void setProxyPort​(String value)
        Parameters:
        value - The proxyPort to set.

      • getProxyPort

        public String getProxyPort()
        Returns:
        Returns the proxyPort.

      • setProxyUsername

        public void setProxyUsername​(String value)
        Parameters:
        value - The proxyUsername to set.

      • getProxyUsername

        public String getProxyUsername()
        Returns:
        Returns the proxyUsername.

      • setProxyPassword

        public void setProxyPassword​(String value)
        Parameters:
        value - The proxyPassword to set.

      • getProxyPassword

        public String getProxyPassword()
        Returns:
        Returns the proxyPassword.

      • getXML

        public String getXML()
        Description copied from class: BaseStepMeta
        Produces the XML string that describes this step's information.
        Specified by:
        getXML in interface StepMetaInterface
        Overrides:
        getXML in class BaseStepMeta
        Returns:
        String containing the XML describing this step.

      • readRep

        public void readRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_step,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: StepMetaInterface
        Read the steps information from a Kettle repository
        Specified by:
        readRep in interface StepMetaInterface
        Overrides:
        readRep in class BaseStepMeta
        Parameters:
        rep - The repository to read from
        metaStore - The MetaStore to read external information from
        id_step - The step ID
        databases - The databases to reference
        Throws:
        org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

      • saveRep

        public void saveRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_transformation,
                    org.pentaho.di.repository.ObjectId id_step)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: StepMetaInterface
        Save the steps data into a Kettle repository
        Specified by:
        saveRep in interface StepMetaInterface
        Overrides:
        saveRep in class BaseStepMeta
        Parameters:
        rep - The Kettle repository to save to
        metaStore - the metaStore to optionally write to
        id_transformation - The transformation ID
        id_step - The step ID
        Throws:
        org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

      • check

        public void check​(List<org.pentaho.di.core.CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  org.pentaho.di.core.row.RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  org.pentaho.di.core.row.RowMetaInterface info,
                  org.pentaho.di.core.variables.VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)
        Description copied from interface: StepMetaInterface
        Checks the settings of this step and puts the findings in a remarks List.
        Specified by:
        check in interface StepMetaInterface
        Overrides:
        check in class BaseStepMeta
        Parameters:
        remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult
        stepMeta - The stepMeta to help checking
        prev - The fields coming from the previous step
        input - The input step names
        output - The output step names
        info - The fields that are used as information by the step
        space - the variable space to resolve variable expressions with
        repository - the repository to use to load Kettle metadata objects impacting the output fields
        metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

      • getFields

        public void getFields​(org.pentaho.di.core.row.RowMetaInterface row,
                      String name,
                      org.pentaho.di.core.row.RowMetaInterface[] info,
                      StepMeta nextStep,
                      org.pentaho.di.core.variables.VariableSpace space,
                      Repository repository,
                      org.pentaho.metastore.api.IMetaStore metaStore)
               throws org.pentaho.di.core.exception.KettleStepException
        Description copied from class: BaseStepMeta
        Gets the fields.
        Specified by:
        getFields in interface StepMetaInterface
        Overrides:
        getFields in class BaseStepMeta
        Parameters:
        row - the input row meta that is modified in this method to reflect the output row metadata of the step
        name - Name of the step to use as input for the origin field in the values
        info - Fields used as extra lookup information
        nextStep - the next step that is targeted
        space - the space The variable space to use to replace variables
        repository - the repository to use to load Kettle metadata objects impacting the output fields
        metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields
        Throws:
        org.pentaho.di.core.exception.KettleStepException - the kettle step exception

      • getStep

        public StepInterface getStep​(StepMeta stepMeta,
                             StepDataInterface stepDataInterface,
                             int cnr,
                             TransMeta transMeta,
                             Trans trans)
        Description copied from interface: StepMetaInterface
        Get the executing step, needed by Trans to launch a step.
        Specified by:
        getStep in interface StepMetaInterface
        Parameters:
        stepMeta - The step info
        stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.
        cnr - The copy nr to get
        transMeta - The transformation info
        trans - The launching transformation

      • getStepData

        public StepDataInterface getStepData()
        Description copied from interface: StepMetaInterface
        Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.
        Specified by:
        getStepData in interface StepMetaInterface
        Returns:
        The appropriate StepDataInterface class.