Package org.pentaho.di.trans.steps.rest

Class RestMeta

    • Constructor Detail

      • RestMeta

        public RestMeta()

    • Method Detail

      • getMethod

        public String getMethod()
        Returns:
        Returns the method.

      • setMethod

        public void setMethod​(String value)
        Parameters:
        value - The method to set.

      • getBodyField

        public String getBodyField()
        Returns:
        Returns the bodyField.

      • setBodyField

        public void setBodyField​(String value)
        Parameters:
        value - The bodyField to set.

      • getHeaderName

        public String[] getHeaderName()
        Returns:
        Returns the headerName.

      • setHeaderName

        public void setHeaderName​(String[] value)
        Parameters:
        value - The headerName to set.

      • getParameterField

        public String[] getParameterField()
        Returns:
        Returns the parameterField.

      • setParameterField

        public void setParameterField​(String[] value)
        Parameters:
        value - The parameterField to set.

      • getParameterName

        public String[] getParameterName()
        Returns:
        Returns the parameterName.

      • setParameterName

        public void setParameterName​(String[] value)
        Parameters:
        value - The parameterName to set.

      • getMatrixParameterField

        public String[] getMatrixParameterField()
        Returns:
        Returns the matrixParameterField.

      • setMatrixParameterField

        public void setMatrixParameterField​(String[] value)
        Parameters:
        value - The matrixParameterField to set.

      • getMatrixParameterName

        public String[] getMatrixParameterName()
        Returns:
        Returns the matrixParameterName.

      • setMatrixParameterName

        public void setMatrixParameterName​(String[] value)
        Parameters:
        value - The matrixParameterName to set.

      • getHeaderField

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

      • setHeaderField

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

      • getUrl

        public String getUrl()
        Returns:
        Returns the procedure.

      • setUrl

        public void setUrl​(String procedure)
        Parameters:
        procedure - The procedure 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?

      • isPreemptive

        public boolean isPreemptive()
        Returns:
        Is preemptive?

      • setPreemptive

        public void setPreemptive​(boolean preemptive)
        Parameters:
        preemptive - Ispreemptive?

      • isDynamicMethod

        public boolean isDynamicMethod()
        Returns:
        Is the method defined in a field?

      • setDynamicMethod

        public void setDynamicMethod​(boolean dynamicMethod)
        Parameters:
        dynamicMethod - If the method is defined in a field?

      • getMethodFieldName

        public String getMethodFieldName()
        Returns:
        methodFieldName

      • setMethodFieldName

        public void setMethodFieldName​(String methodFieldName)
        Parameters:
        methodFieldName -

      • 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

      • getFieldName

        public String getFieldName()
        Returns:
        Returns the resultName.

      • setFieldName

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

      • 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

        @Deprecated
public void allocate​(int nrheaders,
                     int nrparamers)
        Deprecated.

      • allocate

        public void allocate​(int nrheaders,
                     int nrparamers,
                     int nrmatrixparameters)

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

      • getResultCodeFieldName

        public String getResultCodeFieldName()
        Returns:
        the resultCodeFieldName

      • setResultCodeFieldName

        public void setResultCodeFieldName​(String resultCodeFieldName)
        Parameters:
        resultCodeFieldName - the resultCodeFieldName 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:

      • setApplicationType

        public void setApplicationType​(String applicationType)
        Setter
        Parameters:
        applicationType -

      • getApplicationType

        public String getApplicationType()
        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:

      • setTrustStoreFile

        public void setTrustStoreFile​(String trustStoreFile)
        Setter
        Parameters:
        trustStoreFile -

      • getTrustStoreFile

        public String getTrustStoreFile()
        Returns:
        trustStoreFile

      • setTrustStorePassword

        public void setTrustStorePassword​(String trustStorePassword)
        Setter
        Parameters:
        trustStorePassword -

      • getTrustStorePassword

        public String getTrustStorePassword()
        Returns:
        trustStorePassword

      • getResponseTimeFieldName

        public String getResponseTimeFieldName()

      • setResponseTimeFieldName

        public void setResponseTimeFieldName​(String responseTimeFieldName)

      • getResponseHeaderFieldName

        public String getResponseHeaderFieldName()

      • setResponseHeaderFieldName

        public void setResponseHeaderFieldName​(String responseHeaderFieldName)

      • isActiveBody

        public static boolean isActiveBody​(String method)

      • isActiveParameters

        public static boolean isActiveParameters​(String method)