|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.di.trans.step.BaseStepMeta org.pentaho.di.trans.steps.ldapinput.LDAPInputMeta
public class LDAPInputMeta
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)
Gets the fields. |
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 java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String[] searchScopeDesc
public static final String[] searchScopeCode
Constructor Detail |
---|
public LDAPInputMeta()
Method Detail |
---|
public boolean isUseCertificate()
public void setUseCertificate(boolean value)
public boolean isTrustAllCertificates()
public void setTrustAllCertificates(boolean value)
public String getTrustStorePassword()
public void setTrustStorePassword(String value)
value
- the trustStorePassword to set.public String getTrustStorePath()
public void setTrustStorePath(String value)
value
- the trustStorePath to set.public String getProtocol()
public void setProtocol(String value)
value
- the protocol to set.public boolean isDynamicSearch()
public void setDynamicSearch(boolean dynamicSearch)
public String getDynamicSearchFieldName()
public void setDynamicSearchFieldName(String dynamicSeachFieldName)
public boolean isDynamicFilter()
public void setDynamicFilter(boolean dynamicFilter)
dynamicFilter
- the dynamicFilter to set.public String getDynamicFilterFieldName()
public void setDynamicFilterFieldName(String dynamicFilterFieldName)
public boolean UseAuthentication()
public void setUseAuthentication(boolean useAuthentication)
useAuthentication
- The useAuthentication to set.public boolean isPaging()
public void setPaging(boolean usePaging)
usePaging
- The usePaging to set.public LDAPInputField[] getInputFields()
public void setInputFields(LDAPInputField[] inputFields)
inputFields
- The input fields to set.public boolean includeRowNumber()
public void setIncludeRowNumber(boolean includeRowNumber)
includeRowNumber
- The includeRowNumber to set.public String getHost()
public void setHost(String host)
host
- The host to set.public String getUserName()
public void setUserName(String userName)
userName
- The username to set.public void setPassword(String password)
password
- The password to set.public String getPassword()
public String getPort()
public void setPort(String port)
port
- The port to set.public String getFilterString()
public void setFilterString(String filterString)
filterString
- The filter string to set.public String getSearchBase()
public void setSearchBase(String searchBase)
searchBase
- The filter Search Base to set.public int getRowLimit()
public void setTimeLimit(int timeLimit)
timeLimit
- The timeout time limit to set.public int getTimeLimit()
public void setMultiValuedSeparator(String multiValuedSeparator)
multiValuedSeparator
- The multi-valued separator filed.public String getMultiValuedSeparator()
public void setPageSize(String pagesize)
pagesize
- The pagesize.public String getPageSize()
public void setRowLimit(int rowLimit)
rowLimit
- The rowLimit to set.public String getRowNumberField()
public void setRowNumberField(String rowNumberField)
rowNumberField
- The rowNumberField to set.public void loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters) throws KettleXMLException
StepMetaInterface
loadXML
in interface StepMetaInterface
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tocounters
- Counters to reference.
KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)public Object clone()
StepMetaInterface
clone
in interface StepMetaInterface
clone
in class BaseStepMeta
public String getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
public void allocate(int nrfields)
public void setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
public void getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) throws KettleStepException
BaseStepMeta
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
r
- the input row metaname
- the nameinfo
- the infonextStep
- the next stepspace
- the space
KettleStepException
- the kettle step exceptionpublic void readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters) throws KettleException
StepMetaInterface
readRep
in interface StepMetaInterface
rep
- The repository to read fromid_step
- The step IDdatabases
- The databases to referencecounters
- The counters to reference
KettleException
- When an unexpected error occurred (database, network, etc)public static String getSearchScopeDesc(int i)
public static int getSearchScopeByDesc(String tt)
public void setSearchScope(int value)
public int getSearchScope()
public void saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step) throws KettleException
StepMetaInterface
saveRep
in interface StepMetaInterface
rep
- The Kettle repository to save toid_transformation
- The transformation IDid_step
- The step ID
KettleException
- When an unexpected error occurred (database, network, etc)public void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info)
StepMetaInterface
check
in interface StepMetaInterface
remarks
- The list to put the remarks in @see org.pentaho.di.core.CheckResultstepMeta
- The stepMeta to help checkingprev
- The fields coming from the previous stepinput
- The input step namesoutput
- The output step namesinfo
- The fields that are used as information by the steppublic StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, Trans trans)
StepMetaInterface
getStep
in interface StepMetaInterface
stepMeta
- The step infostepDataInterface
- the step data interface linked to this step. Here the step can store temporary data, database connections, etc.cnr
- The copy nr to gettr
- The transformation infotrans
- The launching transformationpublic StepDataInterface getStepData()
StepMetaInterface
getStepData
in interface StepMetaInterface
public boolean supportsErrorHandling()
supportsErrorHandling
in interface StepMetaInterface
supportsErrorHandling
in class BaseStepMeta
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |