LDAPInputMeta (PDI Engine 8.3.0.0-0.2.3 API)

java.lang.Object
- org.pentaho.di.trans.step.BaseStepMeta
- - org.pentaho.di.trans.steps.ldapinput.LDAPInputMeta

所有已实现的接口:

Cloneable, StepAttributesInterface, StepMetaInterface, LdapMeta
```
public class LDAPInputMeta
extends BaseStepMeta
implements LdapMeta
```

字段概要

字段
限定符和类型字段和说明

static String[] searchScopeCode
The search scope codes

static String[] searchScopeDesc
The search scopes description
- 从类继承的字段 org.pentaho.di.trans.step.BaseStepMeta
  attributes, databases, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE

字段
限定符和类型	字段和说明
`static String[]`	`searchScopeCode` The search scope codes
`static String[]`	`searchScopeDesc` The search scopes description

构造器概要

构造器
构造器和说明

LDAPInputMeta()

构造器
构造器和说明
`LDAPInputMeta()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`allocate(int nrfields)`
`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)` Checks the settings of this step and puts the findings in a remarks List.
`Object`	`clone()` Make an exact copy of this step, make sure to explicitly copy Collections etc.
`String`	`getDerefAliases()`
`String`	`getDynamicFilterFieldName()`
`String`	`getDynamicSearchFieldName()`
`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)` Gets the fields.
`String`	`getFilterString()`
`String`	`getHost()`
`LDAPInputField[]`	`getInputFields()`
`String`	`getMultiValuedSeparator()`
`String`	`getPageSize()`
`String`	`getPassword()`
`String`	`getPort()`
`String`	`getProtocol()`
`String`	`getReferrals()`
`int`	`getRowLimit()`
`String`	`getRowNumberField()`
`String`	`getSearchBase()`
`int`	`getSearchScope()`
`static int`	`getSearchScopeByDesc(String tt)`
`static String`	`getSearchScopeDesc(int i)`
`StepInterface`	`getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, Trans trans)` Get the executing step, needed by Trans to launch a step.
`StepDataInterface`	`getStepData()` Get a new instance of the appropriate data class.
`int`	`getTimeLimit()`
`String`	`getTrustStorePassword()`
`String`	`getTrustStorePath()`
`String`	`getUserName()`
`String`	`getXML()` Produces the XML string that describes this step's information.
`boolean`	`includeRowNumber()`
`boolean`	`isDynamicFilter()`
`boolean`	`isDynamicSearch()`
`boolean`	`isPaging()`
`boolean`	`isTrustAllCertificates()`
`boolean`	`isUseCertificate()`
`void`	`loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore)` Load the values for this step from an XML Node
`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)` Read the steps information from a Kettle repository
`void`	`saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step)` Save the steps data into a Kettle repository
`void`	`setDefault()` Set default values
`void`	`setDynamicFilter(boolean dynamicFilter)`
`void`	`setDynamicFilterFieldName(String dynamicFilterFieldName)` param dynamicFilterFieldName the dynamicFilterFieldName to set.
`void`	`setDynamicSearch(boolean dynamicSearch)`
`void`	`setDynamicSearchFieldName(String dynamicSeachFieldName)`
`void`	`setFilterString(String filterString)`
`void`	`setHost(String host)`
`void`	`setIncludeRowNumber(boolean includeRowNumber)`
`void`	`setInputFields(LDAPInputField[] inputFields)`
`void`	`setMultiValuedSeparator(String multiValuedSeparator)`
`void`	`setPageSize(String pagesize)`
`void`	`setPaging(boolean usePaging)`
`void`	`setPassword(String password)`
`void`	`setPort(String port)`
`void`	`setProtocol(String value)`
`void`	`setRowLimit(int rowLimit)`
`void`	`setRowNumberField(String rowNumberField)`
`void`	`setSearchBase(String searchBase)`
`void`	`setSearchScope(int value)`
`void`	`setTimeLimit(int timeLimit)`
`void`	`setTrustAllCertificates(boolean value)`
`void`	`setTrustStorePassword(String value)`
`void`	`setTrustStorePath(String value)`
`void`	`setUseAuthentication(boolean useAuthentication)`
`void`	`setUseCertificate(boolean value)`
`void`	`setUserName(String userName)`
`boolean`	`supportsErrorHandling()`
`String`	`toString()`
`boolean`	`UseAuthentication()`

从类继承的方法 org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadStepAttributes, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, setStepIOMeta

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.pentaho.di.trans.step.StepMetaInterface
analyseImpact, analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta

- 字段详细资料
  - searchScopeDesc
```
public static final String[] searchScopeDesc
```
    The search scopes description
  - searchScopeCode
```
public static final String[] searchScopeCode
```
    The search scope codes
- 构造器详细资料
  - LDAPInputMeta
```
public LDAPInputMeta()
```
- 方法详细资料
  - isUseCertificate
```
public boolean isUseCertificate()
```
    指定者:
    
    isUseCertificate 在接口中 LdapMeta
    
    返回:
    
    Returns the input useCertificate.
  - setUseCertificate
```
public void setUseCertificate(boolean value)
```
  - isTrustAllCertificates
```
public boolean isTrustAllCertificates()
```
    指定者:
    
    isTrustAllCertificates 在接口中 LdapMeta
    
    返回:
    
    Returns the input trustAllCertificates.
  - setTrustAllCertificates
```
public void setTrustAllCertificates(boolean value)
```
  - getTrustStorePassword
```
public String getTrustStorePassword()
```
    指定者:
    
    getTrustStorePassword 在接口中 LdapMeta
    
    返回:
    
    Returns the trustStorePath.
  - setTrustStorePassword
```
public void setTrustStorePassword(String value)
```
    参数:
    
    value - the trustStorePassword to set.
  - getTrustStorePath
```
public String getTrustStorePath()
```
    指定者:
    
    getTrustStorePath 在接口中 LdapMeta
    
    返回:
    
    Returns the trustStorePath.
  - setTrustStorePath
```
public void setTrustStorePath(String value)
```
    参数:
    
    value - the trustStorePath to set.
  - getProtocol
```
public String getProtocol()
```
    指定者:
    
    getProtocol 在接口中 LdapMeta
    
    返回:
    
    Returns the protocol.
  - setProtocol
```
public void setProtocol(String value)
```
    参数:
    
    value - the protocol to set.
  - isDynamicSearch
```
public boolean isDynamicSearch()
```
    返回:
    
    Returns the input dynamicSearch.
  - setDynamicSearch
```
public void setDynamicSearch(boolean dynamicSearch)
```
  - getDynamicSearchFieldName
```
public String getDynamicSearchFieldName()
```
    返回:
    
    Returns the input dynamicSeachFieldName.
  - setDynamicSearchFieldName
```
public void setDynamicSearchFieldName(String dynamicSeachFieldName)
```
  - isDynamicFilter
```
public boolean isDynamicFilter()
```
    返回:
    
    Returns the input dynamicFilter.
  - setDynamicFilter
```
public void setDynamicFilter(boolean dynamicFilter)
```
    参数:
    
    dynamicFilter - the dynamicFilter to set.
  - getDynamicFilterFieldName
```
public String getDynamicFilterFieldName()
```
    返回:
    
    Returns the input dynamicFilterFieldName.
  - setDynamicFilterFieldName
```
public void setDynamicFilterFieldName(String dynamicFilterFieldName)
```
    param dynamicFilterFieldName the dynamicFilterFieldName to set.
  - UseAuthentication
```
public boolean UseAuthentication()
```
    返回:
    
    Returns the input useAuthentication.
  - setUseAuthentication
```
public void setUseAuthentication(boolean useAuthentication)
```
    参数:
    
    useAuthentication - The useAuthentication to set.
  - isPaging
```
public boolean isPaging()
```
    返回:
    
    Returns the input usePaging.
  - setPaging
```
public void setPaging(boolean usePaging)
```
    参数:
    
    usePaging - The usePaging to set.
  - getInputFields
```
public LDAPInputField[] getInputFields()
```
    返回:
    
    Returns the input fields.
  - setInputFields
```
public void setInputFields(LDAPInputField[] inputFields)
```
    参数:
    
    inputFields - The input fields to set.
  - includeRowNumber
```
public boolean includeRowNumber()
```
    返回:
    
    Returns the includeRowNumber.
  - setIncludeRowNumber
```
public void setIncludeRowNumber(boolean includeRowNumber)
```
    参数:
    
    includeRowNumber - The includeRowNumber to set.
  - getHost
```
public String getHost()
```
    指定者:
    
    getHost 在接口中 LdapMeta
    
    返回:
    
    Returns the host name.
  - setHost
```
public void setHost(String host)
```
    参数:
    
    host - The host to set.
  - getUserName
```
public String getUserName()
```
    返回:
    
    Returns the user name.
  - setUserName
```
public void setUserName(String userName)
```
    参数:
    
    userName - The username to set.
  - setPassword
```
public void setPassword(String password)
```
    参数:
    
    password - The password to set.
  - getPassword
```
public String getPassword()
```
    返回:
    
    Returns the password.
  - getPort
```
public String getPort()
```
    指定者:
    
    getPort 在接口中 LdapMeta
    
    返回:
    
    Returns the Port.
  - setPort
```
public void setPort(String port)
```
    参数:
    
    port - The port to set.
  - getFilterString
```
public String getFilterString()
```
    返回:
    
    Returns the filter string.
  - setFilterString
```
public void setFilterString(String filterString)
```
    参数:
    
    filterString - The filter string to set.
  - getSearchBase
```
public String getSearchBase()
```
    返回:
    
    Returns the search string.
  - setSearchBase
```
public void setSearchBase(String searchBase)
```
    参数:
    
    searchBase - The filter Search Base to set.
  - getRowLimit
```
public int getRowLimit()
```
    返回:
    
    Returns the rowLimit.
  - setTimeLimit
```
public void setTimeLimit(int timeLimit)
```
    参数:
    
    timeLimit - The timeout time limit to set.
  - getTimeLimit
```
public int getTimeLimit()
```
    返回:
    
    Returns the time limit.
  - setMultiValuedSeparator
```
public void setMultiValuedSeparator(String multiValuedSeparator)
```
    参数:
    
    multiValuedSeparator - The multi-valued separator filed.
  - getMultiValuedSeparator
```
public String getMultiValuedSeparator()
```
    返回:
    
    Returns the multi valued separator.
  - setPageSize
```
public void setPageSize(String pagesize)
```
    参数:
    
    pagesize - The pagesize.
  - getPageSize
```
public String getPageSize()
```
    返回:
    
    Returns the pagesize.
  - setRowLimit
```
public void setRowLimit(int rowLimit)
```
    参数:
    
    rowLimit - The rowLimit to set.
  - getRowNumberField
```
public String getRowNumberField()
```
    返回:
    
    Returns the rowNumberField.
  - setRowNumberField
```
public void setRowNumberField(String rowNumberField)
```
    参数:
    
    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
```
    从接口复制的说明: StepMetaInterface
    
    Load the values for this step from an XML Node
    
    指定者:
    
    loadXML 在接口中 StepMetaInterface
    
    覆盖:
    
    loadXML 在类中 BaseStepMeta
    
    参数:
    
    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
    
    抛出:
    
    org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)
  - clone
