org.pentaho.di.trans.steps.ldapoutput
Class LDAPOutputMeta

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.trans.steps.ldapoutput.LDAPOutputMeta
All Implemented Interfaces:
Cloneable, StepAttributesInterface, StepMetaInterface

public class LDAPOutputMeta
extends BaseStepMeta
implements StepMetaInterface


Field Summary
static int DEREFALIASES_TYPE_ALWAYS
           
static int DEREFALIASES_TYPE_FINDING
           
static int DEREFALIASES_TYPE_NEVER
           
static int DEREFALIASES_TYPE_SEARCHING
           
static String[] derefAliasesTypeCode
          The derefAliasess type codes
static String[] derefAliasesTypeDesc
          The derefAliasess description
static int OPERATION_TYPE_ADD
           
static int OPERATION_TYPE_DELETE
           
static int OPERATION_TYPE_INSERT
           
static int OPERATION_TYPE_RENAME
           
static int OPERATION_TYPE_UPDATE
           
static int OPERATION_TYPE_UPSERT
           
static String[] operationTypeCode
          The operations type codes
static String[] operationTypeDesc
          The operations description
static int REFERRAL_TYPE_FOLLOW
           
static int REFERRAL_TYPE_IGNORE
           
static String[] referralTypeCode
          The referrals type codes
static String[] referralTypeDesc
          The referrals description
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
LDAPOutputMeta()
           
 
Method Summary
 void allocate(int nrvalues)
           
 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.
static String getDerefAliasesCode(int i)
           
 int getDerefAliasesType()
           
static int getDerefAliasesTypeByDesc(String tt)
           
static String getDerefAliasesTypeDesc(int i)
           
 String getDnField()
           
 String getHost()
           
 String getMultiValuedSeparator()
           
 String getNewDnFieldName()
           
 String getOldDnFieldName()
           
 int getOperationType()
           
static int getOperationTypeByDesc(String tt)
           
static String getOperationTypeDesc(int i)
           
 String getPassword()
           
 String getPort()
           
 String getProtocol()
           
 int getReferralType()
           
static int getReferralTypeByDesc(String tt)
           
static String getReferralTypeCode(int i)
           
static String getReferralTypeDesc(int i)
           
 String getSearchBaseDN()
           
 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.
 String getTrustStorePassword()
           
 String getTrustStorePath()
           
 Boolean[] getUpdate()
           
 String[] getUpdateLookup()
           
 String[] getUpdateStream()
           
 String getUserName()
           
 String getXML()
          Produces the XML string that describes this step's information.
 boolean isDeleteRDN()
           
 boolean isFailIfNotExist()
           
 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 setDeleteRDN(boolean value)
           
 void setDerefAliasesType(int value)
           
 void setDnField(String value)
           
 void setFailIfNotExist(boolean value)
           
 void setHost(String host)
           
 void setMultiValuedSeparator(String multiValuedSeparator)
           
 void setNewDnFieldName(String value)
           
 void setOldDnFieldName(String value)
           
 void setOperationType(int operationType)
           
 void setPassword(String password)
           
 void setPort(String port)
           
 void setProtocol(String value)
           
 void setReferralType(int value)
           
 void setSearchBaseDN(String searchBase)
           
 void setTrustAllCertificates(boolean value)
           
 void setTrustStorePassword(String value)
           
 void setTrustStorePath(String value)
           
 void setUpdate(Boolean[] update)
           
 void setUpdateLookup(String[] updateLookup)
           
 void setUpdateStream(String[] updateStream)
           
 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, getFields, 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, getFields, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta
 

Field Detail

operationTypeDesc

public static final String[] operationTypeDesc
The operations description


operationTypeCode

public static final String[] operationTypeCode
The operations type codes


OPERATION_TYPE_INSERT

public static final int OPERATION_TYPE_INSERT
See Also:
Constant Field Values

OPERATION_TYPE_UPSERT

public static final int OPERATION_TYPE_UPSERT
See Also:
Constant Field Values

OPERATION_TYPE_UPDATE

public static final int OPERATION_TYPE_UPDATE
See Also:
Constant Field Values

OPERATION_TYPE_ADD

public static final int OPERATION_TYPE_ADD
See Also:
Constant Field Values

OPERATION_TYPE_DELETE

public static final int OPERATION_TYPE_DELETE
See Also:
Constant Field Values

OPERATION_TYPE_RENAME

public static final int OPERATION_TYPE_RENAME
See Also:
Constant Field Values

referralTypeDesc

public static final String[] referralTypeDesc
The referrals description


referralTypeCode

public static final String[] referralTypeCode
The referrals type codes


REFERRAL_TYPE_FOLLOW

public static final int REFERRAL_TYPE_FOLLOW
See Also:
Constant Field Values

REFERRAL_TYPE_IGNORE

public static final int REFERRAL_TYPE_IGNORE
See Also:
Constant Field Values

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

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

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

setUseAuthentication

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

setDnField

public void setDnField(String value)

getDnField

public String getDnField()

getPort

public String getPort()
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<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

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.

setDefault

public void setDefault()
Description copied from interface: StepMetaInterface
Set default values

Specified by:
setDefault in interface StepMetaInterface

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)

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