org.dmfs.httpessentials.httpurlconnection.factories.decorators

Class Finite

java.lang.Object

org.dmfs.httpessentials.httpurlconnection.factories.decorators.Finite

All Implemented Interfaces:

HttpUrlConnectionFactory

public final class Finite
extends java.lang.Object
implements HttpUrlConnectionFactory

A HttpUrlConnectionFactory decorator that sets connection and socket timeouts on the connection (rather than waiting forever).

Author:

Marten Gajda

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECTION_TIMEOUT
static int	DEFAULT_SOCKET_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
Finite(HttpUrlConnectionFactory decorated) An HttpUrlConnectionFactory decorator that sets default connection timeout and socket (read) timeout on the connections returned by the decorated HttpUrlConnectionFactory.
Finite(HttpUrlConnectionFactory decorated, int connectionTimeout, int socketTimeout) An HttpUrlConnectionFactory decorator that sets connection timeout and socket (read) timeout on the connections returned by the decorated HttpUrlConnectionFactory.

Method Summary

Methods

Modifier and Type	Method and Description
java.net.HttpURLConnection	httpUrlConnection(java.net.URI uri) Returns an HttpURLConnection to the given Uri.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SOCKET_TIMEOUT

public static final int DEFAULT_SOCKET_TIMEOUT

See Also:

Constant Field Values

DEFAULT_CONNECTION_TIMEOUT

public static final int DEFAULT_CONNECTION_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

Finite

public Finite(HttpUrlConnectionFactory decorated)

An HttpUrlConnectionFactory decorator that sets default connection timeout and socket (read) timeout on the connections returned by the decorated HttpUrlConnectionFactory. The default connection timeout is 10000 milliseconds and the default socket timeout is 120000 milliseconds.

Parameters:

decorated - Another HttpUrlConnectionFactory.

Finite

public Finite(HttpUrlConnectionFactory decorated,
      int connectionTimeout,
      int socketTimeout)

An HttpUrlConnectionFactory decorator that sets connection timeout and socket (read) timeout on the connections returned by the decorated HttpUrlConnectionFactory.

Parameters:

decorated - Another HttpUrlConnectionFactory.

connectionTimeout - The connection timeout in milliseconds. A value <0 will preserve the current setting, a value of 0 will set an infinite timeout.

socketTimeout - The read timeout in milliseconds. A value <0 will preserve the current setting, a value of 0 will set an infinite timeout.

Method Detail

httpUrlConnection

public java.net.HttpURLConnection httpUrlConnection(java.net.URI uri)
                                             throws java.lang.IllegalArgumentException,
                                                    java.io.IOException

Description copied from interface: HttpUrlConnectionFactory

Returns an HttpURLConnection to the given Uri.

Specified by:

httpUrlConnection in interface HttpUrlConnectionFactory

Parameters:

uri - The uri to connect to. This must be an absolute URL.

Returns:

An HttpURLConnection.

Throws:

java.lang.IllegalArgumentException - if the given URI was not a valid absolute URL.

java.io.IOException