cfboom.http.message

Class BasicHttpRequest

lucee.Component
    extended by cfboom.lang.Object
      extended by cfboom.http.message.AbstractHttpMessage
        extended by cfboom.http.message.BasicHttpRequest
All Implemented Interfaces:
HttpMessage , HttpRequest

Basic implementation of {@link HttpRequest}.

Class Attributes:
  • cfboom : Joel Tobey
  •  
  • output : false
  •  
  • displayname : Class BasicHttpRequest
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  
    Constructor Summary
    init(string method, string uri)
    Method Summary
    void addBody([string value])
    void addFormField([string name], [string value], [boolean encoded='true'])
    void addParam([RequestParam param])
    void addQueryParam([string name], [string value])
    boolean containsFormField([string name])
    boolean containsQueryParam([string name])
    array getAllFormFields()
    array getAllOtherParams()
    array getAllQueryParams()
    any getBody()
    string getFirstFormField([string name])
    string getFirstQueryParam([string name])
    array getFormFields([string name])
    string getLastFormField([string name])
    string getLastQueryParam([string name])
    string getMethod()
    string getName()
    array getQueryParams([string name])
    any getURI()
    boolean hasExecuted()
    private string paramsToJson(struct params, [boolean addType='false'])
    void removeBody()
    void removeFormFields([string name])
    void removeQueryParams([string name])
    void setBody([RequestParam body])
    void setExecuted([boolean executed='false'])
    void setFormField([string name], [string value], [boolean encoded='true'])
    void setFormFields([array formFields])
    void setName(string name)
    void setQueryParam([string name], [string value])
    void setQueryParams([array queryParams])
    string toJson([boolean noHeaders='false'])
    string toString()
     
    Methods inherited from class cfboom.http.message.AbstractHttpMessage
    addHeader, containsHeader, getAllHeaders, getContentEncoding, getContentLength, getContentType, getFirstHeader, getHeaders, getLastHeader, removeHeaders, setHeader, setHeaders
     
    Methods inherited from class cfboom.lang.Object
    $equals, getComponentName, getIdentityHashCode, getIdentityString, getMeta, hashCode
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init(string method, string uri)

    Parameters:
    method
    uri

    Method Detail

    addBody

    public void addBody([string value])

    Parameters:
    value

    addFormField

    public void addFormField([string name], [string value], [boolean encoded='true'])

    Parameters:
    name
    value
    encoded

    addParam

    public void addParam([RequestParam param])

    Parameters:
    param

    addQueryParam

    public void addQueryParam([string name], [string value])

    Parameters:
    name
    value

    containsFormField

    public boolean containsFormField([string name])

    Parameters:
    name

    containsQueryParam

    public boolean containsQueryParam([string name])

    Parameters:
    name

    getAllFormFields

    public array getAllFormFields()


    getAllOtherParams

    public array getAllOtherParams()


    getAllQueryParams

    public array getAllQueryParams()


    getBody

    public any getBody()


    getFirstFormField

    public string getFirstFormField([string name])

    Parameters:
    name

    getFirstQueryParam

    public string getFirstQueryParam([string name])

    Parameters:
    name

    getFormFields

    public array getFormFields([string name])

    Parameters:
    name

    getLastFormField

    public string getLastFormField([string name])

    Parameters:
    name

    getLastQueryParam

    public string getLastQueryParam([string name])

    Parameters:
    name

    getMethod

    public string getMethod()

    Specified by:
    getMethod in interface HttpRequest

    getName

    public string getName()

    Specified by:
    getName in interface HttpRequest

    getQueryParams

    public array getQueryParams([string name])

    Parameters:
    name

    getURI

    public any getURI()

    Specified by:
    getURI in interface HttpRequest

    hasExecuted

    public boolean hasExecuted()


    paramsToJson

    private string paramsToJson(struct params, [boolean addType='false'])

    Parameters:
    params
    addType

    removeBody

    public void removeBody()


    removeFormFields

    public void removeFormFields([string name])

    Parameters:
    name

    removeQueryParams

    public void removeQueryParams([string name])

    Parameters:
    name

    setBody

    public void setBody([RequestParam body])

    Parameters:
    body

    setExecuted

    public void setExecuted([boolean executed='false'])

    Parameters:
    executed

    setFormField

    public void setFormField([string name], [string value], [boolean encoded='true'])

    Parameters:
    name
    value
    encoded

    setFormFields

    public void setFormFields([array formFields])

    Parameters:
    formFields

    setName

    public void setName(string name)

    Parameters:
    name

    setQueryParam

    public void setQueryParam([string name], [string value])

    Parameters:
    name
    value

    setQueryParams

    public void setQueryParams([array queryParams])

    Parameters:
    queryParams

    toJson

    public string toJson([boolean noHeaders='false'])

    Parameters:
    noHeaders

    toString

    public string toString()

    Overrides:
    toString in class cfboom.lang.Object