org.keycloak.connections.httpclient.HttpClientBuilder クラス

org.keycloak.connections.httpclient.HttpClientBuilder 連携図

クラス
enum	HostnameVerificationPolicy
class	PassthroughTrustManager
class	VerifierWrapper

公開メンバ関数
HttpClientBuilder	socketTimeout (long timeout, TimeUnit unit)
HttpClientBuilder	establishConnectionTimeout (long timeout, TimeUnit unit)
HttpClientBuilder	connectionTTL (long ttl, TimeUnit unit)
HttpClientBuilder	maxConnectionIdleTime (long maxConnectionIdleTime, TimeUnit unit)
HttpClientBuilder	maxPooledPerRoute (int maxPooledPerRoute)
HttpClientBuilder	connectionPoolSize (int connectionPoolSize)
HttpClientBuilder	disableTrustManager ()
HttpClientBuilder	disableCookies (boolean disable)
HttpClientBuilder	hostnameVerification (HostnameVerificationPolicy policy)
HttpClientBuilder	sslContext (SSLContext sslContext)
HttpClientBuilder	trustStore (KeyStore truststore)
HttpClientBuilder	keyStore (KeyStore keyStore, String password)
HttpClientBuilder	keyStore (KeyStore keyStore, char[] password)
HttpClientBuilder	proxyMappings (ProxyMappings proxyMappings)
CloseableHttpClient	build ()

限定公開変数類
KeyStore	truststore
KeyStore	clientKeyStore
String	clientPrivateKeyPassword
boolean	disableTrustManager
HostnameVerificationPolicy	policy = HostnameVerificationPolicy.WILDCARD
SSLContext	sslContext
int	connectionPoolSize = 128
int	maxPooledPerRoute = 64
long	connectionTTL = -1
TimeUnit	connectionTTLUnit = TimeUnit.MILLISECONDS
long	maxConnectionIdleTime = 900000
TimeUnit	maxConnectionIdleTimeUnit = TimeUnit.MILLISECONDS
HostnameVerifier	verifier = null
long	socketTimeout = -1
TimeUnit	socketTimeoutUnits = TimeUnit.MILLISECONDS
long	establishConnectionTimeout = -1
TimeUnit	establishConnectionTimeoutUnits = TimeUnit.MILLISECONDS
boolean	disableCookies = false
ProxyMappings	proxyMappings

非公開メンバ関数
SSLContext	createSslContext (final String algorithm, final KeyStore keystore, final String keyPassword, final KeyStore truststore, final SecureRandom random) throws NoSuchAlgorithmException, KeyManagementException, KeyStoreException, UnrecoverableKeyException

詳解

Abstraction for creating HttpClients. Allows SSL configuration.

著者

Bill Burke

バージョン

Revision

1

---

クラス詳解

org::keycloak::connections::httpclient::HttpClientBuilder::HostnameVerificationPolicy

enum org::keycloak::connections::httpclient::HttpClientBuilder::HostnameVerificationPolicy

org.keycloak.connections.httpclient.HttpClientBuilder.HostnameVerificationPolicy 連携図

列挙値
ANY	Hostname verification is not done on the server's certificate
STRICT	CN must match hostname connecting to
WILDCARD	Allows wildcards in subdomain names i.e. *.foo.com

関数詳解

build()

CloseableHttpClient org.keycloak.connections.httpclient.HttpClientBuilder.build ( )

