org.pentaho.di.trans.steps.symmetriccrypto.symmetriccryptotrans
Class SymmetricCryptoTransMeta

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

public class SymmetricCryptoTransMeta
extends BaseStepMeta
implements StepMetaInterface

Symmetric algorithm Executes a SymmetricCryptoTrans on the values in the input stream. Selected calculated values can then be put on the output stream.

Since:
5-apr-2003
Author:
Samatar

Field Summary
static int OPERATION_TYPE_DECRYPT
           
static int OPERATION_TYPE_ENCRYPT
           
static String[] operationTypeCode
          The operations type codes
static String[] operationTypeDesc
          The operations description
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
SymmetricCryptoTransMeta()
           
 
Method Summary
 void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, 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 getAlgorithm()
           
 void getFields(RowMetaInterface rowMeta, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 String getMessageFied()
           
 int getOperationType()
           
static int getOperationTypeByDesc(String tt)
           
static String getOperationTypeDesc(int i)
           
 String getResultfieldname()
           
 String getSchema()
           
 String getSecretKey()
           
 String getSecretKeyField()
           
 StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, 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 getXML()
          Produces the XML string that describes this step's information.
 boolean isOutputResultAsBinary()
           
 boolean isReadKeyAsBinary()
           
 boolean isSecretKeyInField()
           
 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 setAlgorithm(String algorithm)
           
 void setDefault()
          Set default values
 void setMessageField(String fieldnamein)
           
 void setOperationType(int operationType)
           
 void setOutputResultAsBinary(boolean outputResultAsBinary)
           
 void setReadKeyAsBinary(boolean readKeyAsBinary)
           
 void setResultfieldname(String resultfield)
           
 void setSchema(String schema)
           
 void setSecretKey(String secretKeyin)
           
 void setsecretKeyField(String secretKeyField)
           
 void setSecretKeyInField(boolean secretKeyInField)
           
 boolean supportsErrorHandling()
           
 
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, toString, 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

operationTypeDesc

public static final String[] operationTypeDesc
The operations description


operationTypeCode

public static final String[] operationTypeCode
The operations type codes


OPERATION_TYPE_ENCRYPT

public static final int OPERATION_TYPE_ENCRYPT
See Also:
Constant Field Values

OPERATION_TYPE_DECRYPT

public static final int OPERATION_TYPE_DECRYPT
See Also:
Constant Field Values
Constructor Detail

SymmetricCryptoTransMeta

public SymmetricCryptoTransMeta()
Method Detail

getOperationType

public int getOperationType()

getOperationTypeByDesc

public static int getOperationTypeByDesc(String tt)

setOperationType

public void setOperationType(int operationType)

getOperationTypeDesc

public static String getOperationTypeDesc(int i)

getSecretKeyField

public String getSecretKeyField()
Returns:
Returns the XSL filename.

setSecretKey

public void setSecretKey(String secretKeyin)

getSecretKey

public String getSecretKey()

getResultfieldname

public String getResultfieldname()

getMessageFied

public String getMessageFied()

getAlgorithm

public String getAlgorithm()

setAlgorithm

public void setAlgorithm(String algorithm)
Parameters:
algorithm - The algorithm to set.

isReadKeyAsBinary

public boolean isReadKeyAsBinary()

setReadKeyAsBinary

public void setReadKeyAsBinary(boolean readKeyAsBinary)
Parameters:
readKeyAsBinary - The readKeyAsBinary to set.

isOutputResultAsBinary

public boolean isOutputResultAsBinary()

setOutputResultAsBinary

public void setOutputResultAsBinary(boolean outputResultAsBinary)
Parameters:
outputResultAsBinary - The outputResultAsBinary to set.

getSchema

public String getSchema()

setSchema

public void setSchema(String schema)
Parameters:
schema - The schema to set.

setsecretKeyField

public void setsecretKeyField(String secretKeyField)
Parameters:
secretKeyField - The secretKeyField to set.

setResultfieldname

public void setResultfieldname(String resultfield)

setMessageField

public void setMessageField(String fieldnamein)

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

isSecretKeyInField

public boolean isSecretKeyInField()

setSecretKeyInField

public void setSecretKeyInField(boolean secretKeyInField)

setDefault

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

Specified by:
setDefault in interface StepMetaInterface

getFields

public void getFields(RowMetaInterface rowMeta,
                      String origin,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws KettleStepException
Description copied from class: BaseStepMeta
Gets the fields.

Specified by:
getFields in interface StepMetaInterface
Overrides:
getFields in class BaseStepMeta
Parameters:
rowMeta - the input row meta
origin - the name
info - the info
nextStep - the next step
space - the space
Throws:
KettleStepException - the kettle step exception

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,
                    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 stepinfo,
                  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
stepinfo - 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 transMeta,
                             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
transMeta - 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.