org.keycloak.partialimport.ClientsPartialImport クラス

org.keycloak.partialimport.ClientsPartialImport の継承関係図

org.keycloak.partialimport.ClientsPartialImport 連携図

公開メンバ関数
List< ClientRepresentation >	getRepList (PartialImportRepresentation partialImportRep)
String	getName (ClientRepresentation clientRep)
String	getModelId (RealmModel realm, KeycloakSession session, ClientRepresentation clientRep)
boolean	exists (RealmModel realm, KeycloakSession session, ClientRepresentation clientRep)
String	existsMessage (RealmModel realm, ClientRepresentation clientRep)
ResourceType	getResourceType ()
void	remove (RealmModel realm, KeycloakSession session, ClientRepresentation clientRep)
void	create (RealmModel realm, KeycloakSession session, ClientRepresentation clientRep)
abstract String	getName (T resourceRep)
abstract String	getModelId (RealmModel realm, KeycloakSession session, T resourceRep)
abstract boolean	exists (RealmModel realm, KeycloakSession session, T resourceRep)
abstract String	existsMessage (RealmModel realm, T resourceRep)
abstract void	remove (RealmModel realm, KeycloakSession session, T resourceRep)
abstract void	create (RealmModel realm, KeycloakSession session, T resourceRep)
void	prepare (PartialImportRepresentation partialImportRep, RealmModel realm, KeycloakSession session) throws ErrorResponseException
void	removeOverwrites (RealmModel realm, KeycloakSession session)
PartialImportResults	doImport (PartialImportRepresentation partialImportRep, RealmModel realm, KeycloakSession session) throws ErrorResponseException

静的公開メンバ関数
static boolean	isInternalClient (String clientId)

限定公開メンバ関数
ErrorResponseException	existsError (String message)
PartialImportResult	overwritten (String modelId, T resourceRep)
PartialImportResult	skipped (String modelId, T resourceRep)
PartialImportResult	added (String modelId, T resourceRep)

限定公開変数類
final Set< T >	toOverwrite
final Set< T >	toSkip

静的非公開変数類
static Set< String >	INTERNAL_CLIENTS = Collections.unmodifiableSet(new HashSet(Constants.defaultClients))
static Logger	logger = Logger.getLogger(ClientsPartialImport.class)

詳解

PartialImport handler for Clients.

著者

Stan Silvert ssilv.nosp@m.ert@.nosp@m.redha.nosp@m.t.co.nosp@m.m (C) 2016 Red Hat Inc.

関数詳解

added()

PartialImportResult org.keycloak.partialimport.AbstractPartialImport< T >.added ( String  modelId, T  resourceRep  )

inlineprotectedinherited

                                                                       {
        return PartialImportResult.added(getResourceType(), getName(resourceRep), modelId, resourceRep);
    }

create() [1/2]

abstract void org.keycloak.partialimport.AbstractPartialImport< T >.create ( RealmModel  realm, KeycloakSession  session, T  resourceRep  )

abstractinherited

create() [2/2]

void org.keycloak.partialimport.ClientsPartialImport.create ( RealmModel  realm, KeycloakSession  session, ClientRepresentation  clientRep  )

inline

                                                                                                  {
        clientRep.setId(KeycloakModelUtils.generateId());

        List<ProtocolMapperRepresentation> mappers = clientRep.getProtocolMappers();
        if (mappers != null) {
            for (ProtocolMapperRepresentation mapper : mappers) {
                mapper.setId(KeycloakModelUtils.generateId());
            }
        }

        RepresentationToModel.createClient(session, realm, clientRep, true);
    }

doImport()

PartialImportResults org.keycloak.partialimport.AbstractPartialImport< T >.doImport ( PartialImportRepresentation  partialImportRep, RealmModel  realm, KeycloakSession  session  ) throws ErrorResponseException

inlineinherited

                                                                                                                                                                {
        PartialImportResults results = new PartialImportResults();
        List<T> repList = getRepList(partialImportRep);
        if ((repList == null) || repList.isEmpty()) return results;

        for (T resourceRep : toOverwrite) {
            try {
                create(realm, session, resourceRep);
            } catch (Exception e) {
                ServicesLogger.LOGGER.overwriteError(e, getName(resourceRep));
                throw new ErrorResponseException(ErrorResponse.error(e.getMessage(), Response.Status.INTERNAL_SERVER_ERROR));
            }

            String modelId = getModelId(realm, session, resourceRep);
            results.addResult(overwritten(modelId, resourceRep));
        }

        for (T resourceRep : toSkip) {
            String modelId = getModelId(realm, session, resourceRep);
            results.addResult(skipped(modelId, resourceRep));
        }

        for (T resourceRep : repList) {
            if (toOverwrite.contains(resourceRep)) continue;
            if (toSkip.contains(resourceRep)) continue;

            try {
                create(realm, session, resourceRep);
                String modelId = getModelId(realm, session, resourceRep);
                results.addResult(added(modelId, resourceRep));
            } catch (Exception e) {
                ServicesLogger.LOGGER.creationError(e, getName(resourceRep));
                throw new ErrorResponseException(ErrorResponse.error(e.getMessage(), Response.Status.INTERNAL_SERVER_ERROR));
            }
        }

        return results;
    }

exists() [1/2]

abstract boolean org.keycloak.partialimport.AbstractPartialImport< T >.exists ( RealmModel  realm, KeycloakSession  session, T  resourceRep  )

abstractinherited

exists() [2/2]

boolean org.keycloak.partialimport.ClientsPartialImport.exists ( RealmModel  realm, KeycloakSession  session, ClientRepresentation  clientRep  )