inline

                                       {
        X509HostnameVerifier verifier = null;
        if (this.verifier != null) verifier = new VerifierWrapper(this.verifier);
        else {
            switch (policy) {
                case ANY:
                    verifier = new AllowAllHostnameVerifier();
                    break;
                case WILDCARD:
                    verifier = new BrowserCompatHostnameVerifier();
                    break;
                case STRICT:
                    verifier = new StrictHostnameVerifier();
                    break;
            }
        }
        try {
            SSLConnectionSocketFactory sslsf = null;
            SSLContext theContext = sslContext;
            if (disableTrustManager) {
                theContext = SSLContext.getInstance("TLS");
                theContext.init(null, new TrustManager[]{new PassthroughTrustManager()},
                        new SecureRandom());
                verifier = new AllowAllHostnameVerifier();
                sslsf = new SSLConnectionSocketFactory(theContext, verifier);
            } else if (theContext != null) {
                sslsf = new SSLConnectionSocketFactory(theContext, verifier);
            } else if (clientKeyStore != null || truststore != null) {
                theContext = createSslContext("TLS", clientKeyStore, clientPrivateKeyPassword, truststore, null);
                sslsf = new SSLConnectionSocketFactory(theContext, verifier);
            } else {
                final SSLContext tlsContext = SSLContext.getInstance("TLS");
                tlsContext.init(null, null, null);
                sslsf = new SSLConnectionSocketFactory(tlsContext, verifier);
            }

            RequestConfig requestConfig = RequestConfig.custom()
                    .setConnectTimeout((int) establishConnectionTimeout)
                    .setSocketTimeout((int) socketTimeout).build();

            org.apache.http.impl.client.HttpClientBuilder builder = HttpClients.custom()
                    .setDefaultRequestConfig(requestConfig)
                    .setSSLSocketFactory(sslsf)
                    .setMaxConnTotal(connectionPoolSize)
                    .setMaxConnPerRoute(maxPooledPerRoute)
                    .setConnectionTimeToLive(connectionTTL, connectionTTLUnit);


            if (proxyMappings != null && !proxyMappings.isEmpty()) {
                builder.setRoutePlanner(new ProxyMappingsAwareRoutePlanner(proxyMappings));
            }

            if (maxConnectionIdleTime > 0) {
                // Will start background cleaner thread
                builder.evictIdleConnections(maxConnectionIdleTime, maxConnectionIdleTimeUnit);
            }

            if (disableCookies) builder.disableCookieManagement();
            return builder.build();
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

connectionPoolSize()

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.connectionPoolSize ( int  connectionPoolSize )

inline

                                                                        {
        this.connectionPoolSize = connectionPoolSize;
        return this;
    }

connectionTTL()

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.connectionTTL ( long  ttl, TimeUnit  unit  )

inline

                                                                    {
        this.connectionTTL = ttl;
        this.connectionTTLUnit = unit;
        return this;
    }

createSslContext()

SSLContext org.keycloak.connections.httpclient.HttpClientBuilder.createSslContext ( final String  algorithm, final KeyStore  keystore, final String  keyPassword, final KeyStore  truststore, final SecureRandom  random  ) throws NoSuchAlgorithmException, KeyManagementException, KeyStoreException, UnrecoverableKeyException

inlineprivate

                                                                                                                  {
        return SSLContexts.custom()
                        .useProtocol(algorithm)
                        .setSecureRandom(random)
                        .loadKeyMaterial(keystore, keyPassword != null ? keyPassword.toCharArray() : null)
                        .loadTrustMaterial(truststore)
                        .build();
    }

disableCookies()

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.disableCookies ( boolean  disable )

inline

Disable cookie management.

                                                             {
        this.disableCookies = disable;
        return this;
    }

disableTrustManager()

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.disableTrustManager ( )

inline

Disable trust management and hostname verification. NOTE this is a security hole, so only set this option if you cannot or do not want to verify the identity of the host you are communicating with.

                                                   {
        this.disableTrustManager = true;
        return this;
    }

establishConnectionTimeout()

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.establishConnectionTimeout ( long  timeout, TimeUnit  unit  )

inline

When trying to make an initial socket connection, what is the timeout?

引数

timeout
unit

戻り値

    {
        this.establishConnectionTimeout = timeout;
        this.establishConnectionTimeoutUnits = unit;
        return this;
    }

hostnameVerification()

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.hostnameVerification ( HostnameVerificationPolicy  policy )

inline

SSL policy used to verify hostnames

引数

policy

戻り値

                                                                                     {
        this.policy = policy;
        return this;
    }

keyStore() [1/2]

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.keyStore ( KeyStore  keyStore, String  password  )

inline

                                                                          {
        this.clientKeyStore = keyStore;
        this.clientPrivateKeyPassword = password;
        return this;
    }

keyStore() [2/2]

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.keyStore ( KeyStore  keyStore, char []  password  )

inline

                                                                          {
        this.clientKeyStore = keyStore;
        this.clientPrivateKeyPassword = new String(password);
        return this;
    }

maxConnectionIdleTime()

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.maxConnectionIdleTime ( long  maxConnectionIdleTime, TimeUnit  unit  )

inline

                                                                                              {
        this.maxConnectionIdleTime = maxConnectionIdleTime;
        this.maxConnectionIdleTimeUnit = unit;
        return this;
    }

maxPooledPerRoute()

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.maxPooledPerRoute ( int  maxPooledPerRoute )

inline

                                                                      {
        this.maxPooledPerRoute = maxPooledPerRoute;
        return this;
    }

proxyMappings()

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.proxyMappings ( ProxyMappings  proxyMappings )

inline

                                                                        {
        this.proxyMappings = proxyMappings;
        return this;
    }

socketTimeout()

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.socketTimeout ( long  timeout, TimeUnit  unit  )

inline

Socket inactivity timeout

引数

timeout
unit

戻り値

    {
        this.socketTimeout = timeout;
        this.socketTimeoutUnits = unit;
        return this;
    }

sslContext()

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.sslContext ( SSLContext  sslContext )

inline

                                                               {
        this.sslContext = sslContext;
        return this;
    }

trustStore()

HttpClientBuilder org.keycloak.connections.httpclient.HttpClientBuilder.trustStore ( KeyStore  truststore )

inline

                                                             {
        this.truststore = truststore;
        return this;
    }

メンバ詳解

clientKeyStore

KeyStore org.keycloak.connections.httpclient.HttpClientBuilder.clientKeyStore

protected

clientPrivateKeyPassword

String org.keycloak.connections.httpclient.HttpClientBuilder.clientPrivateKeyPassword

protected

connectionPoolSize

int org.keycloak.connections.httpclient.HttpClientBuilder.connectionPoolSize = 128

protected

connectionTTL

long org.keycloak.connections.httpclient.HttpClientBuilder.connectionTTL = -1

protected

connectionTTLUnit

TimeUnit org.keycloak.connections.httpclient.HttpClientBuilder.connectionTTLUnit = TimeUnit.MILLISECONDS

protected

disableCookies

boolean org.keycloak.connections.httpclient.HttpClientBuilder.disableCookies = false

protected

disableTrustManager

boolean org.keycloak.connections.httpclient.HttpClientBuilder.disableTrustManager

protected

establishConnectionTimeout

long org.keycloak.connections.httpclient.HttpClientBuilder.establishConnectionTimeout = -1

protected

establishConnectionTimeoutUnits

TimeUnit org.keycloak.connections.httpclient.HttpClientBuilder.establishConnectionTimeoutUnits = TimeUnit.MILLISECONDS

protected

maxConnectionIdleTime

long org.keycloak.connections.httpclient.HttpClientBuilder.maxConnectionIdleTime = 900000

protected

maxConnectionIdleTimeUnit

TimeUnit org.keycloak.connections.httpclient.HttpClientBuilder.maxConnectionIdleTimeUnit = TimeUnit.MILLISECONDS

protected

maxPooledPerRoute

int org.keycloak.connections.httpclient.HttpClientBuilder.maxPooledPerRoute = 64

protected

policy

HostnameVerificationPolicy org.keycloak.connections.httpclient.HttpClientBuilder.policy = HostnameVerificationPolicy.WILDCARD

protected

proxyMappings

ProxyMappings org.keycloak.connections.httpclient.HttpClientBuilder.proxyMappings

protected

socketTimeout

long org.keycloak.connections.httpclient.HttpClientBuilder.socketTimeout = -1

protected

socketTimeoutUnits

TimeUnit org.keycloak.connections.httpclient.HttpClientBuilder.socketTimeoutUnits = TimeUnit.MILLISECONDS

protected

sslContext

SSLContext org.keycloak.connections.httpclient.HttpClientBuilder.sslContext

protected

truststore

KeyStore org.keycloak.connections.httpclient.HttpClientBuilder.truststore

protected

verifier

HostnameVerifier org.keycloak.connections.httpclient.HttpClientBuilder.verifier = null

protected

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/connections/httpclient/HttpClientBuilder.java