```
public Object clone()
```
    从接口复制的说明: StepMetaInterface
    
    Make an exact copy of this step, make sure to explicitly copy Collections etc.
    
    指定者:
    
    clone 在接口中 StepMetaInterface
    
    覆盖:
    
    clone 在类中 BaseStepMeta
    
    返回:
    
    an exact copy of this step
  - getXML
```
public String getXML()
```
    从类复制的说明: BaseStepMeta
    
    Produces the XML string that describes this step's information.
    
    指定者:
    
    getXML 在接口中 StepMetaInterface
    
    覆盖:
    
    getXML 在类中 BaseStepMeta
    
    返回:
    
    String containing the XML describing this step.
  - allocate
```
public void allocate(int nrfields)
```
  - setDefault
```
public void setDefault()
```
    从接口复制的说明: StepMetaInterface
    
    Set default values
    
    指定者:
    
    setDefault 在接口中 StepMetaInterface
  - 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
```
    从类复制的说明: BaseStepMeta
    
    Gets the fields.
    
    指定者:
    
    getFields 在接口中 StepMetaInterface
    
    覆盖:
    
    getFields 在类中 BaseStepMeta
    
    参数:
    
    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
    
    抛出:
    
    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
```
    从接口复制的说明: StepMetaInterface
    
    Read the steps information from a Kettle repository
    
    指定者:
    
    readRep 在接口中 StepMetaInterface
    
    覆盖:
    
    readRep 在类中 BaseStepMeta
    
    参数:
    
    rep - The repository to read from
    
    metaStore - The MetaStore to read external information from
    
    id_step - The step ID
    
    databases - The databases to reference
    
    抛出:
    
    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
