jsimple.net

Class JavaHttpRequest

java.lang.Object

jsimple.net.HttpRequest

jsimple.net.JavaHttpRequest

public class JavaHttpRequest
extends HttpRequest

Java platform implementation of platform independent HttpRequest. This implementation is basically a wrapper around the request part of HttpURLConnection.

Since:

10/6/12 12:58 AM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaHttpRequest.JavaHttpRequestFactory

Nested classes/interfaces inherited from class jsimple.net.HttpRequest

HttpRequest.HttpRequestFactory

Field Summary

Fields inherited from class jsimple.net.HttpRequest

HEADER_ACCEPT, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_USER_AGENT, METHOD_DELETE, METHOD_GET, METHOD_POST, METHOD_PUT

Constructor Summary

Constructors

Constructor and Description
JavaHttpRequest(java.lang.String url)

Method Summary

Modifier and Type	Method and Description
OutputStream	createRequestBodyStream() Returns an output stream that writes to this connection.
java.lang.String	getHeader(java.lang.String name) Returns the value of the named header or null if it's not set.
HttpResponse	send() Opens a communications link to the resource referenced by this URL, if such a connection has not already been established.
void	setHeader(java.lang.String name, java.lang.String value) Sets the specified HTTP request header to the specified value.
void	setMethod(java.lang.String method) Set the method for the request, one of: GET POST HEAD OPTIONS PUT DELETE TRACE are legal, subject to protocol restrictions.
void	setTimeout(int timeoutInMillis) Sets a specified timeout value, in milliseconds, to be used when doing connecting/reading/writing to the server.

Methods inherited from class jsimple.net.HttpRequest

create, setContentTypeAndAcceptHeaders, setFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaHttpRequest

public JavaHttpRequest(java.lang.String url)

Method Detail

setMethod

public void setMethod(java.lang.String method)

Description copied from class: HttpRequest

Set the method for the request, one of:

GET POST HEAD OPTIONS PUT DELETE TRACE

are legal, subject to protocol restrictions. The default method is GET.

Specified by:

setMethod in class HttpRequest

Parameters:

method - the HTTP method

setTimeout

public void setTimeout(int timeoutInMillis)

Description copied from class: HttpRequest

Sets a specified timeout value, in milliseconds, to be used when doing connecting/reading/writing to the server. A timeout of zero is interpreted as an infinite timeout. If the timeout expires before the operation is complete, an exception is raised (e.g. java.net.SocketTimeoutException for the Java version for connect timeouts).

For now, we just have one timeout value rather than multiple settings per operation type, as that makes cross platform support easier and is generally good enough for clients.

Specified by:

setTimeout in class HttpRequest

Parameters:

timeoutInMillis - an int that specifies the connect timeout value in milliseconds

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

Description copied from class: HttpRequest

Sets the specified HTTP request header to the specified value. If a header with the key already exists, overwrite its value with the new value.

NOTE: HTTP requires all request headers which can legally have multiple instances with the same key to use a comma-separated list syntax which enables multiple values to be appended into a single header. This method replaces an existing header with the specified name; get the existing header and append to it if you wish to make it multi-valued.

Specified by:

setHeader in class HttpRequest

Parameters:

name - the header name (e.g., "Accept")

value - the value associated with it

getHeader

public java.lang.String getHeader(java.lang.String name)

Description copied from class: HttpRequest

Returns the value of the named header or null if it's not set.

Specified by:

getHeader in class HttpRequest

Parameters:

name - the header name (e.g., "Accept").

Returns:

the value of the header

createRequestBodyStream

public OutputStream createRequestBodyStream()

Description copied from class: HttpRequest

Returns an output stream that writes to this connection. If your app needs to set the value of the ContentLength header, then this must be done before retrieving the stream (which, for one thing, is enforced on .NET). You must close the stream after you finish writing to it; failing to do that may make the system run out of connections (another .NET warning & good practice in general).

Specified by:

createRequestBodyStream in class HttpRequest

Returns:

an output stream that writes to this connection.

send

public HttpResponse send()

Description copied from class: HttpRequest

Opens a communications link to the resource referenced by this URL, if such a connection has not already been established.

If the connect method is called when the connection has already been opened.

HttpRequest objects go through two phases: first they are created, then they are connected. After being created, and before being connected, various options can be specified (e.g., doInput and UseCaches). After connecting, it is an error to try to set them. Operations that depend on being connected, like getContentLength, will implicitly perform the connection, if necessary.

Specified by:

send in class HttpRequest

See Also:

HttpRequest.setTimeout(int)