HttpRequest (Jetty :: Project 9.2.6.v20141205 API)

java.lang.Object
- org.eclipse.jetty.client.HttpRequest

All Implemented Interfaces:: Request

public class HttpRequest
extends Object
implements Request

Nested Class Summary
- Nested classes/interfaces inherited from interface org.eclipse.jetty.client.api.Request
  Request.BeginListener, Request.CommitListener, Request.ContentListener, Request.FailureListener, Request.HeadersListener, Request.Listener, Request.QueuedListener, Request.RequestListener, Request.SuccessListener

Constructor Summary

Constructors
Modifier Constructor and Description

protected HttpRequest(HttpClient client, HttpConversation conversation, URI uri)

Constructors
Modifier	Constructor and Description
`protected`	`HttpRequest(HttpClient client, HttpConversation conversation, URI uri)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`abort(Throwable cause)` Attempts to abort the send of this request.
`Request`	`accept(String... accepts)`
`Request`	`agent(String agent)`
`Request`	`attribute(String name, Object value)`
`Request`	`content(ContentProvider content)`
`Request`	`content(ContentProvider content, String contentType)`
`Request`	`cookie(HttpCookie cookie)`
`Request`	`file(Path file)` Shortcut method to specify a file as a content for this request, with the default content type of "application/octect-stream".
`Request`	`file(Path file, String contentType)` Shortcut method to specify a file as a content for this request, with the given content type.
`Request`	`followRedirects(boolean follow)`
`Throwable`	`getAbortCause()`
`String`	`getAgent()`
`Map<String,Object>`	`getAttributes()`
`ContentProvider`	`getContent()`
`protected HttpConversation`	`getConversation()`
`List<HttpCookie>`	`getCookies()`
`HttpFields`	`getHeaders()`
`String`	`getHost()`
`long`	`getIdleTimeout()`
`String`	`getMethod()`
`Fields`	`getParams()`
`String`	`getPath()`
`int`	`getPort()`
`String`	`getQuery()`
`<T extends Request.RequestListener> List<T>`	`getRequestListeners(Class<T> type)`
`String`	`getScheme()`
`long`	`getTimeout()`
`URI`	`getURI()`
`HttpVersion`	`getVersion()`
`Request`	`header(HttpHeader header, String value)` Adds the given `value` to the specified `header`.
`Request`	`header(String name, String value)`
`Request`	`idleTimeout(long timeout, TimeUnit unit)`
`boolean`	`isFollowRedirects()`
`Request`	`listener(Request.Listener listener)`
`Request`	`method(HttpMethod method)`
`Request`	`method(String method)`
`Request`	`onComplete(Response.CompleteListener listener)`
`Request`	`onRequestBegin(Request.BeginListener listener)`
`Request`	`onRequestCommit(Request.CommitListener listener)`
`Request`	`onRequestContent(Request.ContentListener listener)`
`Request`	`onRequestFailure(Request.FailureListener listener)`
`Request`	`onRequestHeaders(Request.HeadersListener listener)`
`Request`	`onRequestQueued(Request.QueuedListener listener)`
`Request`	`onRequestSuccess(Request.SuccessListener listener)`
`Request`	`onResponseBegin(Response.BeginListener listener)`
`Request`	`onResponseContent(Response.ContentListener listener)`
`Request`	`onResponseContentAsync(Response.AsyncContentListener listener)`
`Request`	`onResponseFailure(Response.FailureListener listener)`
`Request`	`onResponseHeader(Response.HeaderListener listener)`
`Request`	`onResponseHeaders(Response.HeadersListener listener)`
`Request`	`onResponseSuccess(Response.SuccessListener listener)`
`Request`	`param(String name, String value)` Adds a query parameter with the given name and value.
`Request`	`path(String path)` Specifies the path - and possibly the query - of this request.
`Request`	`scheme(String scheme)`
`ContentResponse`	`send()` Sends this request and returns the response.
`void`	`send(Response.CompleteListener listener)` Sends this request and asynchronously notifies the given listener for response events.
`Request`	`timeout(long timeout, TimeUnit unit)`
`String`	`toString()`
`Request`	`version(HttpVersion version)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HttpRequest
```
protected HttpRequest(HttpClient client,
           HttpConversation conversation,
           URI uri)
```
- Method Detail
  - getConversation
```
protected HttpConversation getConversation()
```
  - getScheme
```
public String getScheme()
```
    Specified by:
    
    getScheme in interface Request
    
    Returns:
    the scheme of this request, such as "http" or "https"
  - scheme
```
public Request scheme(String scheme)
```
    Specified by:
    
    scheme in interface Request
    
    Parameters:
    scheme - the scheme of this request, such as "http" or "https"
    
    Returns:
    this request object
  - getHost
