org.pentaho.di.trans.steps.ldapinput
Class LDAPInputMeta

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

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class LDAPInputMeta
extends BaseStepMeta
implements StepMetaInterface

Field Summary

static String[]	searchScopeCode The search scope codes
static String[]	searchScopeDesc The search scopes description

Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

LDAPInputMeta()

Method Summary

void	allocate(int nrfields)
void	check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info) 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	getDynamicFilterFieldName()
String	getDynamicSearchFieldName()
void	getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) Get the fields that are emitted by this step
String	getFilterString()
String	getHost()
LDAPInputField[]	getInputFields()
String	getMultiValuedSeparator()
String	getPageSize()
String	getPassword()
String	getPort()
String	getProtocol()
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<DatabaseMeta> databases, Map<String,Counter> counters) Load the values for this step from an XML Node
void	readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters) Read the steps information from a Kettle repository
void	saveRep(Repository rep, ObjectId id_transformation, 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()

Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta

analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isRowLevel, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface

analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta

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

Returns:

Returns the input useCertificate.

setUseCertificate

public void setUseCertificate(boolean value)

isTrustAllCertificates

public boolean isTrustAllCertificates()

Returns:

Returns the input trustAllCertificates.

setTrustAllCertificates

public void setTrustAllCertificates(boolean value)

getTrustStorePassword

public String getTrustStorePassword()

Returns:

Returns the trustStorePath.

setTrustStorePassword

public void setTrustStorePassword(String value)

Parameters:

value - the trustStorePassword to set.

getTrustStorePath

public String getTrustStorePath()

Returns:

Returns the trustStorePath.

setTrustStorePath

public void setTrustStorePath(String value)

Parameters:

value - the trustStorePath to set.

getProtocol

public String getProtocol()

Returns:

Returns the protocol.

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

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

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<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleXMLException

Description copied from interface: StepMetaInterface

Load the values for this step from an XML Node

Specified by:

loadXML in interface StepMetaInterface

Parameters:

stepnode - the Node to get the info from

databases - The available list of databases to reference to

counters - Counters to reference.

Throws:

KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

clone

public Object clone()

Description copied from interface: StepMetaInterface

Make an exact copy of this step, make sure to explicitly copy Collections etc.

Specified by:

clone in interface StepMetaInterface

Overrides:

clone in class BaseStepMeta

Returns:

an exact copy of this step

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)

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

getFields

public void getFields(RowMetaInterface r,
                      String name,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws KettleStepException

Description copied from interface: StepMetaInterface

Get the fields that are emitted by this step

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

r - The fields that are entering the step. These are changed to reflect the output metadata.

name - The name of the step to be used as origin

info - The input rows metadata that enters the step through the specified channels in the same order as in method getInfoSteps(). The step metadata can then choose what to do with it: ignore it or not. Interesting is also that in case of database lookups, the layout of the target database table is put in info[0]

nextStep - if this is a non-null value, it's the next step in the transformation. The one who's asking, the step where the data is targetted towards.

space - TODO

Throws:

KettleStepException - when an error occurred searching for the fields.

readRep

public void readRep(Repository rep,
                    ObjectId id_step,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleException

Description copied from interface: StepMetaInterface

Read the steps information from a Kettle repository

Specified by:

readRep in interface StepMetaInterface

Parameters:

rep - The repository to read from

id_step - The step ID

databases - The databases to reference

counters - The counters to reference

Throws:

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,
                    ObjectId id_transformation,
                    ObjectId id_step)
             throws KettleException

Description copied from interface: StepMetaInterface

Save the steps data into a Kettle repository

Specified by:

saveRep in interface StepMetaInterface

Parameters:

rep - The Kettle repository to save to

id_transformation - The transformation ID

id_step - The step ID

Throws:

KettleException - When an unexpected error occurred (database, network, etc)

check

public void check(List<CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  RowMetaInterface info)

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

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

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.

supportsErrorHandling

public boolean supportsErrorHandling()

Specified by:

supportsErrorHandling in interface StepMetaInterface

Overrides:

supportsErrorHandling in class BaseStepMeta

Returns:

true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.

toString

public String toString()

Overrides:

toString in class Object