org.keycloak.adapters.AdapterDeploymentContext クラス

org.keycloak.adapters.AdapterDeploymentContext 連携図

クラス
class	DeploymentDelegate

公開メンバ関数
	AdapterDeploymentContext ()
	AdapterDeploymentContext (KeycloakDeployment deployment)
	AdapterDeploymentContext (KeycloakConfigResolver configResolver)
KeycloakDeployment	resolveDeployment (HttpFacade facade)
void	updateDeployment (AdapterConfig config)

限定公開メンバ関数
KeycloakDeployment	resolveUrls (KeycloakDeployment deployment, HttpFacade facade)
KeycloakUriBuilder	getBaseBuilder (HttpFacade facade, String base)
void	close (HttpResponse response)

限定公開変数類
KeycloakDeployment	deployment
KeycloakConfigResolver	configResolver

静的非公開変数類
static final Logger	log = Logger.getLogger(AdapterDeploymentContext.class)

詳解

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

AdapterDeploymentContext() [1/3]

org.keycloak.adapters.AdapterDeploymentContext.AdapterDeploymentContext ( )

inline

                                      {
    }

AdapterDeploymentContext() [2/3]

org.keycloak.adapters.AdapterDeploymentContext.AdapterDeploymentContext ( KeycloakDeployment  deployment )

inline

For single-tenant deployments, this constructor is to be used, as a full KeycloakDeployment is known at deployment time and won't change during the application deployment's life cycle.

引数

deployment

A KeycloakConfigResolver, possibly missing the Auth Server URL

                                                                   {
        this.deployment = deployment;
    }

AdapterDeploymentContext() [3/3]

org.keycloak.adapters.AdapterDeploymentContext.AdapterDeploymentContext ( KeycloakConfigResolver  configResolver )

inline

For multi-tenant deployments, this constructor is to be used, as a KeycloakDeployment is not known at deployment time. It defers the resolution of a KeycloakDeployment to a KeycloakConfigResolver, to be implemented by the target application.

引数

configResolver

A KeycloakConfigResolver that will be used to resolve a KeycloakDeployment

                                                                           {
        this.configResolver = configResolver;
    }

関数詳解

close()

void org.keycloak.adapters.AdapterDeploymentContext.close ( HttpResponse  response )

inlineprotected

                                                {
        if (response.getEntity() != null) {
            try {
                response.getEntity().getContent().close();
            } catch (IOException e) {

            }
        }
    }

getBaseBuilder()

KeycloakUriBuilder org.keycloak.adapters.AdapterDeploymentContext.getBaseBuilder ( HttpFacade  facade, String  base  )

inlineprotected

                                                                                {
        KeycloakUriBuilder builder = KeycloakUriBuilder.fromUri(base);
        URI request = URI.create(facade.getRequest().getURI());
        String scheme = request.getScheme();
        if (deployment.getSslRequired().isRequired(facade.getRequest().getRemoteAddr())) {
            scheme = "https";
            if (!request.getScheme().equals(scheme) && request.getPort() != -1) {
                log.error("request scheme: " + request.getScheme() + " ssl required");
                throw new RuntimeException("Can't resolve relative url from adapter config.");
            }
        }
        builder.scheme(scheme);
        builder.host(request.getHost());
        if (request.getPort() != -1) {
           builder.port(request.getPort());
        }
        return builder;
    }

resolveDeployment()

KeycloakDeployment org.keycloak.adapters.AdapterDeploymentContext.resolveDeployment ( HttpFacade  facade )

inline

For single-tenant deployments, it complements KeycloakDeployment by resolving a relative Auth Server's URL based on the current request

For multi-tenant deployments, defers the resolution of KeycloakDeployment to the KeycloakConfigResolver .

引数

facade

the Request/Response Façade , used to either determine the Auth Server URL (single tenant) or pass thru to the KeycloakConfigResolver.

戻り値

                                                                   {
        if (null != configResolver) {
            return configResolver.resolve(facade.getRequest());
        }

        if (deployment == null) return null;
        if (deployment.getAuthServerBaseUrl() == null) return deployment;

        KeycloakDeployment resolvedDeployment = resolveUrls(deployment, facade);
        if (resolvedDeployment.getPublicKeyLocator() == null) {
            throw new RuntimeException("KeycloakDeployment was never initialized through appropriate SPIs");
        }
        return resolvedDeployment;
    }

resolveUrls()

KeycloakDeployment org.keycloak.adapters.AdapterDeploymentContext.resolveUrls ( KeycloakDeployment  deployment, HttpFacade  facade  )

inlineprotected

                                                                                               {
        if (deployment.relativeUrls == RelativeUrlsUsed.NEVER) {
            // Absolute URI are already set to everything
            return deployment;
        } else {
            DeploymentDelegate delegate = new DeploymentDelegate(this.deployment);
            delegate.setAuthServerBaseUrl(getBaseBuilder(facade, this.deployment.getAuthServerBaseUrl()).build().toString());
            return delegate;
        }
    }

updateDeployment()

void org.keycloak.adapters.AdapterDeploymentContext.updateDeployment ( AdapterConfig  config )

inline

                                                       {
        if (null != configResolver) {
            throw new IllegalStateException("Cannot parse an adapter config and build an updated deployment when on a multi-tenant scenario.");
        }
        deployment = KeycloakDeploymentBuilder.build(config);
    }

メンバ詳解

configResolver

KeycloakConfigResolver org.keycloak.adapters.AdapterDeploymentContext.configResolver

protected

deployment

KeycloakDeployment org.keycloak.adapters.AdapterDeploymentContext.deployment

protected

log

final Logger org.keycloak.adapters.AdapterDeploymentContext.log = Logger.getLogger(AdapterDeploymentContext.class)

staticprivate

---

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

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