Package org.pentaho.di.trans.steps.ldapinput

Class LDAPInputMeta

    • Field Detail

      • searchScopeDesc

        public static final String[] searchScopeDesc
        The search scopes description

      • searchScopeCode

        public static final String[] searchScopeCode
        The search scope codes

    • Constructor Detail

      • LDAPInputMeta

        public LDAPInputMeta()

    • Method Detail

      • isUseCertificate

        public boolean isUseCertificate()
        Specified by:
        isUseCertificate in interface LdapMeta
        Returns:
        Returns the input useCertificate.

      • setUseCertificate

        public void setUseCertificate​(boolean value)

      • isTrustAllCertificates

        public boolean isTrustAllCertificates()
        Specified by:
        isTrustAllCertificates in interface LdapMeta
        Returns:
        Returns the input trustAllCertificates.

      • setTrustAllCertificates

        public void setTrustAllCertificates​(boolean value)

      • setTrustStorePassword

        public void setTrustStorePassword​(String value)
        Parameters:
        value - the trustStorePassword to set.

      • setTrustStorePath

        public void setTrustStorePath​(String value)
        Parameters:
        value - the trustStorePath to set.

      • setProtocol

        public void setProtocol​(String value)
        Parameters:
        value - the protocol to set.

      • isDynamicSearch

        public boolean isDynamicSearch()
        Returns:
        Returns the input dynamicSearch.

      • setDynamicSearch

        public void setDynamicSearch​(boolean dynamicSearch)

      • getDynamicSearchFieldName

        public String getDynamicSearchFieldName()
        Returns:
        Returns the input dynamicSeachFieldName.

      • setDynamicSearchFieldName

        public void setDynamicSearchFieldName​(String dynamicSeachFieldName)

      • isDynamicFilter

        public boolean isDynamicFilter()
        Returns:
        Returns the input dynamicFilter.

      • setDynamicFilter

        public void setDynamicFilter​(boolean dynamicFilter)
        Parameters:
        dynamicFilter - the dynamicFilter to set.

      • getDynamicFilterFieldName

        public String getDynamicFilterFieldName()
        Returns:
        Returns the input dynamicFilterFieldName.

      • setDynamicFilterFieldName

        public void setDynamicFilterFieldName​(String dynamicFilterFieldName)
        param dynamicFilterFieldName the dynamicFilterFieldName to set.

      • UseAuthentication

        public boolean UseAuthentication()
        Returns:
        Returns the input useAuthentication.

      • setUseAuthentication

        public void setUseAuthentication​(boolean useAuthentication)
        Parameters:
        useAuthentication - The useAuthentication to set.

      • isPaging

        public boolean isPaging()
        Returns:
        Returns the input usePaging.

      • setPaging

        public void setPaging​(boolean usePaging)
        Parameters:
        usePaging - The usePaging to set.

      • getInputFields

        public LDAPInputField[] getInputFields()
        Returns:
        Returns the input fields.

      • setInputFields

        public void setInputFields​(LDAPInputField[] inputFields)
        Parameters:
        inputFields - The input fields to set.

      • includeRowNumber

        public boolean includeRowNumber()
        Returns:
        Returns the includeRowNumber.

      • setIncludeRowNumber

        public void setIncludeRowNumber​(boolean includeRowNumber)
        Parameters:
        includeRowNumber - The includeRowNumber to set.

      • getHost

        public String getHost()
        Specified by:
        getHost in interface LdapMeta
        Returns:
        Returns the host name.

      • setHost

        public void setHost​(String host)
        Parameters:
        host - The host to set.

      • getUserName

        public String getUserName()
        Returns:
        Returns the user name.

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

      • getPort

        public String getPort()
        Specified by:
        getPort in interface LdapMeta
        Returns:
        Returns the Port.

      • setPort

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

      • getFilterString

        public String getFilterString()
        Returns:
        Returns the filter string.

      • setFilterString

        public void setFilterString​(String filterString)
        Parameters:
        filterString - The filter string to set.

      • getSearchBase

        public String getSearchBase()
        Returns:
        Returns the search string.

      • setSearchBase

        public void setSearchBase​(String searchBase)
        Parameters:
        searchBase - The filter Search Base to set.

      • getRowLimit

        public int getRowLimit()
        Returns:
        Returns the rowLimit.

      • setTimeLimit

        public void setTimeLimit​(int timeLimit)
        Parameters:
        timeLimit - The timeout time limit to set.

      • getTimeLimit

        public int getTimeLimit()
        Returns:
        Returns the time limit.

      • setMultiValuedSeparator

        public void setMultiValuedSeparator​(String multiValuedSeparator)
        Parameters:
        multiValuedSeparator - The multi-valued separator filed.

      • getMultiValuedSeparator

        public String getMultiValuedSeparator()
        Returns:
        Returns the multi valued separator.

      • setPageSize

        public void setPageSize​(String pagesize)
        Parameters:
        pagesize - The pagesize.

      • getPageSize

        public String getPageSize()
        Returns:
        Returns the pagesize.

      • setRowLimit

        public void setRowLimit​(int rowLimit)
        Parameters:
        rowLimit - The rowLimit to set.

      • getRowNumberField

        public String getRowNumberField()
        Returns:
        Returns the rowNumberField.

      • setRowNumberField

        public void setRowNumberField​(String rowNumberField)
        Parameters:
        rowNumberField - The rowNumberField 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.)

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

      • allocate

        public void allocate​(int nrfields)

      • getFields

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

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

      • getSearchScopeDesc

        public static String getSearchScopeDesc​(int i)

      • getSearchScopeByDesc

        public static int getSearchScopeByDesc​(String tt)

      • setSearchScope

        public void setSearchScope​(int value)

      • getSearchScope

        public int getSearchScope()

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