Package org.threadly.litesockets.client.http

Class HTTPClient

java.lang.Object

org.threadly.util.AbstractService

org.threadly.litesockets.client.http.HTTPClient

public class HTTPClient
extends org.threadly.util.AbstractService

This is a HTTPClient for doing many simple HTTPRequests. Every request will be make a new connection and requests can be done in parallel. This is mainly used for doing many smaller Request and Response messages as the full Request/Response is kept in memory and are not handled as streams. See HTTPStreamClient for use with large HTTP data sets.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HTTPClient.HTTPResponseData	This is a simple, full HttpResponse with data.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_CONCURRENT
static int	DEFAULT_MAX_IDLE
static int	DEFAULT_TIMEOUT
static int	MAX_HTTP_RESPONSE

Constructor Summary

Constructors

Constructor	Description
HTTPClient()	This is the default constructor it will create its own SingleThreadScheduler to use as a threadpool, as well as using the default 2 and 1048576.
HTTPClient(int maxConcurrent, int maxResponseSize)	This constructor will let you set the max Concurrent Requests and max Response Size but will still create its own SingleThreadScheduler to use as a threadpool.
HTTPClient(int maxConcurrent, int maxResponseSize, org.threadly.litesockets.SocketExecuter sei)	This constructor will let you set the max Concurrent Requests and max Response Size as well as your own SocketExecuter as the thread pool to use.

Method Summary

Modifier and Type	Method	Description
void	closeAllClients()	This forces closed all client connections on this HTTPClient.
int	getInProgressSize()	Number of HTTPRequests pending on the HTTPClient.
long	getMaxIdleTimeout()	Checks the configured maximum connection idle time.
int	getOpenConnections()	Returns the total number of open Client Connections on this HTTPClient.
int	getRequestQueueSize()	Number of HTTPRequests pending on the HTTPClient.
HTTPClient.HTTPResponseData	request(java.net.URL url)	Sends a blocking HTTP request.
HTTPClient.HTTPResponseData	request(java.net.URL url, org.threadly.litesockets.protocols.http.shared.HTTPRequestMethod rm, java.nio.ByteBuffer bb)	Sends a blocking HTTP request.
HTTPClient.HTTPResponseData	request(org.threadly.litesockets.protocols.http.request.ClientHTTPRequest request)	Sends a blocking HTTP request.
org.threadly.concurrent.future.ListenableFuture<HTTPClient.HTTPResponseData>	requestAsync(java.net.URL url)	Sends an asynchronous HTTP request.
org.threadly.concurrent.future.ListenableFuture<HTTPClient.HTTPResponseData>	requestAsync(java.net.URL url, org.threadly.litesockets.protocols.http.shared.HTTPRequestMethod rm, java.nio.ByteBuffer bb)	Sends an asynchronous HTTP request.
org.threadly.concurrent.future.ListenableFuture<HTTPClient.HTTPResponseData>	requestAsync(org.threadly.litesockets.protocols.http.request.ClientHTTPRequest request)	Sends an asynchronous HTTP request.
void	setMaxIdleTimeout(long idleTimeout, java.util.concurrent.TimeUnit unit)	Sets the max amount of time we will hold onto idle connections.
void	setSSLContext(javax.net.ssl.SSLContext sslctx)	Sets the SSLContext to be used for connection using ssl on this client.
void	setTimeout(long timeout, java.util.concurrent.TimeUnit unit)	Sets the default timeout in milliseconds to wait for HTTPRequest responses from the server.

Methods inherited from class org.threadly.util.AbstractService

hasStopped, isRunning, start, startIfNotStarted, stop, stopIfRunning

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONCURRENT

public static final int DEFAULT_CONCURRENT

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_MAX_IDLE

public static final int DEFAULT_MAX_IDLE

See Also:

Constant Field Values

MAX_HTTP_RESPONSE

public static final int MAX_HTTP_RESPONSE

See Also:

Constant Field Values

Constructor Detail

HTTPClient

public HTTPClient()

This is the default constructor it will create its own SingleThreadScheduler to use as a threadpool, as well as using the default 2 and 1048576. This means we will do at most 2 HTTPRequests at the same time, and those responses can be up to 1mb in size.

HTTPClient

public HTTPClient(int maxConcurrent,
                  int maxResponseSize)

This constructor will let you set the max Concurrent Requests and max Response Size but will still create its own SingleThreadScheduler to use as a threadpool.

Parameters:

maxConcurrent - maximum number of requests to run simultaneously.

maxResponseSize - the maximum responseSize clients are allowed to send.

HTTPClient

public HTTPClient(int maxConcurrent,
                  int maxResponseSize,
                  org.threadly.litesockets.SocketExecuter sei)

This constructor will let you set the max Concurrent Requests and max Response Size as well as your own SocketExecuter as the thread pool to use.

Parameters:

maxConcurrent - maximum number of requests to run simultaneously.

maxResponseSize - the maximum responseSize clients are allowed to send.

sei - the SocketExecuter to use with these HTTPClients.

