org.keycloak.services.resources.RealmsResource クラス

org.keycloak.services.resources.RealmsResource 連携図

公開メンバ関数
Object	getProtocol (final @PathParam("realm") String name, final @PathParam("protocol") String protocol)
Response	getRedirect (final @PathParam("realm") String realmName, final @PathParam("client_id") String clientId)
LoginActionsService	getLoginActionsService (final @PathParam("realm") String name)
ClientRegistrationService	getClientsService (final @PathParam("realm") String name)
ClientsManagementService	getClientsManagementService (final @PathParam("realm") String name)
Object	getAccountService (final @PathParam("realm") String name)
PublicRealmResource	getRealmResource (final @PathParam("realm") String name)
IdentityBrokerService	getBrokerService (final @PathParam("realm") String name)
Response	getVersionPreflight (final @PathParam("realm") String name, final @PathParam("provider") String providerName)
Response	getWellKnown (final @PathParam("realm") String name, final @PathParam("provider") String providerName)
Object	getAuthorizationService (@PathParam("realm") String name)
Object	resolveRealmExtension (@PathParam("realm") String realmName, @PathParam("extension") String extension)

静的公開メンバ関数
static UriBuilder	realmBaseUrl (UriInfo uriInfo)
static UriBuilder	realmBaseUrl (UriBuilder baseUriBuilder)
static UriBuilder	accountUrl (UriBuilder base)
static UriBuilder	protocolUrl (UriInfo uriInfo)
static UriBuilder	protocolUrl (UriBuilder builder)
static UriBuilder	clientRegistrationUrl (UriInfo uriInfo)
static UriBuilder	brokerUrl (UriInfo uriInfo)
static UriBuilder	wellKnownProviderUrl (UriBuilder builder)

限定公開変数類
KeycloakSession	session
ClientConnection	clientConnection

静的限定公開変数類
static final Logger	logger = Logger.getLogger(RealmsResource.class)

非公開メンバ関数
RealmModel	init (String realmName)

非公開変数類
HttpRequest	request

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

accountUrl()

static UriBuilder org.keycloak.services.resources.RealmsResource.accountUrl ( UriBuilder  base )

inlinestatic

                                                         {
        return base.path(RealmsResource.class).path(RealmsResource.class, "getAccountService");
    }

brokerUrl()

static UriBuilder org.keycloak.services.resources.RealmsResource.brokerUrl ( UriInfo  uriInfo )

inlinestatic

                                                        {
        return uriInfo.getBaseUriBuilder().path(RealmsResource.class).path(RealmsResource.class, "getBrokerService");
    }

clientRegistrationUrl()

static UriBuilder org.keycloak.services.resources.RealmsResource.clientRegistrationUrl ( UriInfo  uriInfo )

inlinestatic

                                                                    {
        return uriInfo.getBaseUriBuilder().path(RealmsResource.class).path(RealmsResource.class, "getClientsService");
    }

getAccountService()

Object org.keycloak.services.resources.RealmsResource.getAccountService ( final @PathParam("realm") String  name )

inline

                                                                           {
        RealmModel realm = init(name);
        EventBuilder event = new EventBuilder(realm, session, clientConnection);
        return new AccountLoader().getAccountService(session, event);
    }

getAuthorizationService()

Object org.keycloak.services.resources.RealmsResource.getAuthorizationService ( @PathParam("realm") String  name )

inline

                                                                           {
        ProfileHelper.requireFeature(Profile.Feature.AUTHORIZATION);

        init(name);
        AuthorizationProvider authorization = this.session.getProvider(AuthorizationProvider.class);
        AuthorizationService service = new AuthorizationService(authorization);

        ResteasyProviderFactory.getInstance().injectProperties(service);

        return service;
    }

getBrokerService()

IdentityBrokerService org.keycloak.services.resources.RealmsResource.getBrokerService ( final @PathParam("realm") String  name )