```
    从接口复制的说明: StepMetaInterface
    
    Save the steps data into a Kettle repository
    
    指定者:
    
    saveRep 在接口中 StepMetaInterface
    
    覆盖:
    
    saveRep 在类中 BaseStepMeta
    
    参数:
    
    rep - The Kettle repository to save to
    
    metaStore - the metaStore to optionally write to
    
    id_transformation - The transformation ID
    
    id_step - The step ID
    
    抛出:
    
    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)
```
    从接口复制的说明: StepMetaInterface
    
    Checks the settings of this step and puts the findings in a remarks List.
    
    指定者:
    
    check 在接口中 StepMetaInterface
    
    覆盖:
    
    check 在类中 BaseStepMeta
    
    参数:
    
    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)
```
    从接口复制的说明: StepMetaInterface
    
    Get the executing step, needed by Trans to launch a step.
    
    指定者:
    
    getStep 在接口中 StepMetaInterface
    
    参数:
    
    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()
```
    从接口复制的说明: 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.
    
    指定者:
    
    getStepData 在接口中 StepMetaInterface
    
    返回:
    
    The appropriate StepDataInterface class.
  - supportsErrorHandling
```
public boolean supportsErrorHandling()
```
    指定者:
    
    supportsErrorHandling 在接口中 StepMetaInterface
    
    覆盖:
    
    supportsErrorHandling 在类中 BaseStepMeta
    
    返回:
    
    true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - getDerefAliases
