Package adams.flow.transformer

Class HttpRequest

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, EncodingSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class HttpRequest
extends AbstractTransformer
implements EncodingSupporter
    Sends the incoming text/bytes payload to the specified URL (with optional HTTP headers) and forwards the retrieved HTML as text.

    Input/output:
    - accepts:
       byte[]
       java.lang.String
    - 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: HttpRequest
 
    -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
 
    -method <GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS> (property: method)
    The method to use for the request.
    default: POST
 
    -mime-type <java.lang.String> (property: mimeType)
    The mime-type for the request, leave empty for application/octet-stream.
    default:
 
    -header <adams.core.base.BaseKeyValuePair> [-header ...] (property: headers)
    The (optional) request headers to send.
    default:
 
    -encoding <adams.core.base.BaseCharset> (property: encoding)
    The type of encoding to use for incoming strings.
    default: UTF-8
    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_Method

        protected com.github.fracpete.requests4j.request.Method m_Method
        the action method to use.

      • m_MimeType

        protected String m_MimeType
        the mimetype.

      • m_Headers

        protected BaseKeyValuePair[] m_Headers
        the (optional) request headers.

      • m_Encoding

        protected BaseCharset m_Encoding
        the encoding to use.

    • Constructor Detail

      • HttpRequest

        public HttpRequest()

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

      • setMethod

        public void setMethod​(com.github.fracpete.requests4j.request.Method value)
        Sets the method for the request.
        Parameters:
        value - the method

      • getMethod

        public com.github.fracpete.requests4j.request.Method getMethod()
        Returns the method for the request.
        Returns:
        the method

      • methodTipText

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

      • setMimeType

        public void setMimeType​(String value)
        Sets the mime-type, leave empty for application/octect-stream.
        Parameters:
        value - the mime-type

      • getMimeType

        public String getMimeType()
        Returns the mime-type, application/octect-stream if empty.
        Returns:
        the mime-type

      • mimeTypeTipText

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

      • setHeaders

        public void setHeaders​(BaseKeyValuePair[] value)
        Sets the (optional) request headers for the request.
        Parameters:
        value - the headers

      • getHeaders

        public BaseKeyValuePair[] getHeaders()
        Returns the (optional) request headers for the request.
        Returns:
        the headers

      • headersTipText

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

      • setEncoding

        public void setEncoding​(BaseCharset value)
        Sets the encoding to use.
        Specified by:
        setEncoding in interface EncodingSupporter
        Parameters:
        value - the encoding, e.g. "UTF-8" or "UTF-16", empty string for default

      • getEncoding

        public BaseCharset getEncoding()
        Returns the encoding to use.
        Specified by:
        getEncoding in interface EncodingSupporter
        Returns:
        the encoding, e.g. "UTF-8" or "UTF-16", empty string for default

      • encodingTipText

        public String encodingTipText()
        Returns the tip text for this property.
        Specified by:
        encodingTipText in interface EncodingSupporter
        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.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        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