org.keycloak.adapters.HttpClientBuilder クラス

org.keycloak.adapters.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	maxPooledPerRoute (int maxPooledPerRoute)
HttpClientBuilder	connectionPoolSize (int connectionPoolSize)
HttpClientBuilder	disableTrustManager ()
HttpClientBuilder	disableCookieCache (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)
HttpClient	build ()
HttpClient	build (AdapterHttpClientConfig adapterConfig)

限定公開変数類
KeyStore	truststore
KeyStore	clientKeyStore
String	clientPrivateKeyPassword
boolean	disableTrustManager
boolean	disableCookieCache = true
HostnameVerificationPolicy	policy = HostnameVerificationPolicy.WILDCARD
SSLContext	sslContext
int	connectionPoolSize = 100
int	maxPooledPerRoute = 0
long	connectionTTL = -1
TimeUnit	connectionTTLUnit = TimeUnit.MILLISECONDS
HostnameVerifier	verifier = null
long	socketTimeout = -1
TimeUnit	socketTimeoutUnits = TimeUnit.MILLISECONDS
long	establishConnectionTimeout = -1
TimeUnit	establishConnectionTimeoutUnits = TimeUnit.MILLISECONDS
HttpHost	proxyHost

非公開メンバ関数
void	configureProxyForAuthServerIfProvided (AdapterHttpClientConfig adapterConfig)

詳解

Abstraction for creating HttpClients. Allows SSL configuration.

著者

Bill Burke

バージョン

Revision

1

---

クラス詳解

org::keycloak::adapters::HttpClientBuilder::HostnameVerificationPolicy

enum org::keycloak::adapters::HttpClientBuilder::HostnameVerificationPolicy

org.keycloak.adapters.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() [1/2]