Method Detail

getRequestQueueSize

public int getRequestQueueSize()

Number of HTTPRequests pending on the HTTPClient. These requests are not currently being processed, but waiting in queue for the next free http worker.

Returns:

number of pending requests.

getInProgressSize

public int getInProgressSize()

Number of HTTPRequests pending on the HTTPClient. These are requests that are currently either trying to connect to or have been sent to a server.

Returns:

number of request currently in progress.

getOpenConnections

public int getOpenConnections()

Returns the total number of open Client Connections on this HTTPClient.

Returns:

number of open connections.

setSSLContext

public void setSSLContext(javax.net.ssl.SSLContext sslctx)

Sets the SSLContext to be used for connection using ssl on this client. If nothing is set a completely open SSLContext is used providing no cert validation.

Parameters:

sslctx - the SSLContext to use for ssl connections.

closeAllClients

public void closeAllClients()

This forces closed all client connections on this HTTPClient. NOTE: this will disrupt any pending requests if called.

setTimeout

public void setTimeout(long timeout,
                       java.util.concurrent.TimeUnit unit)

Sets the default timeout in milliseconds to wait for HTTPRequest responses from the server.

Parameters:

timeout - time in milliseconds to wait for HTTPRequests to finish.

unit - The unit the timeout value is represented in

getMaxIdleTimeout

public long getMaxIdleTimeout()

Checks the configured maximum connection idle time.

Returns:

The number of milliseconds until an idle connection is closed

setMaxIdleTimeout

public void setMaxIdleTimeout(long idleTimeout,
                              java.util.concurrent.TimeUnit unit)

Sets the max amount of time we will hold onto idle connections. A 0 means we close connections when done, less than zero means we will never expire connections.

Parameters:

idleTimeout - the time in milliseconds to wait before timing out a connection.

unit - The unit the idleTimeout value is represented in

request

public HTTPClient.HTTPResponseData request(java.net.URL url)
                                    throws org.threadly.litesockets.protocols.http.shared.HTTPParsingException

Sends a blocking HTTP request.

Parameters:

url - the url to send the request too.

Returns:

A HTTPClient.HTTPResponseData object containing the headers and content of the response.

Throws:

org.threadly.litesockets.protocols.http.shared.HTTPParsingException - is thrown if the server sends back protocol or a response that is larger then allowed.

request

public HTTPClient.HTTPResponseData request(java.net.URL url,
                                           org.threadly.litesockets.protocols.http.shared.HTTPRequestMethod rm,
                                           java.nio.ByteBuffer bb)
                                    throws org.threadly.litesockets.protocols.http.shared.HTTPParsingException

Sends a blocking HTTP request.

Parameters:

url - the url to send the request too.

rm - the HTTPRequestMethod to use on the request.

bb - the data to put in the body for this request.

Returns:

A HTTPClient.HTTPResponseData object containing the headers and content of the response.

Throws:

org.threadly.litesockets.protocols.http.shared.HTTPParsingException - is thrown if the server sends back protocol or a response that is larger then allowed.

request

public HTTPClient.HTTPResponseData request(org.threadly.litesockets.protocols.http.request.ClientHTTPRequest request)
                                    throws org.threadly.litesockets.protocols.http.shared.HTTPParsingException

Sends a blocking HTTP request.

Parameters:

request - the HTTPRequest to send the server once connected.

Returns:

A HTTPClient.HTTPResponseData object containing the headers and content of the response.

Throws:

org.threadly.litesockets.protocols.http.shared.HTTPParsingException - is thrown if the server sends back protocol or a response that is larger then allowed.

requestAsync

public org.threadly.concurrent.future.ListenableFuture<HTTPClient.HTTPResponseData> requestAsync(java.net.URL url)

Sends an asynchronous HTTP request.

Parameters:

url - the URL to send the request too.

Returns:

A ListenableFuture containing a HTTPClient.HTTPResponseData object that will be completed when the request is finished, successfully or with errors.

requestAsync

public org.threadly.concurrent.future.ListenableFuture<HTTPClient.HTTPResponseData> requestAsync(java.net.URL url,
                                                                                                 org.threadly.litesockets.protocols.http.shared.HTTPRequestMethod rm,
                                                                                                 java.nio.ByteBuffer bb)

Sends an asynchronous HTTP request.

Parameters:

url - the URL to send the request too.

rm - the HTTPRequestMethod to use on the request.

bb - the data to put in the body for this request.

Returns:

A ListenableFuture containing a HTTPClient.HTTPResponseData object that will be completed when the request is finished, successfully or with errors.

requestAsync

public org.threadly.concurrent.future.ListenableFuture<HTTPClient.HTTPResponseData> requestAsync(org.threadly.litesockets.protocols.http.request.ClientHTTPRequest request)

Sends an asynchronous HTTP request.

Parameters:

request - the HTTPRequest to send the server once connected.

Returns:

an ListenableFuture containing a HTTPClient.HTTPResponseData object that will be completed when the request is finished, successfully or with errors.