Package adams.flow.transformer

Class HttpPostFile

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class HttpPostFile
extends AbstractTransformer
    Uploads the incoming file via HTTP POST to the specified URL as 'multipart/form-data'.
    Additional form fields can be supplied as well.

    Input/output:
    - accepts:
       java.lang.String
       java.io.File
    - generates:
       adams.flow.container.HttpRequestResult


    Container information:
    - adams.flow.container.HttpRequestResult: Status code, Status message, Body, Cookies 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: HttpPostFile
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -url <adams.core.base.BaseURL> (property: URL)
    The URL for the request.
    default: http://localhost
 
    -form-field <adams.core.base.BaseKeyValuePair> [-form-field ...] (property: formFields)
    The additional form fields to send.
    default:
 
    -form-field-file <java.lang.String> (property: formFieldFile)
    The name of the form field for the file to upload.
    default:
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_URL

        protected BaseURL m_URL
        the URL to send the form parameters to.

      • m_FormFields

        protected BaseKeyValuePair[] m_FormFields
        the form field/value pairs.

      • m_FormFieldFile

        protected String m_FormFieldFile
        the name of the form field for the file to upload.

    • Constructor Detail

      • HttpPostFile

        public HttpPostFile()

    • Method Detail

      • setURL

        public void setURL​(BaseURL value)
        Sets the URL for the request.
        Parameters:
        value - the URL

      • getURL

        public BaseURL getURL()
        Returns the URL for the request.
        Returns:
        the URL

      • URLTipText

        public String URLTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setFormFields

        public void setFormFields​(BaseKeyValuePair[] value)
        Sets the additional form fields for the request.
        Parameters:
        value - the form fields (name=value)

      • getFormFields

        public BaseKeyValuePair[] getFormFields()
        Returns the additional form fields for the request.
        Returns:
        the form fields (name=value)

      • formFieldsTipText

        public String formFieldsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setFormFieldFile

        public void setFormFieldFile​(String value)
        Sets the form field name used for uploading the file.
        Parameters:
        value - the form field name

      • getFormFieldFile

        public String getFormFieldFile()
        Returns the form field name used for uploading the file.
        Returns:
        the form field name

      • formFieldFileTipText

        public String formFieldFileTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message