org.pentaho.di.job.entries.http

Class JobEntryHTTP

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

org.pentaho.di.job.entries.http.JobEntryHTTP

All Implemented Interfaces:

Cloneable, org.pentaho.di.core.AttributesInterface, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.ExtensionDataInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryHTTP
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines an HTTP job entry.

Since:

05-11-2003

Author:

Matt

Constructor Summary

Constructors

Constructor and Description
JobEntryHTTP()
JobEntryHTTP(String n)

Method Summary

Modifier and Type	Method and Description
void	check(List<org.pentaho.di.core.CheckResultInterface> remarks, JobMeta jobMeta, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Allows JobEntry objects to check themselves for consistency
Object	clone() This method is called when a job entry is duplicated in Spoon.
boolean	evaluates() This method must return true if the job entry supports the true/false outgoing hops.
org.pentaho.di.core.Result	execute(org.pentaho.di.core.Result previousResult, int nr) We made this one synchronized in the JVM because otherwise, this is not thread safe.
String	getDestinationFieldname()
String[]	getHeaderName()
String[]	getHeaderValue()
String	getNonProxyHosts()
String	getPassword()
String	getProxyHostname()
String	getProxyPort()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Gets a list of all the resource dependencies that the step is depending on.
String	getTargetFilename()
String	getTargetFilenameExtension()
String	getTargetFilenameExtention() Deprecated. Use getTargetFilenameExtension() instead
String	getUploadFieldname()
String	getUploadFilename()
String	getUrl()
String	getUrlFieldname()
String	getUsername()
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
boolean	isAddFilenameToResult()
boolean	isDateTimeAdded()
boolean	isFileAppended()
boolean	isRunForEveryRow()
void	loadRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_jobentry, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers) This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository.
void	loadXML(Node entrynode, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore) This method is called by PDI whenever a job entry needs to read its settings from XML.
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_job) This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
void	setAddFilenameToResult(boolean addfilenameresult)
void	setDateTimeAdded(boolean dateTimeAdded)
void	setDestinationFieldname(String destinationFieldname)
void	setFileAppended(boolean fileAppended)
void	setHeaderName(String[] headerName)
void	setHeaderValue(String[] headerValue)
void	setNonProxyHosts(String nonProxyHosts)
void	setPassword(String password)
void	setProxyHostname(String proxyHostname)
void	setProxyPort(String proxyPort)
void	setRunForEveryRow(boolean runForEveryRow)
void	setTargetFilename(String targetFilename)
void	setTargetFilenameExtension(String uploadFilenameExtension)
void	setTargetFilenameExtention(String uploadFilenameExtension) Deprecated. Use setTargetFilenameExtension( String uploadFilenameExtension ) instead
void	setUploadFieldname(String uploadFieldname)
void	setUploadFilename(String uploadFilename)
void	setUrl(String url)
void	setUrlFieldname(String getFieldname)
void	setUsername(String username)

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase

check, clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, exportResources, fieldSubstitute, getAttribute, getAttributes, getAttributesMap, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getExtensionDataMap, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentVariableSpace, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getRepository, getRepositoryDirectory, getSQLStatements, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isMail, isReferencedObjectEnabled, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadReferencedObject, loadReferencedObject, loadRep, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, saveRep, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setForcingSeparateLogging, setGatheringMetrics, setID, setLogLevel, setMetaStore, setName, setObjectId, setParentJob, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface

check, clear, exportResources, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getObjectId, getParentJob, getPluginId, getRealFilename, getReferencedObjectDescriptions, getSQLStatements, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, hasRepositoryReferences, isDummy, isEvaluation, isJob, isMail, isReferencedObjectEnabled, isShell, isSpecial, isStart, isTransformation, isUnconditional, loadReferencedObject, loadReferencedObject, loadRep, loadXML, lookupRepositoryReferences, resetErrorsBeforeExecution, saveRep, setChanged, setChanged, setDescription, setMetaStore, setName, setObjectId, setParentJob, setPluginId, setRepository