inline

                                                                                         {
        RealmModel realm = init(name);

        IdentityBrokerService brokerService = new IdentityBrokerService(realm);
        ResteasyProviderFactory.getInstance().injectProperties(brokerService);

        brokerService.init();

        return brokerService;
    }

getClientsManagementService()

ClientsManagementService org.keycloak.services.resources.RealmsResource.getClientsManagementService ( final @PathParam("realm") String  name )

inline

                                                                                                       {
        RealmModel realm = init(name);
        EventBuilder event = new EventBuilder(realm, session, clientConnection);
        ClientsManagementService service = new ClientsManagementService(realm, event);
        ResteasyProviderFactory.getInstance().injectProperties(service);
        return service;
    }

getClientsService()

ClientRegistrationService org.keycloak.services.resources.RealmsResource.getClientsService ( final @PathParam("realm") String  name )

inline

                                                                                              {
        RealmModel realm = init(name);
        EventBuilder event = new EventBuilder(realm, session, clientConnection);
        ClientRegistrationService service = new ClientRegistrationService(event);
        ResteasyProviderFactory.getInstance().injectProperties(service);
        return service;
    }

getLoginActionsService()

LoginActionsService org.keycloak.services.resources.RealmsResource.getLoginActionsService ( final @PathParam("realm") String  name )

inline

                                                                                             {
        RealmModel realm = init(name);
        EventBuilder event = new EventBuilder(realm, session, clientConnection);
        LoginActionsService service = new LoginActionsService(realm, event);
        ResteasyProviderFactory.getInstance().injectProperties(service);
        return service;
    }

getProtocol()

Object org.keycloak.services.resources.RealmsResource.getProtocol ( final @PathParam("realm") String  name, final @PathParam("protocol") String  protocol  )

inline

                                                                            {
        RealmModel realm = init(name);

        LoginProtocolFactory factory = (LoginProtocolFactory)session.getKeycloakSessionFactory().getProviderFactory(LoginProtocol.class, protocol);
        if(factory == null){
            logger.debugf("protocol %s not found", protocol);
            throw new NotFoundException("Protocol not found");
        }

        EventBuilder event = new EventBuilder(realm, session, clientConnection);

        Object endpoint = factory.createProtocolEndpoint(realm, event);

        ResteasyProviderFactory.getInstance().injectProperties(endpoint);
        return endpoint;
    }

getRealmResource()

PublicRealmResource org.keycloak.services.resources.RealmsResource.getRealmResource ( final @PathParam("realm") String  name )

inline

                                                                                       {
        RealmModel realm = init(name);
        PublicRealmResource realmResource = new PublicRealmResource(realm);
        ResteasyProviderFactory.getInstance().injectProperties(realmResource);
        return realmResource;
    }

getRedirect()

Response org.keycloak.services.resources.RealmsResource.getRedirect ( final @PathParam("realm") String  realmName, final @PathParam("client_id") String  clientId  )

inline

Returns a temporary redirect to the client url configured for the given

clientId 

in the given

realmName 

.

This allows a client to refer to other clients just by their client id in URLs, will then redirect users to the actual client url. The client url is derived according to the rules of the base url in the client configuration.

引数

realmName
clientId

戻り値

から

2.0

                                                                                                                           {

        RealmModel realm = init(realmName);

        if (realm == null) {
            return null;
        }

        ClientModel client = realm.getClientByClientId(clientId);

        if (client == null) {
            return null;
        }

        if (client.getRootUrl() == null && client.getBaseUrl() == null) {
            return null;
        }


        URI targetUri;
        if (client.getRootUrl() != null && (client.getBaseUrl() == null || client.getBaseUrl().isEmpty())) {
            targetUri = KeycloakUriBuilder.fromUri(client.getRootUrl()).build();
        } else {
            targetUri = KeycloakUriBuilder.fromUri(ResolveRelative.resolveRelativeUri(session.getContext().getUri().getRequestUri(), client.getRootUrl(), client.getBaseUrl())).build();
        }

        return Response.seeOther(targetUri).build();
    }

getVersionPreflight()