```
public String getHost()
```
    Specified by:
    
    getHost in interface Request
    
    Returns:
    the host of this request, such as "127.0.0.1" or "google.com"
  - getPort
```
public int getPort()
```
    Specified by:
    
    getPort in interface Request
    
    Returns:
    the port of this request such as 80 or 443
  - getMethod
```
public String getMethod()
```
    Specified by:
    
    getMethod in interface Request
    
    Returns:
    the method of this request, such as GET or POST, as a String
  - method
```
public Request method(HttpMethod method)
```
    Specified by:
    
    method in interface Request
    
    Parameters:
    method - the method of this request, such as GET or POST
    
    Returns:
    this request object
  - method
```
public Request method(String method)
```
    Specified by:
    
    method in interface Request
    
    Parameters:
    method - the method of this request, such as GET or POST
    
    Returns:
    this request object
  - getPath
```
public String getPath()
```
    Specified by:
    
    getPath in interface Request
    
    Returns:
    the path of this request, such as "/" or "/path" - without the query
    See Also:
    Request.getQuery()
  - path
```
public Request path(String path)
```
    Description copied from interface: Request
    
    Specifies the path - and possibly the query - of this request. If the query part is specified, parameter values must be properly UTF-8 URL encoded. For example, if the value for parameter "currency" is the euro symbol € then the query string for this parameter must be "currency=%E2%82%AC". For transparent encoding of parameter values, use Request.param(String, String).
    
    Specified by:
    
    path in interface Request
    
    Parameters:
    path - the path of this request, such as "/" or "/path?param=1"
    
    Returns:
    this request object
  - getQuery
```
public String getQuery()
```
    Specified by:
    
    getQuery in interface Request
    
    Returns:
    the query string of this request such as "param=1"
    See Also:
    Request.getPath(), Request.getParams()
  - getURI
```
public URI getURI()
```
    Specified by:
    
    getURI in interface Request
    
    Returns:
    the full URI of this request such as "http://host:port/path?param=1"
  - getVersion
```
public HttpVersion getVersion()
```
    Specified by:
    
    getVersion in interface Request
    
    Returns:
    the HTTP version of this request, such as "HTTP/1.1"
  - version
```
public Request version(HttpVersion version)
```
    Specified by:
    
    version in interface Request
    
    Parameters:
    version - the HTTP version of this request, such as "HTTP/1.1"
    
    Returns:
    this request object
  - param
```
public Request param(String name,
            String value)
```
    Description copied from interface: Request
    
    Adds a query parameter with the given name and value. The value is UTF-8 URL encoded.
    
    Specified by:
    
    param in interface Request
    
    Parameters:
    name - the name of the query parameter
    value - the value of the query parameter
    
    Returns:
    this request object
  - getParams
```
public Fields getParams()
```
    Specified by:
    
    getParams in interface Request
    
    Returns:
    the query parameters of this request
  - getAgent
```
public String getAgent()
```
    Specified by:
    
    getAgent in interface Request
    
    Returns:
    the user agent for this request
  - agent
```
public Request agent(String agent)
```
    Specified by:
    
    agent in interface Request
    
    Parameters:
    agent - the user agent for this request (corresponds to the User-Agent header)
    
    Returns:
    this request object
  - accept
```
public Request accept(String... accepts)
```
    Specified by:
    
    accept in interface Request
    
    Parameters:
    accepts - the media types that are acceptable in the response, such as "text/plain;q=0.5" or "text/html" (corresponds to the Accept header)
    
    Returns:
    this request object
  - header
```
public Request header(String name,
             String value)
```
    Specified by:
    
    header in interface Request
    
    Parameters:
    name - the name of the header
    value - the value of the header
    
    Returns:
    this request object
    See Also:
    Request.header(HttpHeader, String)
  - header
```
public Request header(HttpHeader header,
             String value)
```
    Description copied from interface: Request
    
    Adds the given value to the specified header.
    
    Multiple calls with the same parameters will add multiple values; use the value null to remove the header completely.
    
    Specified by:
    
    header in interface Request
    
    Parameters:
    header - the header name
    value - the value of the header
    
    Returns:
    this request object
  - getCookies
```
public List<HttpCookie> getCookies()
```
    Specified by:
    
    getCookies in interface Request
    
    Returns:
    the cookies associated with this request
  - cookie
```
public Request cookie(HttpCookie cookie)
```
    Specified by:
    
    cookie in interface Request
    
    Parameters:
    cookie - a cookie for this request
    
    Returns:
    this request object
  - attribute
```
public Request attribute(String name,
                Object value)
```
    Specified by:
    
    attribute in interface Request
    
    Parameters:
    name - the name of the attribute
    value - the value of the attribute
    
    Returns:
    this request object
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    Specified by:
    
    getAttributes in interface Request
    
    Returns:
    the attributes of this request
  - getHeaders
