Package org.pentaho.di.trans.steps.http

Class HTTPMeta

    • Field Detail

      • DEFAULT_CONNECTION_TIMEOUT

        public static final int DEFAULT_CONNECTION_TIMEOUT
        See Also:
        Constant Field Values

      • DEFAULT_CLOSE_CONNECTIONS_TIME

        public static final int DEFAULT_CLOSE_CONNECTIONS_TIME
        See Also:
        Constant Field Values

    • Constructor Detail

      • HTTPMeta

        public HTTPMeta()

    • Method Detail

      • getConnectionTimeout

        public String getConnectionTimeout()
        Returns:
        Returns the connectionTimeout.

      • setConnectionTimeout

        public void setConnectionTimeout​(String connectionTimeout)
        Parameters:
        connectionTimeout - The connectionTimeout to set.

      • getCloseIdleConnectionsTime

        public String getCloseIdleConnectionsTime()
        Returns:
        Returns the closeIdleConnectionsTime.

      • setCloseIdleConnectionsTime

        public void setCloseIdleConnectionsTime​(String closeIdleConnectionsTime)
        Parameters:
        connectionTimeout - The connectionTimeout to set.

      • getSocketTimeout

        public String getSocketTimeout()
        Returns:
        Returns the socketTimeout.

      • setSocketTimeout

        public void setSocketTimeout​(String socketTimeout)
        Parameters:
        socketTimeout - The socketTimeout to set.

      • getArgumentField

        public String[] getArgumentField()
        Returns:
        Returns the argument.

      • setArgumentField

        public void setArgumentField​(String[] argument)
        Parameters:
        argument - The argument to set.

      • getHeaderField

        public String[] getHeaderField()
        Returns:
        Returns the headerFields.

      • setHeaderField

        public void setHeaderField​(String[] headerField)
        Parameters:
        headerField - The headerField to set.

      • getArgumentParameter

        public String[] getArgumentParameter()
        Returns:
        Returns the argumentDirection.

      • setArgumentParameter

        public void setArgumentParameter​(String[] argumentDirection)
        Parameters:
        argumentDirection - The argumentDirection to set.

      • getHeaderParameter

        public String[] getHeaderParameter()
        Returns:
        Returns the headerParameter.

      • setHeaderParameter

        public void setHeaderParameter​(String[] headerParameter)
        Parameters:
        headerParameter - The headerParameter to set.

      • getUrl

        public String getUrl()
        Returns:
        Returns the procedure.

      • setUrl

        public void setUrl​(String procedure)
        Parameters:
        procedure - The procedure to set.

      • getFieldName

        public String getFieldName()
        Returns:
        Returns the resultName.

      • setFieldName

        public void setFieldName​(String resultName)
        Parameters:
        resultName - The resultName to set.

      • isUrlInField

        public boolean isUrlInField()
        Returns:
        Is the url coded in a field?

      • setUrlInField

        public void setUrlInField​(boolean urlInField)
        Parameters:
        urlInField - Is the url coded in a field?

      • getUrlField

        public String getUrlField()
        Returns:
        The field name that contains the url.

      • setUrlField

        public void setUrlField​(String urlField)
        Parameters:
        urlField - name of the field that contains the url

      • 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.)

      • allocate

        public void allocate​(int nrargs,
                     int nrqueryparams)

      • getFields

        public void getFields​(org.pentaho.di.core.row.RowMetaInterface inputRowMeta,
                      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:
        inputRowMeta - 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

      • 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

      • 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.

      • getEncoding

        public String getEncoding()
        Returns:
        the encoding

      • setEncoding

        public void setEncoding​(String encoding)
        Parameters:
        encoding - the encoding to set

      • setProxyHost

        public void setProxyHost​(String proxyHost)
        Setter
        Parameters:
        proxyHost -

      • getProxyHost

        public String getProxyHost()
        Getter
        Returns:

      • setProxyPort

        public void setProxyPort​(String proxyPort)
        Setter
        Parameters:
        proxyPort -

      • getProxyPort

        public String getProxyPort()
        Getter
        Returns:

      • setHttpLogin

        public void setHttpLogin​(String httpLogin)
        Setter
        Parameters:
        httpLogin -

      • getHttpLogin

        public String getHttpLogin()
        Getter
        Returns:

      • setHttpPassword

        public void setHttpPassword​(String httpPassword)
        Setter
        Parameters:
        httpPassword -

      • getHttpPassword

        public String getHttpPassword()
        Returns:

      • getResultCodeFieldName

        public String getResultCodeFieldName()
        Returns:
        the resultCodeFieldName

      • setResultCodeFieldName

        public void setResultCodeFieldName​(String resultCodeFieldName)
        Parameters:
        resultCodeFieldName - the resultCodeFieldName to set

      • getResponseTimeFieldName

        public String getResponseTimeFieldName()

      • setResponseTimeFieldName

        public void setResponseTimeFieldName​(String responseTimeFieldName)

      • getResponseHeaderFieldName

        public String getResponseHeaderFieldName()

      • setResponseHeaderFieldName

        public void setResponseHeaderFieldName​(String responseHeaderFieldName)