Constructor Detail

JobEntryHTTP

public JobEntryHTTP(String n)

JobEntryHTTP

public JobEntryHTTP()

Method Detail

clone

public Object clone()

Description copied from class: JobEntryBase

This method is called when a job entry is duplicated in Spoon. It needs to return a deep copy of this job entry object. It is essential that the implementing class creates proper deep copies if the job entry configuration is stored in modifiable objects, such as lists or custom helper objects.

Specified by:

clone in interface JobEntryInterface

Overrides:

clone in class JobEntryBase

Returns:

a clone of the object

getXML

public String getXML()

Description copied from class: JobEntryBase

This method is called by PDI whenever a job entry needs to serialize its settings to XML. It is called when saving a job in Spoon. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.pentaho.di.core.xml.XMLHandler is typically used to construct the XML string.

Specified by:

getXML in interface JobEntryInterface

Overrides:

getXML in class JobEntryBase

Returns:

the xml representation of the job entry

loadXML

public void loadXML(Node entrynode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.KettleXMLException

Description copied from interface: JobEntryInterface

This method is called by PDI whenever a job entry needs to read its settings from XML. The XML node containing the job entry's settings is passed in as an argument. Again, the helper class org.pentaho.di.core.xml.XMLHandler is typically used to conveniently read the settings from the XML node.

Specified by:

loadXML in interface JobEntryInterface

Overrides:

loadXML in class JobEntryBase

Parameters:

entrynode - the top-level XML node

databases - the list of databases

slaveServers - the list of slave servers

rep - the repository object

metaStore - The metaStore to optionally load from.

Throws:

org.pentaho.di.core.exception.KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_jobentry,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws org.pentaho.di.core.exception.KettleException

Description copied from interface: JobEntryInterface

This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. The job entry id given in the arguments should be used as the identifier when using the repository's serialization methods.

Specified by:

loadRep in interface JobEntryInterface

Overrides:

loadRep in class JobEntryBase

Parameters:

rep - the repository object

metaStore - the MetaStore to use

id_jobentry - the id of the job entry

databases - the list of databases

slaveServers - the list of slave servers

Throws:

org.pentaho.di.core.exception.KettleException - if any errors occur during the load

saveRep

public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_job)
             throws org.pentaho.di.core.exception.KettleException

Description copied from interface: JobEntryInterface

This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. The repository object passed in as the first argument provides a convenient set of methods for serializing job entry settings. When calling repository serialization methods, job id and job entry id are required. The job id is passed in to saveRep() as an argument, and the job entry id can be obtained by a call to getObjectId() inherited from the base class.

Specified by:

saveRep in interface JobEntryInterface

Overrides:

saveRep in class JobEntryBase

Parameters:

rep - the repository

metaStore - the MetaStore to use

id_job - the id_job

Throws:

org.pentaho.di.core.exception.KettleException - if any errors occur during the save

getUrl

public String getUrl()

Returns:

Returns the URL.

setUrl

public void setUrl(String url)

Parameters:

url - The URL to set.

getTargetFilename

public String getTargetFilename()

Returns:

Returns the target filename.

setTargetFilename

public void setTargetFilename(String targetFilename)

Parameters:

targetFilename - The target filename to set.

getNonProxyHosts

public String getNonProxyHosts()

setNonProxyHosts

public void setNonProxyHosts(String nonProxyHosts)

isAddFilenameToResult

public boolean isAddFilenameToResult()

setAddFilenameToResult

public void setAddFilenameToResult(boolean addfilenameresult)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getProxyHostname

public String getProxyHostname()

setProxyHostname

public void setProxyHostname(String proxyHostname)

getProxyPort

public String getProxyPort()

setProxyPort

public void setProxyPort(String proxyPort)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getHeaderName

public String[] getHeaderName()

