org.eclipse.jetty.client

Class HttpRequest

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpRequest(HttpClient client, long id, URI uri)
	HttpRequest(HttpClient client, URI uri)

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Attempts to abort the send of this request.
boolean	aborted()
String	agent()
Request	agent(String agent)
Request	attribute(String name, Object value)
Map<String,Object>	attributes()
ContentProvider	content()
Request	content(ContentProvider content)
long	conversation()
Request	file(java.nio.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(java.nio.file.Path file, String contentType) Shortcut method to specify a file as a content for this request, with the given content type.
boolean	followRedirects()
Request	followRedirects(boolean follow)
Request	header(String name, String value)
HttpFields	headers()
String	host()
long	idleTimeout()
Request	idleTimeout(long timeout)
Request.Listener	listener()
Request	listener(Request.Listener listener)
HttpMethod	method()
Request	method(HttpMethod method)
Request	param(String name, String value)
Fields	params()
String	path()
Request	path(String path)
int	port()
String	scheme()
Request	scheme(String scheme)
Future<ContentResponse>	send() Sends this request and returns a Future that can be used to wait for the request and the response to be completed (either with a success or a failure).
void	send(Response.Listener listener) Sends this request and asynchronously notifies the given listener for response events.
String	toString()
String	uri()
HttpVersion	version()
Request	version(HttpVersion version)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpRequest

public HttpRequest(HttpClient client,
           URI uri)

HttpRequest

protected HttpRequest(HttpClient client,
           long id,
           URI uri)

Method Detail

conversation

public long conversation()

Specified by:

conversation in interface Request

Returns:

the conversation id

scheme

public String scheme()

Specified by:

scheme 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

host

public String host()

Specified by:

host in interface Request

Returns:

the host of this request, such as "127.0.0.1" or "google.com"

port

public int port()

Specified by:

port in interface Request

Returns:

the port of this request such as 80 or 443

method

public HttpMethod method()

Specified by:

method in interface Request

Returns:

the method of this request, such as GET or POST

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

path

public String path()

Specified by:

path in interface Request

Returns:

the path of this request, such as "/"

path

public Request path(String path)

Specified by:

path in interface Request

Parameters:

path - the path of this request, such as "/"

Returns:

this request object

uri

public String uri()

Specified by:

uri in interface Request

Returns:

the full URI of this request such as "http://host:port/path"

version

public HttpVersion version()

Specified by:

version 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)

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

params

public Fields params()

Specified by:

params in interface Request

Returns:

the query parameters of this request

agent

public String agent()

Specified by:

agent 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

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

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

attributes

public Map<String,Object> attributes()

Specified by:

attributes in interface Request

Returns:

the attributes of this request

headers

public HttpFields headers()

Specified by:

headers in interface Request

Returns:

the headers of this request

listener

public Request.Listener listener()

Specified by:

listener in interface Request

Returns:

the listener for request events

listener

public Request listener(Request.Listener listener)

Specified by:

listener in interface Request

Parameters:

listener - the listener for request events

Returns:

this request object

content

public ContentProvider content()

Specified by:

content 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

file

public Request file(java.nio.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(java.nio.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

followRedirects

public boolean followRedirects()

Specified by:

followRedirects 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

idleTimeout

public long idleTimeout()

Specified by:

idleTimeout in interface Request

Returns:

the idle timeout for this request

idleTimeout

public Request idleTimeout(long timeout)

Specified by:

idleTimeout in interface Request

Parameters:

timeout - the idle timeout for this request

Returns:

this request object

send

public Future<ContentResponse> send()

Description copied from interface: Request

Sends this request and returns a Future that can be used to wait for the request and the response to be completed (either with a success or a failure).

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.Listener) instead, passing your own Response.Listener or a utility listener such as InputStreamResponseListener.

The future will return when Response.Listener.onComplete(Result) is invoked.

Specified by:

send in interface Request

Returns:

a Future to wait on for request and response completion

See Also:

Response.Listener.onComplete(Result)

send

public void send(Response.Listener 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 void abort()

Description copied from interface: Request

Attempts to abort the send of this request.

Specified by:

abort in interface Request

See Also:

Request.aborted()

aborted

public boolean aborted()

Specified by:

aborted in interface Request

Returns:

whether Request.abort() was called

toString

public String toString()

Overrides:

toString in class Object