```
public HttpFields getHeaders()
```
    Specified by:
    
    getHeaders in interface Request
    
    Returns:
    the headers of this request
  - getRequestListeners
```
public <T extends Request.RequestListener> List<T> getRequestListeners(Class<T> type)
```
    Specified by:
    
    getRequestListeners in interface Request
    
    Parameters:
    type - the class of the listener, or null for all listeners classes
    
    Returns:
    the listeners for request events of the given class
  - listener
```
public Request listener(Request.Listener listener)
```
    Specified by:
    
    listener in interface Request
    
    Parameters:
    listener - a listener for request events
    
    Returns:
    this request object
  - onRequestQueued
```
public Request onRequestQueued(Request.QueuedListener listener)
```
    Specified by:
    
    onRequestQueued in interface Request
    
    Parameters:
    listener - a listener for request queued event
    
    Returns:
    this request object
  - onRequestBegin
```
public Request onRequestBegin(Request.BeginListener listener)
```
    Specified by:
    
    onRequestBegin in interface Request
    
    Parameters:
    listener - a listener for request begin event
    
    Returns:
    this request object
  - onRequestHeaders
```
public Request onRequestHeaders(Request.HeadersListener listener)
```
    Specified by:
    
    onRequestHeaders in interface Request
    
    Parameters:
    listener - a listener for request headers event
    
    Returns:
    this request object
  - onRequestCommit
```
public Request onRequestCommit(Request.CommitListener listener)
```
    Specified by:
    
    onRequestCommit in interface Request
    
    Parameters:
    listener - a listener for request commit event
    
    Returns:
    this request object
  - onRequestContent
```
public Request onRequestContent(Request.ContentListener listener)
```
    Specified by:
    
    onRequestContent in interface Request
    
    Parameters:
    listener - a listener for request content events
    
    Returns:
    this request object
  - onRequestSuccess
```
public Request onRequestSuccess(Request.SuccessListener listener)
```
    Specified by:
    
    onRequestSuccess in interface Request
    
    Parameters:
    listener - a listener for request success event
    
    Returns:
    this request object
  - onRequestFailure
```
public Request onRequestFailure(Request.FailureListener listener)
```
    Specified by:
    
    onRequestFailure in interface Request
    
    Parameters:
    listener - a listener for request failure event
    
    Returns:
    this request object
  - onResponseBegin
```
public Request onResponseBegin(Response.BeginListener listener)
```
    Specified by:
    
    onResponseBegin in interface Request
    
    Parameters:
    listener - a listener for response begin event
    
    Returns:
    this request object
  - onResponseHeader
```
public Request onResponseHeader(Response.HeaderListener listener)
```
    Specified by:
    
    onResponseHeader in interface Request
    
    Parameters:
    listener - a listener for response header event
    
    Returns:
    this request object
  - onResponseHeaders
```
public Request onResponseHeaders(Response.HeadersListener listener)
```
    Specified by:
    
    onResponseHeaders in interface Request
    
    Parameters:
    listener - a listener for response headers event
    
    Returns:
    this request object
  - onResponseContent
```
public Request onResponseContent(Response.ContentListener listener)
```
    Specified by:
    
    onResponseContent in interface Request
    
    Parameters:
    listener - a consuming listener for response content events
    
    Returns:
    this request object
  - onResponseContentAsync
```
public Request onResponseContentAsync(Response.AsyncContentListener listener)
```
    Specified by:
    
    onResponseContentAsync in interface Request
    
    Parameters:
    listener - an asynchronous listener for response content events
    
    Returns:
    this request object
  - onResponseSuccess
```
public Request onResponseSuccess(Response.SuccessListener listener)
```
    Specified by:
    
    onResponseSuccess in interface Request
    
    Parameters:
    listener - a listener for response success event
    
    Returns:
    this request object
  - onResponseFailure
```
public Request onResponseFailure(Response.FailureListener listener)
```
    Specified by:
    
    onResponseFailure in interface Request
    
    Parameters:
    listener - a listener for response failure event
    
    Returns:
    this request object
  - onComplete
```
public Request onComplete(Response.CompleteListener listener)
```
    Specified by:
    
    onComplete in interface Request
    
    Parameters:
    listener - a listener for complete event
    
    Returns:
    this request object
  - getContent
```
public ContentProvider getContent()
```
    Specified by:
    
    getContent in interface Request
    
    Returns:
    the content provider of this request
  - content
```
public Request content(ContentProvider content)
```
    Specified by:
    
    content in interface Request
    
    Parameters:
    content - the content provider of this request
    
    Returns:
    this request object
  - content