setHeaderName

public void setHeaderName(String[] headerName)

getHeaderValue

public String[] getHeaderValue()

setHeaderValue

public void setHeaderValue(String[] headerValue)

execute

public org.pentaho.di.core.Result execute(org.pentaho.di.core.Result previousResult,
                                          int nr)

We made this one synchronized in the JVM because otherwise, this is not thread safe. In that case if (on an application server for example) several HTTP's are running at the same time, you get into problems because the System.setProperty() calls are system wide!

Specified by:

execute in interface JobEntryInterface

Parameters:

previousResult - the previous result

nr - the number of rows

Returns:

the Result object from execution of this job entry

evaluates

public boolean evaluates()

Description copied from class: JobEntryBase

This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false

Specified by:

evaluates in interface JobEntryInterface

Overrides:

evaluates in class JobEntryBase

Returns:

false

getUploadFilename

public String getUploadFilename()

setUploadFilename

public void setUploadFilename(String uploadFilename)

getUrlFieldname

public String getUrlFieldname()

Returns:

Returns the Result URL Fieldname.

setUrlFieldname

public void setUrlFieldname(String getFieldname)

Parameters:

getFieldname - The Result URL Fieldname to set.

getUploadFieldname

public String getUploadFieldname()

setUploadFieldname

public void setUploadFieldname(String uploadFieldname)

getDestinationFieldname

public String getDestinationFieldname()

setDestinationFieldname

public void setDestinationFieldname(String destinationFieldname)

isRunForEveryRow

public boolean isRunForEveryRow()

Returns:

Returns the runForEveryRow.

setRunForEveryRow

public void setRunForEveryRow(boolean runForEveryRow)

Parameters:

runForEveryRow - The runForEveryRow to set.

isFileAppended

public boolean isFileAppended()

Returns:

Returns the fileAppended.

setFileAppended

public void setFileAppended(boolean fileAppended)

Parameters:

fileAppended - The fileAppended to set.

isDateTimeAdded

public boolean isDateTimeAdded()

Returns:

Returns the dateTimeAdded.

setDateTimeAdded

public void setDateTimeAdded(boolean dateTimeAdded)

Parameters:

dateTimeAdded - The dateTimeAdded to set.

getTargetFilenameExtension

public String getTargetFilenameExtension()

Returns:

Returns the uploadFilenameExtension.

setTargetFilenameExtension

public void setTargetFilenameExtension(String uploadFilenameExtension)

Parameters:

uploadFilenameExtension - The uploadFilenameExtension to set.

getTargetFilenameExtention

@Deprecated
public String getTargetFilenameExtention()

Deprecated. Use getTargetFilenameExtension() instead

Returns:

Returns the uploadFilenameExtension.

setTargetFilenameExtention

@Deprecated
public void setTargetFilenameExtention(String uploadFilenameExtension)

Deprecated. Use setTargetFilenameExtension( String uploadFilenameExtension ) instead

Parameters:

uploadFilenameExtension - The uploadFilenameExtension to set.

getResourceDependencies

public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)

Description copied from class: JobEntryBase

Gets a list of all the resource dependencies that the step is depending on. In JobEntryBase, this method returns an empty resource dependency list.

Specified by:

getResourceDependencies in interface JobEntryInterface

Overrides:

getResourceDependencies in class JobEntryBase

Returns:

an empty list of ResourceReferences

See Also:

ResourceReference

check

public void check(List<org.pentaho.di.core.CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  org.pentaho.di.core.variables.VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)

Description copied from class: JobEntryBase

Allows JobEntry objects to check themselves for consistency

Specified by:

check in interface JobEntryInterface

Overrides:

check in class JobEntryBase

Parameters:

remarks - List of CheckResult objects indicating consistency status

jobMeta - the metadata object for the job entry

space - the variable space to resolve string expressions with variables with

repository - the repository to load Kettle objects from

metaStore - the MetaStore to load common elements from