com.atlassian.marketplace.client.http

Class HttpConfiguration.Builder

java.lang.Object

com.atlassian.marketplace.client.http.HttpConfiguration.Builder

Enclosing class:

HttpConfiguration

public static class HttpConfiguration.Builder
extends Object

Builder class for HttpConfiguration. Use HttpConfiguration.builder() to create an instance.

Constructor Summary

Constructors

Constructor and Description
HttpConfiguration.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
HttpConfiguration	build()
HttpConfiguration.Builder	connectTimeoutMillis(Integer connectTimeoutMillis) Sets the length of time to wait for a connection before timing out.
HttpConfiguration.Builder	credentials(com.atlassian.fugue.Option<HttpConfiguration.Credentials> credentials) Sets a username and password for basic authentication.
HttpConfiguration.Builder	maxCacheEntries(int maxCacheEntries) Sets the maximum number of HTTP responses that will be stored in the HTTP cache at a time.
HttpConfiguration.Builder	maxCacheObjectSize(long maxCacheObjectSize) Sets the maximum size of HTTP responses that can be stored in the HTTP cache.
HttpConfiguration.Builder	maxConnections(int maxConnections) Sets the maximum number of simultaneous HTTP connections the client can make to the server.
HttpConfiguration.Builder	maxRedirects(com.atlassian.fugue.Option<Integer> maxRedirects) Sets the maximum number of redirects that will be automatically followed.
HttpConfiguration.Builder	proxyConfiguration(com.atlassian.fugue.Option<HttpConfiguration.ProxyConfiguration> proxy) Sets HTTP proxy server parameters.
HttpConfiguration.Builder	readTimeoutMillis(Integer readTimeoutMillis) Sets the length of time to wait for a server response before timing out.
HttpConfiguration.Builder	requestDecorator(com.atlassian.fugue.Option<RequestDecorator> requestDecorator) Specifies an object that can provide custom headers for HTTP requests, e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpConfiguration.Builder

public HttpConfiguration.Builder()

Method Detail

build

public HttpConfiguration build()

connectTimeoutMillis

public HttpConfiguration.Builder connectTimeoutMillis(Integer connectTimeoutMillis)

Sets the length of time to wait for a connection before timing out.

Parameters:

connectTimeoutMillis - a number of milliseconds; null to use HttpConfiguration.DEFAULT_CONNECT_TIMEOUT_MILLIS

Returns:

the same Builder

readTimeoutMillis

public HttpConfiguration.Builder readTimeoutMillis(Integer readTimeoutMillis)

Sets the length of time to wait for a server response before timing out.

Parameters:

readTimeoutMillis - a number of milliseconds; null to use HttpConfiguration.DEFAULT_READ_TIMEOUT_MILLIS

Returns:

the same Builder

maxConnections

public HttpConfiguration.Builder maxConnections(int maxConnections)

Sets the maximum number of simultaneous HTTP connections the client can make to the server.

Parameters:

maxConnections - the maximum number of simultaneous connections; default is HttpConfiguration.DEFAULT_MAX_CONNECTIONS

Returns:

the same Builder

maxCacheEntries

public HttpConfiguration.Builder maxCacheEntries(int maxCacheEntries)

Sets the maximum number of HTTP responses that will be stored in the HTTP cache at a time.

Parameters:

maxCacheEntries - maximum number of cache entries; default is HttpConfiguration.DEFAULT_MAX_CACHE_ENTRIES

Returns:

the same Builder

maxCacheObjectSize

public HttpConfiguration.Builder maxCacheObjectSize(long maxCacheObjectSize)

Sets the maximum size of HTTP responses that can be stored in the HTTP cache.

Parameters:

maxCacheObjectSize - maximum cacheable object size in bytes; default is HttpConfiguration.DEFAULT_MAX_CACHE_OBJECT_SIZE

Returns:

the same Builder

maxRedirects

public HttpConfiguration.Builder maxRedirects(com.atlassian.fugue.Option<Integer> maxRedirects)

Sets the maximum number of redirects that will be automatically followed.

Parameters:

maxRedirects - maximum number of redirects, if any

Returns:

the same Builder

credentials

public HttpConfiguration.Builder credentials(com.atlassian.fugue.Option<HttpConfiguration.Credentials> credentials)

Sets a username and password for basic authentication. Authentication is not required for standard use of the client; authenticating with a valid marketplace.atlassian.com account will allow you to see unpublished versions of plugins you have permission to edit.

Parameters:

credentials - a HttpConfiguration.Credentials object wrapped in Option.some(A); or Option.none() to turn off authentication

Returns:

the same Builder

proxyConfiguration

public HttpConfiguration.Builder proxyConfiguration(com.atlassian.fugue.Option<HttpConfiguration.ProxyConfiguration> proxy)

Sets HTTP proxy server parameters. You do not have to do this if a proxy was already specified in standard system properties supported by the JRE (http.proxyHost, etc.). However, if you want to use proxy authentication which the JRE does not support, you must supply a ProxyConfiguration.

Parameters:

proxy - a HttpConfiguration.ProxyConfiguration object wrapped in Option.some(A), or Option.none() to use no proxy (unless one was already specified in system properties)

Returns:

the same Builder

requestDecorator

public HttpConfiguration.Builder requestDecorator(com.atlassian.fugue.Option<RequestDecorator> requestDecorator)

Specifies an object that can provide custom headers for HTTP requests, e.g. to set the User-Agent header.

Parameters:

requestDecorator - a RequestDecorator object wrapped in Option.some(A), or Option.none() for no decorator

Returns:

the same Builder