public abstract class HttpClientBuilder
extends java.lang.Object
HttpClient
instance.
The following code illustrates typical scheme of creating and configuring a HttpClient
instance:
// default client builder HttpClientBuilder clientBuilder = HttpClientBuilder.getInstance(); // additional configuration of client builder clientBuilder.addRequestFilter(new UserRequestFilter()); clientBuilder.addResponseFilter(new UserResponseFilter()); // additional connection option ConnectionOption<Integer> timeoutOption = new ConnectionOption<>("Timeout", 2000); clientBuilder.addConnectionOptions(timeoutOption); // configured client instance // client instance is the main entry point which is used for preparing client requests. HttpClient client = clientBuilder.build();
HttpClientBuilder
allows an application to explicitly specify connection options: proxy, timeout, etc.
ConnectionOption<String> proxy = new ConnectionOption<>("Proxy", "proxy.myhost.org:80"); ConnectionOption<Integer> timeout = new ConnectionOption<>("Timeout", 2000); HttpClientBuilder clientBuilder = HttpClientBuilder.getInstance() .addConnectionOptions(proxy, timeout);
ConnectionOption
,
AccessPoint
Constructor and Description |
---|
HttpClientBuilder() |
Modifier and Type | Method and Description |
---|---|
abstract HttpClientBuilder |
addConnectionOptions(javax.microedition.io.ConnectionOption<?>... options)
Adds connection specific configuration settings.
|
abstract HttpClientBuilder |
addRequestFilter(HttpRequestFilter filter)
Adds a new request filter that will be used for handling
a client outbound request.
|
abstract HttpClientBuilder |
addResponseFilter(HttpResponseFilter filter)
Adds a new response filter that will be used for handling
an inbound response.
|
abstract HttpClient |
build()
Returns a new instance
HttpClient . |
abstract javax.microedition.io.AccessPoint |
getAccessPoint()
Returns the network configuration.
|
abstract java.util.List<javax.microedition.io.ConnectionOption<?>> |
getConnectionOptions()
Returns an unmodifiable list of connection settings.
|
static HttpClientBuilder |
getInstance()
Returns a new instance
HttpClientBuilder . |
static HttpClientBuilder |
getInstance(HttpClient client)
Returns a new instance
HttpClientBuilder . |
static HttpClientBuilder |
getInstance(HttpClientBuilder builder)
Returns a new instance
HttpClientBuilder . |
abstract java.util.List<HttpRequestFilter> |
getRequestFilters()
Returns an unmodifiable list of request filters.
|
abstract java.util.List<HttpResponseFilter> |
getResponseFilters()
Returns an unmodifiable list of response filters.
|
abstract HttpClientBuilder |
removeConnectionOption(javax.microedition.io.ConnectionOption<?> option)
Removes the given
option . |
abstract HttpClientBuilder |
removeRequestFilter(HttpRequestFilter filter)
Removes the
filter from request filters chain. |
abstract HttpClientBuilder |
removeResponseFilter(HttpResponseFilter filter)
Removes the
filter from response filters chain. |
abstract HttpClientBuilder |
setAccessPoint(javax.microedition.io.AccessPoint accessPoint)
Set the network configuration to be used to establish a network connection.
|
public static HttpClientBuilder getInstance()
HttpClientBuilder
.HttpClientBuilder
.public static HttpClientBuilder getInstance(HttpClientBuilder builder)
HttpClientBuilder
.
The state of a new builder will be copied from the given builder
.builder
- data used to provide initial state for the new client builder.HttpClientBuilder
.java.lang.NullPointerException
- in case of builder
is null
.public static HttpClientBuilder getInstance(HttpClient client)
HttpClientBuilder
.
The state of a new builder will be copied from the given client
.client
- data used to provide initial state for the new client builder.HttpClientBuilder
.java.lang.NullPointerException
- in case of client
is null
.public abstract HttpClientBuilder addRequestFilter(HttpRequestFilter filter)
filter
- an instance of request filter.java.lang.NullPointerException
- in case of filter
is null
.public abstract HttpClientBuilder addResponseFilter(HttpResponseFilter filter)
filter
- an instance of request filter.java.lang.NullPointerException
- in case of filter
is null
.public abstract HttpClientBuilder removeRequestFilter(HttpRequestFilter filter)
filter
from request filters chain.filter
- an instance of request filter.java.lang.NullPointerException
- in case of filter
is null
.public abstract HttpClientBuilder removeResponseFilter(HttpResponseFilter filter)
filter
from response filters chain.filter
- an instance of request filter.java.lang.NullPointerException
- in case of filter
is null
.public abstract java.util.List<HttpRequestFilter> getRequestFilters()
null
.public abstract java.util.List<HttpResponseFilter> getResponseFilters()
null
.public abstract HttpClientBuilder setAccessPoint(javax.microedition.io.AccessPoint accessPoint)
addConnectionOptions(new ConnectionOption<AccessPoint>("AccessPoint", accessPoint))
.
Note, connection/disconnection of the given accessPoint
is the responsibility of the application.
accessPoint
- network configuration. A null
value will unset the access point.public abstract javax.microedition.io.AccessPoint getAccessPoint()
public abstract HttpClientBuilder addConnectionOptions(javax.microedition.io.ConnectionOption<?>... options)
options
- specific configuration settings.public abstract HttpClientBuilder removeConnectionOption(javax.microedition.io.ConnectionOption<?> option)
option
.option
- to be removed if present.java.lang.NullPointerException
- in case of option
is null
.public abstract java.util.List<javax.microedition.io.ConnectionOption<?>> getConnectionOptions()
null
.public abstract HttpClient build()
HttpClient
.HttpClient
.Copyright © 2013, 2014, Oracle and/or its affiliates. All rights reserved.