org.keycloak.services.clientregistration.DefaultClientRegistrationProvider クラス

org.keycloak.services.clientregistration.DefaultClientRegistrationProvider の継承関係図

org.keycloak.services.clientregistration.DefaultClientRegistrationProvider 連携図

公開メンバ関数
	DefaultClientRegistrationProvider (KeycloakSession session)
Response	createDefault (ClientRepresentation client)
Response	getDefault (@PathParam("clientId") String clientId)
Response	updateDefault (@PathParam("clientId") String clientId, ClientRepresentation client)
void	deleteDefault (@PathParam("clientId") String clientId)
ClientRepresentation	create (ClientRegistrationContext context)
ClientRepresentation	get (String clientId)
ClientRepresentation	update (String clientId, ClientRegistrationContext context)
void	delete (String clientId)
void	setAuth (ClientRegistrationAuth auth)
ClientRegistrationAuth	getAuth ()
void	setEvent (EventBuilder event)
EventBuilder	getEvent ()
void	close ()

限定公開変数類
KeycloakSession	session
EventBuilder	event
ClientRegistrationAuth	auth

詳解

著者

Stian Thorgersen

構築子と解体子

DefaultClientRegistrationProvider()

org.keycloak.services.clientregistration.DefaultClientRegistrationProvider.DefaultClientRegistrationProvider ( KeycloakSession  session )

inline

                                                                      {
        super(session);
    }

関数詳解

close()

void org.keycloak.services.clientregistration.AbstractClientRegistrationProvider.close ( )

inlineinherited

org.keycloak.provider.Providerを実装しています。

                        {
    }

create()

ClientRepresentation org.keycloak.services.clientregistration.AbstractClientRegistrationProvider.create ( ClientRegistrationContext  context )

inlineinherited

                                                                          {
        ClientRepresentation client = context.getClient();

        event.event(EventType.CLIENT_REGISTER);

        RegistrationAuth registrationAuth = auth.requireCreate(context);

        ValidationMessages validationMessages = new ValidationMessages();
        if (!context.validateClient(validationMessages)) {
            String errorCode = validationMessages.fieldHasError("redirectUris") ? ErrorCodes.INVALID_REDIRECT_URI : ErrorCodes.INVALID_CLIENT_METADATA;
            throw new ErrorResponseException(
                    errorCode,
                    validationMessages.getStringMessages(),
                    Response.Status.BAD_REQUEST
            );
        }

        try {
            RealmModel realm = session.getContext().getRealm();
            ClientModel clientModel = new ClientManager(new RealmManager(session)).createClient(session, realm, client, true);

            if (clientModel.isServiceAccountsEnabled()) {
                new ClientManager(new RealmManager(session)).enableServiceAccount(clientModel);
            }

            if (Boolean.TRUE.equals(client.getAuthorizationServicesEnabled())) {
                RepresentationToModel.createResourceServer(clientModel, session, true);
            }

            ClientRegistrationPolicyManager.triggerAfterRegister(context, registrationAuth, clientModel);

            client = ModelToRepresentation.toRepresentation(clientModel, session);

            client.setSecret(clientModel.getSecret());

            String registrationAccessToken = ClientRegistrationTokenUtils.updateRegistrationAccessToken(session, clientModel, registrationAuth);
            client.setRegistrationAccessToken(registrationAccessToken);

            if (auth.isInitialAccessToken()) {
                ClientInitialAccessModel initialAccessModel = auth.getInitialAccessModel();
                session.realms().decreaseRemainingCount(realm, initialAccessModel);
            }

            event.client(client.getClientId()).success();
            return client;
        } catch (ModelDuplicateException e) {
            throw new ErrorResponseException(ErrorCodes.INVALID_CLIENT_METADATA, "Client Identifier in use", Response.Status.BAD_REQUEST);
        }
    }

createDefault()

Response org.keycloak.services.clientregistration.DefaultClientRegistrationProvider.createDefault ( ClientRepresentation  client )

inline

                                                               {
        DefaultClientRegistrationContext context = new DefaultClientRegistrationContext(session, client, this);
        client = create(context);
        URI uri = session.getContext().getUri().getAbsolutePathBuilder().path(client.getClientId()).build();
        return Response.created(uri).entity(client).build();
    }

delete()

void org.keycloak.services.clientregistration.AbstractClientRegistrationProvider.delete ( String  clientId )

inlineinherited

                                        {
        event.event(EventType.CLIENT_DELETE).client(clientId);

        ClientModel client = session.getContext().getRealm().getClientByClientId(clientId);
        auth.requireDelete(client);

        if (new ClientManager(new RealmManager(session)).removeClient(session.getContext().getRealm(), client)) {
            event.client(client.getClientId()).success();
        } else {
            throw new ForbiddenException();
        }
    }

deleteDefault()

