Package 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.logging.LoggingObjectLifecycleInterface, 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 Details

    • JobEntryHTTP

      public JobEntryHTTP(String n)

    • JobEntryHTTP

      public JobEntryHTTP()

  • Method Details

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

    • getResponseStatusCode

      public int getResponseStatusCode()

    • 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:

    • 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