org.pentaho.di.trans.steps.http
Class HTTPMeta

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

public class HTTPMeta
extends BaseStepMeta
implements StepMetaInterface


Field Summary
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
HTTPMeta()
           
 
Method Summary
 void allocate(int nrargs, int nrqueryparams)
           
 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[] getArgumentField()
           
 String[] getArgumentParameter()
           
 String getEncoding()
           
 String getFieldName()
           
 void getFields(RowMetaInterface inputRowMeta, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 String[] getHeaderField()
           
 String[] getHeaderParameter()
           
 String getHttpLogin()
          Getter
 String getHttpPassword()
           
 String getProxyHost()
          Getter
 String getProxyPort()
          Getter
 String getResponseTimeFieldName()
           
 String getResultCodeFieldName()
           
 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 getUrl()
           
 String getUrlField()
           
 String getXML()
          Produces the XML string that describes this step's information.
 boolean isUrlInField()
           
 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 setArgumentField(String[] argument)
           
 void setArgumentParameter(String[] argumentDirection)
           
 void setDefault()
          Set default values
 void setEncoding(String encoding)
           
 void setFieldName(String resultName)
           
 void setHeaderField(String[] headerField)
           
 void setHeaderParameter(String[] headerParameter)
           
 void setHttpLogin(String httpLogin)
          Setter
 void setHttpPassword(String httpPassword)
          Setter
 void setProxyHost(String proxyHost)
          Setter
 void setProxyPort(String proxyPort)
          Setter
 void setResponseTimeFieldName(String responseTimeFieldName)
           
 void setResultCodeFieldName(String resultCodeFieldName)
           
 void setUrl(String procedure)
           
 void setUrlField(String urlField)
           
 void setUrlInField(boolean urlInField)
           
 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
 

Constructor Detail

HTTPMeta

public HTTPMeta()
Method Detail

getArgumentField

public String[] getArgumentField()
Returns:
Returns the argument.

setArgumentField

public void setArgumentField(String[] argument)
Parameters:
argument - The argument to set.

getHeaderField

public String[] getHeaderField()
Returns:
Returns the headerFields.

setHeaderField

public void setHeaderField(String[] headerField)
Parameters:
headerField - The headerField to set.

getArgumentParameter

public String[] getArgumentParameter()
Returns:
Returns the argumentDirection.

setArgumentParameter

public void setArgumentParameter(String[] argumentDirection)
Parameters:
argumentDirection - The argumentDirection to set.

getHeaderParameter

public String[] getHeaderParameter()
Returns:
Returns the headerParameter.

setHeaderParameter

public void setHeaderParameter(String[] headerParameter)
Parameters:
headerParameter - The headerParameter to set.

getUrl

public String getUrl()
Returns:
Returns the procedure.

setUrl

public void setUrl(String procedure)
Parameters:
procedure - The procedure to set.

getFieldName

public String getFieldName()
Returns:
Returns the resultName.

setFieldName

public void setFieldName(String resultName)
Parameters:
resultName - The resultName to set.

isUrlInField

public boolean isUrlInField()
Returns:
Is the url coded in a field?

setUrlInField

public void setUrlInField(boolean urlInField)
Parameters:
urlInField - Is the url coded in a field?

getUrlField

public String getUrlField()
Returns:
The field name that contains the url.

setUrlField

public void setUrlField(String urlField)
Parameters:
urlField - name of the field that contains the url

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

allocate

public void allocate(int nrargs,
                     int nrqueryparams)

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

setDefault

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

Specified by:
setDefault in interface StepMetaInterface

getFields

public void getFields(RowMetaInterface inputRowMeta,
                      String name,
                      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:
inputRowMeta - the input row meta
name - 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 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 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.

getEncoding

public String getEncoding()
Returns:
the encoding

setEncoding

public void setEncoding(String encoding)
Parameters:
encoding - the encoding to set

setProxyHost

public void setProxyHost(String proxyHost)
Setter

Parameters:
proxyHost -

getProxyHost

public String getProxyHost()
Getter

Returns:

setProxyPort

public void setProxyPort(String proxyPort)
Setter

Parameters:
proxyPort -

getProxyPort

public String getProxyPort()
Getter

Returns:

setHttpLogin

public void setHttpLogin(String httpLogin)
Setter

Parameters:
httpLogin -

getHttpLogin

public String getHttpLogin()
Getter

Returns:

setHttpPassword

public void setHttpPassword(String httpPassword)
Setter

Parameters:
httpPassword -

getHttpPassword

public String getHttpPassword()
Returns:

getResultCodeFieldName

public String getResultCodeFieldName()
Returns:
the resultCodeFieldName

setResultCodeFieldName

public void setResultCodeFieldName(String resultCodeFieldName)
Parameters:
resultCodeFieldName - the resultCodeFieldName to set

getResponseTimeFieldName

public String getResponseTimeFieldName()

setResponseTimeFieldName

public void setResponseTimeFieldName(String responseTimeFieldName)