cfboom.http.client.support

Class HttpAccessor

lucee.Component
    extended by cfboom.lang.Object
      extended by cfboom.http.client.support.HttpAccessor
Class Attributes:
  • output : false
  •  
  • displayname : Abstract Class HttpAccessor
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any HttpMethod


    • access = public
    • returntype = any
    • inject = HttpMethod@cfboom-http
    true false
    any log


    • access = public
    • returntype = any
    • inject = logbox:logger:{this}
    true false
    any requestFactory


    • access = public
    • returntype = any
    • inject = SimpleClientHttpRequestFactory@cfboom-http
    true false
    Constructor Summary
    init()
    Method Summary
    ClientHttpRequest createRequest(any uri, [HttpMethod method])
         Create a new {@link ClientHttpRequest} via this template's {@link ClientHttpRequestFactory}.
    SimpleClientHttpRequestFactory getRequestFactory()
         Return the request factory that this accessor uses for obtaining client request handles.
    void setRequestFactory(SimpleClientHttpRequestFactory requestFactory)
         Set the request factory that this accessor uses for obtaining client request handles.
     
    Methods inherited from class cfboom.lang.Object
    $equals, getComponentName, getIdentityHashCode, getIdentityString, getMeta, hashCode, toString
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()


    Property Detail

    HttpMethod

    property any HttpMethod

    Attributes:
    access - public
    required - false
    returntype - any
    inject - HttpMethod@cfboom-http
    serializable - true

    log

    property any log

    Attributes:
    access - public
    required - false
    returntype - any
    inject - logbox:logger:{this}
    serializable - true

    requestFactory

    property any requestFactory

    Attributes:
    access - public
    required - false
    returntype - any
    inject - SimpleClientHttpRequestFactory@cfboom-http
    serializable - true

    Method Detail

    createRequest

    public ClientHttpRequest createRequest(any uri, [HttpMethod method])

    Create a new {@link ClientHttpRequest} via this template's {@link ClientHttpRequestFactory}.

    Parameters:
    uri
    method
    Returns:
    the created request
    Throws:
    IOException in case of I/O errors

    getRequestFactory

    public SimpleClientHttpRequestFactory getRequestFactory()

    Return the request factory that this accessor uses for obtaining client request handles.


    setRequestFactory

    public void setRequestFactory(SimpleClientHttpRequestFactory requestFactory)

    Set the request factory that this accessor uses for obtaining client request handles.

    The default is a {@link SimpleClientHttpRequestFactory} based on the JDK's own HTTP libraries ({@link java.net.HttpURLConnection}).

    Note that the standard JDK HTTP library does not support the HTTP PATCH method. Configure the Apache HttpComponents or OkHttp request factory to enable PATCH.

    Parameters:
    requestFactory