void org.keycloak.services.clientregistration.DefaultClientRegistrationProvider.deleteDefault ( @PathParam("clientId") String  clientId )

inline

                                                                      {
        delete(clientId);
    }

get()

ClientRepresentation org.keycloak.services.clientregistration.AbstractClientRegistrationProvider.get ( String  clientId )

inlineinherited

                                                     {
        event.event(EventType.CLIENT_INFO);

        ClientModel client = session.getContext().getRealm().getClientByClientId(clientId);
        auth.requireView(client);

        ClientRepresentation rep = ModelToRepresentation.toRepresentation(client, session);
        if (client.getSecret() != null) {
            rep.setSecret(client.getSecret());
        }

        if (auth.isRegistrationAccessToken()) {
            String registrationAccessToken = ClientRegistrationTokenUtils.updateTokenSignature(session, auth);
            rep.setRegistrationAccessToken(registrationAccessToken);
        }

        event.client(client.getClientId()).success();
        return rep;
    }

getAuth()

ClientRegistrationAuth org.keycloak.services.clientregistration.AbstractClientRegistrationProvider.getAuth ( )

inlineinherited

org.keycloak.services.clientregistration.ClientRegistrationProviderを実装しています。

                                            {
        return this.auth;
    }

getDefault()

Response org.keycloak.services.clientregistration.DefaultClientRegistrationProvider.getDefault ( @PathParam("clientId") String  clientId )

inline

                                                                       {
        ClientRepresentation client = get(clientId);
        return Response.ok(client).build();
    }

getEvent()

EventBuilder org.keycloak.services.clientregistration.AbstractClientRegistrationProvider.getEvent ( )

inlineinherited

org.keycloak.services.clientregistration.ClientRegistrationProviderを実装しています。

                                   {
        return event;
    }

setAuth()

void org.keycloak.services.clientregistration.AbstractClientRegistrationProvider.setAuth ( ClientRegistrationAuth  auth )

inlineinherited

org.keycloak.services.clientregistration.ClientRegistrationProviderを実装しています。

                                                     {
        this.auth = auth;
    }

setEvent()

void org.keycloak.services.clientregistration.AbstractClientRegistrationProvider.setEvent ( EventBuilder  event )

inlineinherited

org.keycloak.services.clientregistration.ClientRegistrationProviderを実装しています。

                                             {
        this.event = event;
    }

update()

ClientRepresentation org.keycloak.services.clientregistration.AbstractClientRegistrationProvider.update ( String  clientId, ClientRegistrationContext  context  )

inlineinherited

                                                                                           {
        ClientRepresentation rep = context.getClient();

        event.event(EventType.CLIENT_UPDATE).client(clientId);

        ClientModel client = session.getContext().getRealm().getClientByClientId(clientId);
        RegistrationAuth registrationAuth = auth.requireUpdate(context, client);

        if (!client.getClientId().equals(rep.getClientId())) {
            throw new ErrorResponseException(ErrorCodes.INVALID_CLIENT_METADATA, "Client Identifier modified", Response.Status.BAD_REQUEST);
        }

        ValidationMessages validationMessages = new ValidationMessages();
        if (!context.validateClient(validationMessages)) {
            String errorCode = validationMessages.fieldHasError("redirectUris") ? ErrorCodes.INVALID_REDIRECT_URI : ErrorCodes.INVALID_CLIENT_METADATA;
            throw new ErrorResponseException(
                    errorCode,
                    validationMessages.getStringMessages(),
                    Response.Status.BAD_REQUEST
            );
        }

        RepresentationToModel.updateClient(rep, client);
        rep = ModelToRepresentation.toRepresentation(client, session);

        if (auth.isRegistrationAccessToken()) {
            String registrationAccessToken = ClientRegistrationTokenUtils.updateRegistrationAccessToken(session, client, auth.getRegistrationAuth());
            rep.setRegistrationAccessToken(registrationAccessToken);
        }

        ClientRegistrationPolicyManager.triggerAfterUpdate(context, registrationAuth, client);

        event.client(client.getClientId()).success();
        return rep;
    }

updateDefault()

Response org.keycloak.services.clientregistration.DefaultClientRegistrationProvider.updateDefault ( @PathParam("clientId") String  clientId, ClientRepresentation  client  )

inline

                                                                                                       {
        DefaultClientRegistrationContext context = new DefaultClientRegistrationContext(session, client, this);
        client = update(clientId, context);
        return Response.ok(client).build();
    }

メンバ詳解

auth

ClientRegistrationAuth org.keycloak.services.clientregistration.AbstractClientRegistrationProvider.auth

protectedinherited

event

EventBuilder org.keycloak.services.clientregistration.AbstractClientRegistrationProvider.event

protectedinherited

session

KeycloakSession org.keycloak.services.clientregistration.AbstractClientRegistrationProvider.session

protectedinherited

---

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

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/services/clientregistration/DefaultClientRegistrationProvider.java