Response org.keycloak.services.resources.RealmsResource.getVersionPreflight ( final @PathParam("realm") String  name, final @PathParam("provider") String  providerName  )

inline

                                                                                          {
        return Cors.add(request, Response.ok()).allowedMethods("GET").preflight().auth().build();
    }

getWellKnown()

Response org.keycloak.services.resources.RealmsResource.getWellKnown ( final @PathParam("realm") String  name, final @PathParam("provider") String  providerName  )

inline

                                                                                   {
        init(name);

        WellKnownProvider wellKnown = session.getProvider(WellKnownProvider.class, providerName);

        if (wellKnown != null) {
            ResponseBuilder responseBuilder = Response.ok(wellKnown.getConfig()).cacheControl(CacheControlUtil.noCache());
            return Cors.add(request, responseBuilder).allowedOrigins("*").auth().build();
        }

        throw new NotFoundException();
    }

init()

RealmModel org.keycloak.services.resources.RealmsResource.init ( String  realmName )

inlineprivate

                                              {
        RealmManager realmManager = new RealmManager(session);
        RealmModel realm = realmManager.getRealmByName(realmName);
        if (realm == null) {
            throw new NotFoundException("Realm does not exist");
        }
        session.getContext().setRealm(realm);
        return realm;
    }

protocolUrl() [1/2]

static UriBuilder org.keycloak.services.resources.RealmsResource.protocolUrl ( UriInfo  uriInfo )

inlinestatic

                                                          {
        return uriInfo.getBaseUriBuilder().path(RealmsResource.class).path(RealmsResource.class, "getProtocol");
    }

protocolUrl() [2/2]

static UriBuilder org.keycloak.services.resources.RealmsResource.protocolUrl ( UriBuilder  builder )

inlinestatic

                                                             {
        return builder.path(RealmsResource.class).path(RealmsResource.class, "getProtocol");
    }

realmBaseUrl() [1/2]

static UriBuilder org.keycloak.services.resources.RealmsResource.realmBaseUrl ( UriInfo  uriInfo )

inlinestatic

                                                           {
        UriBuilder baseUriBuilder = uriInfo.getBaseUriBuilder();
        return realmBaseUrl(baseUriBuilder);
    }

realmBaseUrl() [2/2]

static UriBuilder org.keycloak.services.resources.RealmsResource.realmBaseUrl ( UriBuilder  baseUriBuilder )

inlinestatic

                                                                     {
        return baseUriBuilder.path(RealmsResource.class).path(RealmsResource.class, "getRealmResource");
    }

resolveRealmExtension()

Object org.keycloak.services.resources.RealmsResource.resolveRealmExtension ( @PathParam("realm") String  realmName, @PathParam("extension") String  extension  )

inline

A JAX-RS sub-resource locator that uses the org.keycloak.services.resource.RealmResourceSPI to resolve sub-resources instances given an unknownPath.

引数

extension

a path that could be to a REST extension

戻り値

a JAX-RS sub-resource instance for the REST extension if found. Otherwise null is returned.

                                                                                                                        {
        RealmResourceProvider provider = session.getProvider(RealmResourceProvider.class, extension);
        if (provider != null) {
            init(realmName);
            Object resource = provider.getResource();
            if (resource != null) {
                return resource;
            }
        }

        throw new NotFoundException();
    }

wellKnownProviderUrl()

static UriBuilder org.keycloak.services.resources.RealmsResource.wellKnownProviderUrl ( UriBuilder  builder )

inlinestatic

                                                                      {
        return builder.path(RealmsResource.class).path(RealmsResource.class, "getWellKnown");
    }

メンバ詳解

clientConnection

ClientConnection org.keycloak.services.resources.RealmsResource.clientConnection

protected

logger

final Logger org.keycloak.services.resources.RealmsResource.logger = Logger.getLogger(RealmsResource.class)

staticprotected

request

HttpRequest org.keycloak.services.resources.RealmsResource.request

private

session

KeycloakSession org.keycloak.services.resources.RealmsResource.session

protected

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/services/resources/RealmsResource.java