inline

                                                                                                     {
        return realm.getClientByClientId(getName(clientRep)) != null;
    }

existsError()

ErrorResponseException org.keycloak.partialimport.AbstractPartialImport< T >.existsError ( String  message )

inlineprotectedinherited

                                                                 {
        Response error = ErrorResponse.exists(message);
        return new ErrorResponseException(error);
    }

existsMessage() [1/2]

abstract String org.keycloak.partialimport.AbstractPartialImport< T >.existsMessage ( RealmModel  realm, T  resourceRep  )

abstractinherited

existsMessage() [2/2]

String org.keycloak.partialimport.ClientsPartialImport.existsMessage ( RealmModel  realm, ClientRepresentation  clientRep  )

inline

                                                                                  {
        return "Client id '" + getName(clientRep) + "' already exists";
    }

getModelId() [1/2]

abstract String org.keycloak.partialimport.AbstractPartialImport< T >.getModelId ( RealmModel  realm, KeycloakSession  session, T  resourceRep  )

abstractinherited

getModelId() [2/2]

String org.keycloak.partialimport.ClientsPartialImport.getModelId ( RealmModel  realm, KeycloakSession  session, ClientRepresentation  clientRep  )

inline

                                                                                                        {
        return realm.getClientByClientId(getName(clientRep)).getId();
    }

getName() [1/2]

abstract String org.keycloak.partialimport.AbstractPartialImport< T >.getName ( T  resourceRep )

abstractinherited

getName() [2/2]

String org.keycloak.partialimport.ClientsPartialImport.getName ( ClientRepresentation  clientRep )

inline

                                                          {
        return clientRep.getClientId();
    }

getRepList()

List<ClientRepresentation> org.keycloak.partialimport.ClientsPartialImport.getRepList ( PartialImportRepresentation  partialImportRep )

inline

                                                                                               {
        List<ClientRepresentation> clients = partialImportRep.getClients();
        if (clients == null || clients.size() == 0) {
            return clients;
        }

        // filter out internal clients
        List<ClientRepresentation> ret = new ArrayList();

        for (ClientRepresentation c: clients) {
            if (!isInternalClient(c.getClientId())) {
                ret.add(c);
            } else {
                logger.debugv("Internal client {0} will not be processed", c.getClientId());
            }
        }
        return ret;
    }

getResourceType()

ResourceType org.keycloak.partialimport.ClientsPartialImport.getResourceType ( )

inline

                                          {
        return ResourceType.CLIENT;
    }

isInternalClient()

static boolean org.keycloak.partialimport.ClientsPartialImport.isInternalClient ( String  clientId )

inlinestatic

                                                            {
        if (clientId != null && clientId.endsWith("-realm")) {
            return true;
        }
        return INTERNAL_CLIENTS.contains(clientId);
    }

overwritten()

PartialImportResult org.keycloak.partialimport.AbstractPartialImport< T >.overwritten ( String  modelId, T  resourceRep  )

inlineprotectedinherited

                                                                            {
        return PartialImportResult.overwritten(getResourceType(), getName(resourceRep), modelId, resourceRep);
    }

prepare()

void org.keycloak.partialimport.AbstractPartialImport< T >.prepare ( PartialImportRepresentation  partialImportRep, RealmModel  realm, KeycloakSession  session  ) throws ErrorResponseException

inlineinherited

                                                                                {
        List<T> repList = getRepList(partialImportRep);
        if ((repList == null) || repList.isEmpty()) return;

        for (T resourceRep : getRepList(partialImportRep)) {
            if (exists(realm, session, resourceRep)) {
                switch (partialImportRep.getPolicy()) {
                    case SKIP: toSkip.add(resourceRep); break;
                    case OVERWRITE: toOverwrite.add(resourceRep); break;
                    default: throw existsError(existsMessage(realm, resourceRep));
                }
            }
        }
    }

remove() [1/2]

abstract void org.keycloak.partialimport.AbstractPartialImport< T >.remove ( RealmModel  realm, KeycloakSession  session, T  resourceRep  )

abstractinherited

remove() [2/2]

void org.keycloak.partialimport.ClientsPartialImport.remove ( RealmModel  realm, KeycloakSession  session, ClientRepresentation  clientRep  )

inline

                                                                                                  {
        ClientModel clientModel = realm.getClientByClientId(getName(clientRep));
        realm.removeClient(clientModel.getId());
    }

removeOverwrites()

void org.keycloak.partialimport.AbstractPartialImport< T >.removeOverwrites ( RealmModel  realm, KeycloakSession  session  )

inlineinherited

                                                                            {
        for (T resourceRep : toOverwrite) {
            remove(realm, session, resourceRep);
        }
    }

skipped()

PartialImportResult org.keycloak.partialimport.AbstractPartialImport< T >.skipped ( String  modelId, T  resourceRep  )

inlineprotectedinherited

                                                                         {
        return PartialImportResult.skipped(getResourceType(), getName(resourceRep), modelId, resourceRep);
    }

メンバ詳解

INTERNAL_CLIENTS

Set<String> org.keycloak.partialimport.ClientsPartialImport.INTERNAL_CLIENTS = Collections.unmodifiableSet(new HashSet(Constants.defaultClients))

staticprivate

logger

Logger org.keycloak.partialimport.ClientsPartialImport.logger = Logger.getLogger(ClientsPartialImport.class)

staticprivate

toOverwrite

final Set<T> org.keycloak.partialimport.AbstractPartialImport< T >.toOverwrite

protectedinherited

toSkip

final Set<T> org.keycloak.partialimport.AbstractPartialImport< T >.toSkip

protectedinherited

---

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

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