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

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

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

公開メンバ関数
	AbstractClientRegistrationProvider (KeycloakSession session)
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

構築子と解体子

AbstractClientRegistrationProvider()

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

inline

                                                                       {
        this.session = session;
    }

関数詳解

close()

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

inline

                        {
    }

create()

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

inline

                                                                          {
        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);
        }
    }

delete()

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

inline

                                        {
        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();
        }
    }

get()

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

inline

                                                     {
        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 ( )

inline

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

                                            {
        return this.auth;
    }

getEvent()

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

inline

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

                                   {
        return event;
    }

setAuth()

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

inline

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

                                                     {
        this.auth = auth;
    }

setEvent()

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

inline

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

                                             {
        this.event = event;
    }

update()

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

inline

                                                                                           {
        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;
    }

メンバ詳解

auth

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

protected

event

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

protected

session

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

protected

---

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

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