Package org.pentaho.di.trans.steps.ldapoutput

Class LDAPOutputMeta

    • Field Detail

      • operationTypeDesc

        public static final String[] operationTypeDesc
        The operations description

      • operationTypeCode

        public static final String[] operationTypeCode
        The operations type codes

      • referralTypeDesc

        public static final String[] referralTypeDesc
        The referrals description

      • referralTypeCode

        public static final String[] referralTypeCode
        The referrals type codes

      • derefAliasesTypeDesc

        public static final String[] derefAliasesTypeDesc
        The derefAliasess description

      • derefAliasesTypeCode

        public static final String[] derefAliasesTypeCode
        The derefAliasess type codes

      • DEREFALIASES_TYPE_ALWAYS

        public static final int DEREFALIASES_TYPE_ALWAYS
        See Also:
        Constant Field Values

      • DEREFALIASES_TYPE_NEVER

        public static final int DEREFALIASES_TYPE_NEVER
        See Also:
        Constant Field Values

      • DEREFALIASES_TYPE_SEARCHING

        public static final int DEREFALIASES_TYPE_SEARCHING
        See Also:
        Constant Field Values

      • DEREFALIASES_TYPE_FINDING

        public static final int DEREFALIASES_TYPE_FINDING
        See Also:
        Constant Field Values

    • Constructor Detail

      • LDAPOutputMeta

        public LDAPOutputMeta()

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

      • getUpdate

        public Boolean[] getUpdate()

      • setUpdate

        public void setUpdate​(Boolean[] update)

      • getOperationType

        public int getOperationType()

      • getReferralType

        public int getReferralType()

      • getDerefAliasesType

        public int getDerefAliasesType()

      • getOperationTypeByDesc

        public static int getOperationTypeByDesc​(String tt)

      • getReferralTypeByDesc

        public static int getReferralTypeByDesc​(String tt)

      • getDerefAliasesTypeByDesc

        public static int getDerefAliasesTypeByDesc​(String tt)

      • setOperationType

        public void setOperationType​(int operationType)

      • setReferralType

        public void setReferralType​(int value)

      • setDerefAliasesType

        public void setDerefAliasesType​(int value)

      • getOperationTypeDesc

        public static String getOperationTypeDesc​(int i)

      • getReferralTypeDesc

        public static String getReferralTypeDesc​(int i)

      • getDerefAliasesTypeDesc

        public static String getDerefAliasesTypeDesc​(int i)

      • getUpdateStream

        public String[] getUpdateStream()
        Returns:
        Returns the updateStream.

      • setUpdateStream

        public void setUpdateStream​(String[] updateStream)
        Parameters:
        updateStream - The updateStream to set.

      • getUpdateLookup

        public String[] getUpdateLookup()
        Returns:
        Returns the updateLookup.

      • setUpdateLookup

        public void setUpdateLookup​(String[] updateLookup)
        Parameters:
        updateLookup - The updateLookup to set.

      • UseAuthentication

        @Deprecated
public boolean UseAuthentication()
        Deprecated.
        Returns:
        Returns the input useAuthentication. Deprecated as it doesn't follow standards

      • getUseAuthentication

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

      • setUseAuthentication

        public void setUseAuthentication​(boolean useAuthentication)
        Parameters:
        useAuthentication - The useAuthentication 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.

      • setDnField

        public void setDnField​(String value)

      • getDnField

        public String getDnField()

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

      • isFailIfNotExist

        public boolean isFailIfNotExist()
        Returns:
        Returns the failIfNotExist.

      • setFailIfNotExist

        public void setFailIfNotExist​(boolean value)
        Parameters:
        failIfNotExist - The failIfNotExist 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.)

      • setDeleteRDN

        public void setDeleteRDN​(boolean value)
        Parameters:
        value - The deleteRDN filed.

      • isDeleteRDN

        public boolean isDeleteRDN()
        Returns:
        Returns the deleteRDN.

      • setNewDnFieldName

        public void setNewDnFieldName​(String value)
        Parameters:
        value - The newDnFieldName filed.

      • getNewDnFieldName

        public String getNewDnFieldName()
        Returns:
        Returns the newDnFieldName.

      • setOldDnFieldName

        public void setOldDnFieldName​(String value)
        Parameters:
        value - The oldDnFieldName filed.

      • getOldDnFieldName

        public String getOldDnFieldName()
        Returns:
        Returns the oldDnFieldName.

      • setSearchBaseDN

        public void setSearchBaseDN​(String searchBase)
        Parameters:
        searchBase - The searchBase filed.

      • getSearchBaseDN

        public String getSearchBaseDN()
        Returns:
        Returns the searchBase.

      • setMultiValuedSeparator

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

      • getMultiValuedSeparator

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

      • allocate

        public void allocate​(int nrvalues)

      • getReferralTypeCode

        public static String getReferralTypeCode​(int i)

      • getDerefAliasesCode

        public static String getDerefAliasesCode​(int i)

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