```
public Request content(ContentProvider content,
              String contentType)
```
    Specified by:
    
    content in interface Request
    
    Parameters:
    content - the content provider of this request
    
    Returns:
    this request object
  - file
```
public Request file(Path file)
             throws IOException
```
    Description copied from interface: Request
    
    Shortcut method to specify a file as a content for this request, with the default content type of "application/octect-stream".
    
    Specified by:
    
    file in interface Request
    
    Parameters:
    file - the file to upload
    
    Returns:
    this request object
    
    Throws:
    
    IOException - if the file does not exist or cannot be read
  - file
```
public Request file(Path file,
           String contentType)
             throws IOException
```
    Description copied from interface: Request
    
    Shortcut method to specify a file as a content for this request, with the given content type.
    
    Specified by:
    
    file in interface Request
    
    Parameters:
    file - the file to upload
    contentType - the content type of the file
    
    Returns:
    this request object
    
    Throws:
    
    IOException - if the file does not exist or cannot be read
  - isFollowRedirects
```
public boolean isFollowRedirects()
```
    Specified by:
    
    isFollowRedirects in interface Request
    
    Returns:
    whether this request follows redirects
  - followRedirects
```
public Request followRedirects(boolean follow)
```
    Specified by:
    
    followRedirects in interface Request
    
    Parameters:
    follow - whether this request follows redirects
    
    Returns:
    this request object
  - getIdleTimeout
```
public long getIdleTimeout()
```
    Specified by:
    
    getIdleTimeout in interface Request
    
    Returns:
    the idle timeout for this request, in milliseconds
  - idleTimeout
```
public Request idleTimeout(long timeout,
                  TimeUnit unit)
```
    Specified by:
    
    idleTimeout in interface Request
    
    Parameters:
    timeout - the idle timeout for this request
    unit - the idle timeout unit
    
    Returns:
    this request object
  - getTimeout
```
public long getTimeout()
```
    Specified by:
    
    getTimeout in interface Request
    
    Returns:
    the total timeout for this request, in milliseconds
  - timeout
```
public Request timeout(long timeout,
              TimeUnit unit)
```
    Specified by:
    
    timeout in interface Request
    
    Parameters:
    timeout - the total timeout for the request/response conversation
    unit - the timeout unit
    
    Returns:
    this request object
  - send
```
public ContentResponse send()
                     throws InterruptedException,
                            TimeoutException,
                            ExecutionException
```
    Description copied from interface: Request
    
    Sends this request and returns the response.
    This method should be used when a simple blocking semantic is needed, and when it is known that the response content can be buffered without exceeding memory constraints.
    For example, this method is not appropriate to download big files from a server; consider using Request.send(Response.CompleteListener) instead, passing your own Response.Listener or a utility listener such as InputStreamResponseListener.
    The method returns when the complete event is fired.
    
    Specified by:
    
    send in interface Request
    
    Returns:
    a ContentResponse for this request
    
    Throws:
    
    InterruptedException
    
    TimeoutException
    
    ExecutionException
    See Also:
    Response.CompleteListener.onComplete(Result)
  - send
```
public void send(Response.CompleteListener listener)
```
    Description copied from interface: Request
    
    Sends this request and asynchronously notifies the given listener for response events.
    This method should be used when the application needs to be notified of the various response events as they happen, or when the application needs to efficiently manage the response content.
    
    Specified by:
    
    send in interface Request
    
    Parameters:
    listener - the listener that receives response events
  - abort
```
public boolean abort(Throwable cause)
```
    Description copied from interface: Request
    
    Attempts to abort the send of this request.
    
    Specified by:
    
    abort in interface Request
    
    Parameters:
    cause - the abort cause, must not be null
    
    Returns:
    whether the abort succeeded
  - getAbortCause
```
public Throwable getAbortCause()
```
    Specified by:
    
    getAbortCause in interface Request
    
    Returns:
    the abort cause passed to Request.abort(Throwable), or null if this request has not been aborted
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HttpRequest

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.client.api.Request

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpRequest

Method Detail

getConversation

getScheme

scheme

getHost

getPort

getMethod

method

method

getPath

path

getQuery

getURI

getVersion

version

param

getParams

getAgent

agent

accept

header

header

getCookies

cookie

attribute

getAttributes

getHeaders

getRequestListeners

listener

onRequestQueued

onRequestBegin

onRequestHeaders

onRequestCommit

onRequestContent

onRequestSuccess

onRequestFailure

onResponseBegin

onResponseHeader

onResponseHeaders

onResponseContent

onResponseContentAsync

onResponseSuccess

onResponseFailure

onComplete

getContent

content

content

file

file

isFollowRedirects

followRedirects

getIdleTimeout

idleTimeout

getTimeout

timeout

send

send

abort

getAbortCause

toString