```
public String getDerefAliases()
```
    指定者:
    
    getDerefAliases 在接口中 LdapMeta
  - getReferrals
```
public String getReferrals()
```
    指定者:
    
    getReferrals 在接口中 LdapMeta

类 LDAPInputMeta

字段概要

从类继承的字段 org.pentaho.di.trans.step.BaseStepMeta

构造器概要

方法概要

从类继承的方法 org.pentaho.di.trans.step.BaseStepMeta

从类继承的方法 java.lang.Object

从接口继承的方法 org.pentaho.di.trans.step.StepMetaInterface

字段详细资料

searchScopeDesc

searchScopeCode

构造器详细资料

LDAPInputMeta

方法详细资料

isUseCertificate

setUseCertificate

isTrustAllCertificates

setTrustAllCertificates

getTrustStorePassword

setTrustStorePassword

getTrustStorePath

setTrustStorePath

getProtocol

setProtocol

isDynamicSearch

setDynamicSearch

getDynamicSearchFieldName

setDynamicSearchFieldName

isDynamicFilter

setDynamicFilter

getDynamicFilterFieldName

setDynamicFilterFieldName

UseAuthentication

setUseAuthentication

isPaging

setPaging

getInputFields

setInputFields

includeRowNumber

setIncludeRowNumber

getHost

setHost

getUserName

setUserName

setPassword

getPassword

getPort

setPort

getFilterString

setFilterString

getSearchBase

setSearchBase

getRowLimit

setTimeLimit

getTimeLimit

setMultiValuedSeparator

getMultiValuedSeparator

setPageSize

getPageSize

setRowLimit

getRowNumberField

setRowNumberField

loadXML

clone

getXML

allocate

setDefault

getFields

readRep

getSearchScopeDesc

getSearchScopeByDesc

setSearchScope

getSearchScope

saveRep

check

getStep

getStepData

supportsErrorHandling

toString

getDerefAliases