org.attribyte.api.http

Class ClientOptions

java.lang.Object

org.attribyte.api.http.ClientOptions

public class ClientOptions
extends java.lang.Object

Configuration options for clients.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientOptions.Builder Builds immutable instances of client options.

Field Summary

Fields

Modifier and Type	Field and Description
int	connectionTimeoutMillis The maximum amount of time to wait to establish a connection (5s).
boolean	followRedirects Should redirects be followed (true).
static ClientOptions	IMPLEMENTATION_DEFAULT Indicates that implementation defaults should be used.
int	maxConnectionsPerDestination The maximum number of connections per destination (1024).
int	maxConnectionsTotal The maximum number of connections for all destinations (4096).
java.lang.String	proxyHost A proxy server.
int	proxyPort The proxy server port.
int	requestBufferSize The request buffer size (4096).
int	requestTimeoutMillis The maximum amount of time to wait for a response after sending a request (5s).
int	responseBufferSize The response buffer size (16384).
int	socketTimeoutMillis The maximum amount of time to wait for a (blocking) socket read to return (5s).
java.lang.String	userAgent The user agent ('Attribyte/1.0').

Constructor Summary

Constructors

Constructor and Description
ClientOptions(java.lang.String prefix, java.util.Properties props) Creates options from properties.

Method Summary

Modifier and Type	Method and Description
boolean	getBooleanProperty(java.lang.String name, boolean defaultValue) Gets a boolean property.
int	getIntProperty(java.lang.String name, int defaultValue) Gets an integer property.
java.lang.String	getProperty(java.lang.String name, java.lang.String defaultValue) Gets a property.
int	getTimeProperty(java.lang.String name, int defaultValue) Gets a time (string) property as milliseconds.

Methods inherited from class java.lang.Object

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

Field Detail

IMPLEMENTATION_DEFAULT

public static final ClientOptions IMPLEMENTATION_DEFAULT

Indicates that implementation defaults should be used.

userAgent

public final java.lang.String userAgent

The user agent ('Attribyte/1.0').

connectionTimeoutMillis

public final int connectionTimeoutMillis

The maximum amount of time to wait to establish a connection (5s).

requestTimeoutMillis

public final int requestTimeoutMillis

The maximum amount of time to wait for a response after sending a request (5s).

socketTimeoutMillis

public final int socketTimeoutMillis

The maximum amount of time to wait for a (blocking) socket read to return (5s).

proxyHost

public final java.lang.String proxyHost

A proxy server.

proxyPort

public final int proxyPort

The proxy server port.

followRedirects

public final boolean followRedirects

Should redirects be followed (true).

maxConnectionsPerDestination

public final int maxConnectionsPerDestination

The maximum number of connections per destination (1024).

maxConnectionsTotal

public final int maxConnectionsTotal

The maximum number of connections for all destinations (4096).

requestBufferSize

public final int requestBufferSize

The request buffer size (4096).

responseBufferSize

public final int responseBufferSize

The response buffer size (16384).

Constructor Detail

ClientOptions

public ClientOptions(java.lang.String prefix,
                     java.util.Properties props)
              throws InitializationException

Creates options from properties.

Parameters:

prefix - A prefix applied to all property names.

props - The properties.

Throws:

InitializationException - on invalid property.

Method Detail

getProperty

public java.lang.String getProperty(java.lang.String name,
                                    java.lang.String defaultValue)

Gets a property.

Parameters:

name - The property name.

defaultValue - The default value.

Returns:

The property or default value.

getIntProperty

public int getIntProperty(java.lang.String name,
                          int defaultValue)

Gets an integer property.

Parameters:

name - The property name.

defaultValue - The default value.

Returns:

The property or default value.

getBooleanProperty

public boolean getBooleanProperty(java.lang.String name,
                                  boolean defaultValue)

Gets a boolean property.

Parameters:

name - The property name.

defaultValue - The default value.

Returns:

The property or default value.

getTimeProperty

public int getTimeProperty(java.lang.String name,
                           int defaultValue)

Gets a time (string) property as milliseconds.

Parameters:

name - The property name.

defaultValue - The default value.

Returns:

The property or default value.