HttpClient org.keycloak.adapters.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 {
            SSLSocketFactory sslsf = null;
            SSLContext theContext = sslContext;
            if (disableTrustManager) {
                theContext = SSLContext.getInstance("SSL");
                theContext.init(null, new TrustManager[]{new PassthroughTrustManager()},
                        new SecureRandom());
                verifier = new AllowAllHostnameVerifier();
                sslsf = new SniSSLSocketFactory(theContext, verifier);
            } else if (theContext != null) {
                sslsf = new SniSSLSocketFactory(theContext, verifier);
            } else if (clientKeyStore != null || truststore != null) {
                sslsf = new SniSSLSocketFactory(SSLSocketFactory.TLS, clientKeyStore, clientPrivateKeyPassword, truststore, null, verifier);
            } else {
                final SSLContext tlsContext = SSLContext.getInstance(SSLSocketFactory.TLS);
                tlsContext.init(null, null, null);
                sslsf = new SniSSLSocketFactory(tlsContext, verifier);
            }
            SchemeRegistry registry = new SchemeRegistry();
            registry.register(
                    new Scheme("http", 80, PlainSocketFactory.getSocketFactory()));
            Scheme httpsScheme = new Scheme("https", 443, sslsf);
            registry.register(httpsScheme);
            ClientConnectionManager cm = null;
            if (connectionPoolSize > 0) {
                ThreadSafeClientConnManager tcm = new ThreadSafeClientConnManager(registry, connectionTTL, connectionTTLUnit);
                tcm.setMaxTotal(connectionPoolSize);
                if (maxPooledPerRoute == 0) maxPooledPerRoute = connectionPoolSize;
                tcm.setDefaultMaxPerRoute(maxPooledPerRoute);
                cm = tcm;

            } else {
                cm = new SingleClientConnManager(registry);
            }
            BasicHttpParams params = new BasicHttpParams();
            params.setParameter(ClientPNames.COOKIE_POLICY, CookiePolicy.BROWSER_COMPATIBILITY);

            if (proxyHost != null) {
                params.setParameter(ConnRoutePNames.DEFAULT_PROXY, proxyHost);
            }

            if (socketTimeout > -1) {
                HttpConnectionParams.setSoTimeout(params, (int) socketTimeoutUnits.toMillis(socketTimeout));

            }
            if (establishConnectionTimeout > -1) {
                HttpConnectionParams.setConnectionTimeout(params, (int) establishConnectionTimeoutUnits.toMillis(establishConnectionTimeout));
            }
            DefaultHttpClient client = new DefaultHttpClient(cm, params);

            if (disableCookieCache) {
                client.setCookieStore(new CookieStore() {
                    @Override
                    public void addCookie(Cookie cookie) {
                        //To change body of implemented methods use File | Settings | File Templates.
                    }

                    @Override
                    public List<Cookie> getCookies() {
                        return Collections.emptyList();
                    }

                    @Override
                    public boolean clearExpired(Date date) {
                        return false;  //To change body of implemented methods use File | Settings | File Templates.
                    }

                    @Override
                    public void clear() {
                        //To change body of implemented methods use File | Settings | File Templates.
                    }
                });

            }
            return client;
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

build() [2/2]

HttpClient org.keycloak.adapters.HttpClientBuilder.build ( AdapterHttpClientConfig  adapterConfig )

inline

                                                                   {
        disableCookieCache(true); // disable cookie cache as we don't want sticky sessions for load balancing

        String truststorePath = adapterConfig.getTruststore();
        if (truststorePath != null) {
            truststorePath = EnvUtil.replace(truststorePath);
            String truststorePassword = adapterConfig.getTruststorePassword();
            try {
                this.truststore = KeystoreUtil.loadKeyStore(truststorePath, truststorePassword);
            } catch (Exception e) {
                throw new RuntimeException("Failed to load truststore", e);
            }
        }
        String clientKeystore = adapterConfig.getClientKeystore();
        if (clientKeystore != null) {
            clientKeystore = EnvUtil.replace(clientKeystore);
            String clientKeystorePassword = adapterConfig.getClientKeystorePassword();
            try {
                KeyStore clientCertKeystore = KeystoreUtil.loadKeyStore(clientKeystore, clientKeystorePassword);
                keyStore(clientCertKeystore, clientKeystorePassword);
            } catch (Exception e) {
                throw new RuntimeException("Failed to load keystore", e);
            }
        }
        int size = 10;
        if (adapterConfig.getConnectionPoolSize() > 0)
            size = adapterConfig.getConnectionPoolSize();
        HttpClientBuilder.HostnameVerificationPolicy policy = HttpClientBuilder.HostnameVerificationPolicy.WILDCARD;
        if (adapterConfig.isAllowAnyHostname())
            policy = HttpClientBuilder.HostnameVerificationPolicy.ANY;
        connectionPoolSize(size);
        hostnameVerification(policy);
        if (adapterConfig.isDisableTrustManager()) {
            disableTrustManager();
        } else {
            trustStore(truststore);
        }

        configureProxyForAuthServerIfProvided(adapterConfig);

        return build();
    }

configureProxyForAuthServerIfProvided()

void org.keycloak.adapters.HttpClientBuilder.configureProxyForAuthServerIfProvided ( AdapterHttpClientConfig  adapterConfig )

inlineprivate

Configures a the proxy to use for auth-server requests if provided.

If the given AdapterHttpClientConfig contains the attribute

proxy-url 

we use the given URL as a proxy server, otherwise the proxy configuration is ignored.

引数

adapterConfig

                                                                                              {

        if (adapterConfig == null || adapterConfig.getProxyUrl() == null || adapterConfig.getProxyUrl().trim().isEmpty()) {
            return;
        }

        URI uri = URI.create(adapterConfig.getProxyUrl());
        this.proxyHost = new HttpHost(uri.getHost(), uri.getPort(), uri.getScheme());
    }

connectionPoolSize()

HttpClientBuilder org.keycloak.adapters.HttpClientBuilder.connectionPoolSize ( int  connectionPoolSize )

inline

                                                                        {
        this.connectionPoolSize = connectionPoolSize;
        return this;
    }

connectionTTL()

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

inline

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

disableCookieCache()

HttpClientBuilder org.keycloak.adapters.HttpClientBuilder.disableCookieCache ( boolean  disable )

inline

                                                                 {
        this.disableCookieCache = disable;
        return this;
    }

disableTrustManager()

HttpClientBuilder org.keycloak.adapters.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.adapters.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.adapters.HttpClientBuilder.hostnameVerification ( HostnameVerificationPolicy  policy )

inline

SSL policy used to verify hostnames

引数

policy

戻り値

                                                                                     {
        this.policy = policy;
        return this;
    }

keyStore() [1/2]

HttpClientBuilder org.keycloak.adapters.HttpClientBuilder.keyStore ( KeyStore  keyStore, String  password  )

inline

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

keyStore() [2/2]

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

inline

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

maxPooledPerRoute()

HttpClientBuilder org.keycloak.adapters.HttpClientBuilder.maxPooledPerRoute ( int  maxPooledPerRoute )

inline

                                                                      {
        this.maxPooledPerRoute = maxPooledPerRoute;
        return this;
    }

socketTimeout()

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

inline

Socket inactivity timeout

引数

timeout
unit

戻り値

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

sslContext()

HttpClientBuilder org.keycloak.adapters.HttpClientBuilder.sslContext ( SSLContext  sslContext )

inline

                                                               {
        this.sslContext = sslContext;
        return this;
    }

trustStore()

HttpClientBuilder org.keycloak.adapters.HttpClientBuilder.trustStore ( KeyStore  truststore )

inline

                                                             {
        this.truststore = truststore;
        return this;
    }

メンバ詳解

clientKeyStore

KeyStore org.keycloak.adapters.HttpClientBuilder.clientKeyStore

protected

clientPrivateKeyPassword

String org.keycloak.adapters.HttpClientBuilder.clientPrivateKeyPassword

protected

connectionPoolSize

int org.keycloak.adapters.HttpClientBuilder.connectionPoolSize = 100

protected

connectionTTL

long org.keycloak.adapters.HttpClientBuilder.connectionTTL = -1

protected

connectionTTLUnit

TimeUnit org.keycloak.adapters.HttpClientBuilder.connectionTTLUnit = TimeUnit.MILLISECONDS

protected

disableCookieCache

boolean org.keycloak.adapters.HttpClientBuilder.disableCookieCache = true

protected

disableTrustManager

boolean org.keycloak.adapters.HttpClientBuilder.disableTrustManager

protected

establishConnectionTimeout

long org.keycloak.adapters.HttpClientBuilder.establishConnectionTimeout = -1

protected

establishConnectionTimeoutUnits

TimeUnit org.keycloak.adapters.HttpClientBuilder.establishConnectionTimeoutUnits = TimeUnit.MILLISECONDS

protected

maxPooledPerRoute

int org.keycloak.adapters.HttpClientBuilder.maxPooledPerRoute = 0

protected

policy

HostnameVerificationPolicy org.keycloak.adapters.HttpClientBuilder.policy = HostnameVerificationPolicy.WILDCARD

protected

proxyHost

HttpHost org.keycloak.adapters.HttpClientBuilder.proxyHost

protected

socketTimeout

long org.keycloak.adapters.HttpClientBuilder.socketTimeout = -1

protected

socketTimeoutUnits

TimeUnit org.keycloak.adapters.HttpClientBuilder.socketTimeoutUnits = TimeUnit.MILLISECONDS

protected

sslContext

SSLContext org.keycloak.adapters.HttpClientBuilder.sslContext

protected

truststore

KeyStore org.keycloak.adapters.HttpClientBuilder.truststore

protected

verifier

HostnameVerifier org.keycloak.adapters.HttpClientBuilder.verifier = null

protected

---

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

• D:/AppData/OpenId/keycloak/doxygen/src/adapters/oidc/adapter-core/src/main/java/org/keycloak/adapters/HttpClientBuilder.java