org.apache.http.client.fluent.Executor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fluent-hc Show documentation
Show all versions of fluent-hc Show documentation
Apache HttpComponents Client fluent API
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
*
* A {@link PoolingHttpClientConnectionManager} with maximum 100 connections per route and
* a total maximum of 200 connections is used internally.
*
*/
public class Executor {
final static PoolingHttpClientConnectionManager CONNMGR;
final static HttpClient CLIENT;
static {
LayeredConnectionSocketFactory ssl = null;
try {
ssl = SSLConnectionSocketFactory.getSystemSocketFactory();
} catch (final SSLInitializationException ex) {
final SSLContext sslcontext;
try {
sslcontext = SSLContext.getInstance(SSLConnectionSocketFactory.TLS);
sslcontext.init(null, null, null);
ssl = new SSLConnectionSocketFactory(sslcontext);
} catch (final SecurityException ignore) {
} catch (final KeyManagementException ignore) {
} catch (final NoSuchAlgorithmException ignore) {
}
}
final Registry sfr = RegistryBuilder.create()
.register("http", PlainConnectionSocketFactory.getSocketFactory())
.register("https", ssl != null ? ssl : SSLConnectionSocketFactory.getSocketFactory())
.build();
CONNMGR = new PoolingHttpClientConnectionManager(sfr);
CONNMGR.setDefaultMaxPerRoute(100);
CONNMGR.setMaxTotal(200);
CONNMGR.setValidateAfterInactivity(1000);
CLIENT = HttpClientBuilder.create()
.setConnectionManager(CONNMGR)
.build();
}
public static Executor newInstance() {
return new Executor(CLIENT);
}
public static Executor newInstance(final HttpClient httpclient) {
return new Executor(httpclient != null ? httpclient : CLIENT);
}
private final HttpClient httpclient;
private volatile AuthCache authCache;
private volatile CredentialsProvider credentialsProvider;
private volatile CookieStore cookieStore;
Executor(final HttpClient httpclient) {
super();
this.httpclient = httpclient;
this.authCache = new BasicAuthCache();
}
/**
* @since 4.5
*/
public Executor use(final CredentialsProvider credentialsProvider) {
this.credentialsProvider = credentialsProvider;
return this;
}
public Executor auth(final AuthScope authScope, final Credentials creds) {
if (this.credentialsProvider == null) {
this.credentialsProvider = new BasicCredentialsProvider();
}
this.credentialsProvider.setCredentials(authScope, creds);
return this;
}
public Executor auth(final HttpHost host, final Credentials creds) {
final AuthScope authScope = host != null ?
new AuthScope(host.getHostName(), host.getPort()) : AuthScope.ANY;
return auth(authScope, creds);
}
/**
* @since 4.4
*/
public Executor auth(final String host, final Credentials creds) {
return auth(HttpHost.create(host), creds);
}
public Executor authPreemptive(final HttpHost host) {
final BasicScheme basicScheme = new BasicScheme();
try {
basicScheme.processChallenge(new BasicHeader(AUTH.WWW_AUTH, "BASIC "));
} catch (final MalformedChallengeException ignore) {
}
this.authCache.put(host, basicScheme);
return this;
}
/**
* @since 4.4
*/
public Executor authPreemptive(final String host) {
return authPreemptive(HttpHost.create(host));
}
public Executor authPreemptiveProxy(final HttpHost proxy) {
final BasicScheme basicScheme = new BasicScheme();
try {
basicScheme.processChallenge(new BasicHeader(AUTH.PROXY_AUTH, "BASIC "));
} catch (final MalformedChallengeException ignore) {
}
this.authCache.put(proxy, basicScheme);
return this;
}
/**
* @since 4.4
*/
public Executor authPreemptiveProxy(final String proxy) {
return authPreemptiveProxy(HttpHost.create(proxy));
}
public Executor auth(final Credentials cred) {
return auth(AuthScope.ANY, cred);
}
public Executor auth(final String username, final String password) {
return auth(new UsernamePasswordCredentials(username, password));
}
public Executor auth(final String username, final String password,
final String workstation, final String domain) {
return auth(new NTCredentials(username, password, workstation, domain));
}
public Executor auth(final HttpHost host,
final String username, final String password) {
return auth(host, new UsernamePasswordCredentials(username, password));
}
public Executor auth(final HttpHost host,
final String username, final String password,
final String workstation, final String domain) {
return auth(host, new NTCredentials(username, password, workstation, domain));
}
public Executor clearAuth() {
if (this.credentialsProvider != null) {
this.credentialsProvider.clear();
}
return this;
}
/**
* @deprecated (4.5) Use {@link #use(CookieStore)}.
*/
@Deprecated
public Executor cookieStore(final CookieStore cookieStore) {
this.cookieStore = cookieStore;
return this;
}
/**
* @since 4.5
*/
public Executor use(final CookieStore cookieStore) {
this.cookieStore = cookieStore;
return this;
}
public Executor clearCookies() {
if (this.cookieStore != null) {
this.cookieStore.clear();
}
return this;
}
/**
* Executes the request. Please Note that response content must be processed
* or discarded using {@link Response#discardContent()}, otherwise the
* connection used for the request might not be released to the pool.
*
* @see Response#handleResponse(org.apache.http.client.ResponseHandler)
* @see Response#discardContent()
*/
public Response execute(
final Request request) throws ClientProtocolException, IOException {
final HttpClientContext localContext = HttpClientContext.create();
if (this.credentialsProvider != null) {
localContext.setAttribute(HttpClientContext.CREDS_PROVIDER, this.credentialsProvider);
}
if (this.authCache != null) {
localContext.setAttribute(HttpClientContext.AUTH_CACHE, this.authCache);
}
if (this.cookieStore != null) {
localContext.setAttribute(HttpClientContext.COOKIE_STORE, this.cookieStore);
}
return new Response(request.internalExecute(this.httpclient, localContext));
}
/**
* @deprecated (4.3) do not use.
*/
@Deprecated
public static void registerScheme(final org.apache.http.conn.scheme.Scheme scheme) {
}
/**
* @deprecated (4.3) do not use.
*/
@Deprecated
public static void unregisterScheme(final String name) {
}
/**
* Closes all idle persistent connections used by the internal pool.
* @since 4.4
*/
public static void closeIdleConnections() {
CONNMGR.closeIdleConnections(0, TimeUnit.MICROSECONDS);
}
}