org.keycloak.services.resources.admin.ComponentResource クラス

org.keycloak.services.resources.admin.ComponentResource 連携図

公開メンバ関数
	ComponentResource (RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
List< ComponentRepresentation >	getComponents (@QueryParam("parent") String parent, @QueryParam("type") String type, @QueryParam("name") String name)
Response	create (ComponentRepresentation rep)
ComponentRepresentation	getComponent (@PathParam("id") String id)
Response	updateComponent (@PathParam("id") String id, ComponentRepresentation rep)
void	removeComponent (@PathParam("id") String id)
List< ComponentTypeRepresentation >	getSubcomponentConfig (@PathParam("id") String parentId, @QueryParam("type") String subtype)

限定公開変数類
RealmModel	realm
ClientConnection	clientConnection
KeycloakSession	session
HttpHeaders	headers

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

非公開メンバ関数
Response	localizedErrorResponse (ComponentValidationException cve)

非公開変数類
AdminPermissionEvaluator	auth
AdminEventBuilder	adminEvent

詳解

Component

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

ComponentResource()

org.keycloak.services.resources.admin.ComponentResource.ComponentResource ( RealmModel  realm, AdminPermissionEvaluator  auth, AdminEventBuilder  adminEvent  )

inline

                                                                                                            {
        this.auth = auth;
        this.realm = realm;
        this.adminEvent = adminEvent.resource(ResourceType.COMPONENT);
    }

関数詳解

create()

Response org.keycloak.services.resources.admin.ComponentResource.create ( ComponentRepresentation  rep )

inline

                                                        {
        auth.realm().requireManageRealm();
        try {
            ComponentModel model = RepresentationToModel.toModel(session, rep);
            if (model.getParentId() == null) model.setParentId(realm.getId());

            model = realm.addComponentModel(model);

            adminEvent.operation(OperationType.CREATE).resourcePath(session.getContext().getUri(), model.getId()).representation(StripSecretsUtils.strip(session, rep)).success();
            return Response.created(session.getContext().getUri().getAbsolutePathBuilder().path(model.getId()).build()).build();
        } catch (ComponentValidationException e) {
            return localizedErrorResponse(e);
        } catch (IllegalArgumentException e) {
            throw new BadRequestException(e);
        }
    }

getComponent()

ComponentRepresentation org.keycloak.services.resources.admin.ComponentResource.getComponent ( @PathParam("id") String  id )

inline

                                                                            {
        auth.realm().requireViewRealm();
        ComponentModel model = realm.getComponent(id);
        if (model == null) {
            throw new NotFoundException("Could not find component");
        }
        ComponentRepresentation rep = ModelToRepresentation.toRepresentation(session, model, false);
        return rep;
    }

getComponents()

List<ComponentRepresentation> org.keycloak.services.resources.admin.ComponentResource.getComponents ( @QueryParam("parent") String  parent, @QueryParam("type") String  type, @QueryParam("name") String  name  )

inline

                                                                                        {
        auth.realm().requireViewRealm();
        List<ComponentModel> components = Collections.EMPTY_LIST;
        if (parent == null && type == null) {
            components = realm.getComponents();

        } else if (type == null) {
            components = realm.getComponents(parent);
        } else if (parent == null) {
            components = realm.getComponents(realm.getId(), type);
        } else {
            components = realm.getComponents(parent, type);
        }
        List<ComponentRepresentation> reps = new LinkedList<>();
        for (ComponentModel component : components) {
            if (name != null && !name.equals(component.getName())) continue;
            ComponentRepresentation rep = null;
            try {
                rep = ModelToRepresentation.toRepresentation(session, component, false);
            } catch (Exception e) {
                logger.error("Failed to get component list for component model" + component.getName() + "of realm " + realm.getName());
                rep = ModelToRepresentation.toRepresentationWithoutConfig(component);
            }
            reps.add(rep);
        }
        return reps;
    }

getSubcomponentConfig()

List<ComponentTypeRepresentation> org.keycloak.services.resources.admin.ComponentResource.getSubcomponentConfig ( @PathParam("id") String  parentId, @QueryParam("type") String  subtype  )

inline

List of subcomponent types that are available to configure for a particular parent component.

引数

parentId
subtype

戻り値

                                                                                                                                         {
        auth.realm().requireViewRealm();
        ComponentModel parent = realm.getComponent(parentId);
        if (parent == null) {
            throw new NotFoundException("Could not find parent component");
        }
        if (subtype == null) {
            throw new BadRequestException("must specify a subtype");
        }
        Class<? extends Provider> providerClass = null;
        try {
            providerClass = (Class<? extends Provider>)Class.forName(subtype);
        } catch (ClassNotFoundException e) {
            throw new RuntimeException(e);
        }
        List<ComponentTypeRepresentation> subcomponents = new LinkedList<>();
        for (ProviderFactory factory : session.getKeycloakSessionFactory().getProviderFactories(providerClass)) {
            ComponentTypeRepresentation rep = new ComponentTypeRepresentation();
            rep.setId(factory.getId());
            if (!(factory instanceof ComponentFactory)) {
                continue;
            }
            ComponentFactory componentFactory = (ComponentFactory)factory;

            rep.setHelpText(componentFactory.getHelpText());
            List<ProviderConfigProperty> props = null;
            Map<String, Object> metadata = null;
            if (factory instanceof SubComponentFactory) {
                props = ((SubComponentFactory)factory).getConfigProperties(realm, parent);
                metadata = ((SubComponentFactory)factory).getTypeMetadata(realm, parent);

            } else {
                props = componentFactory.getConfigProperties();
                metadata = componentFactory.getTypeMetadata();
            }

            List<ConfigPropertyRepresentation> propReps =  ModelToRepresentation.toRepresentation(props);
            rep.setProperties(propReps);
            rep.setMetadata(metadata);
            subcomponents.add(rep);
        }
        return subcomponents;
    }

localizedErrorResponse()

Response org.keycloak.services.resources.admin.ComponentResource.localizedErrorResponse ( ComponentValidationException  cve )

inlineprivate

                                                                              {
        Properties messages = AdminRoot.getMessages(session, realm, auth.adminAuth().getToken().getLocale(), "admin-messages", "messages");

        Object[] localizedParameters = cve.getParameters()==null ? null : Arrays.asList(cve.getParameters()).stream().map((Object parameter) -> {

            if (parameter instanceof String) {
                String paramStr = (String) parameter;
                return messages.getProperty(paramStr, paramStr);
            } else {
                return parameter;
            }

        }).toArray();

        String message = MessageFormat.format(messages.getProperty(cve.getMessage(), cve.getMessage()), localizedParameters);
        return ErrorResponse.error(message, Response.Status.BAD_REQUEST);
    }

removeComponent()

void org.keycloak.services.resources.admin.ComponentResource.removeComponent ( @PathParam("id") String  id )

inline

                                                            {
        auth.realm().requireManageRealm();
        ComponentModel model = realm.getComponent(id);
        if (model == null) {
            throw new NotFoundException("Could not find component");
        }
        adminEvent.operation(OperationType.DELETE).resourcePath(session.getContext().getUri()).success();
        realm.removeComponent(model);

    }

updateComponent()

Response org.keycloak.services.resources.admin.ComponentResource.updateComponent ( @PathParam("id") String  id, ComponentRepresentation  rep  )

inline

                                                                                             {
        auth.realm().requireManageRealm();
        try {
            ComponentModel model = realm.getComponent(id);
            if (model == null) {
                throw new NotFoundException("Could not find component");
            }
            RepresentationToModel.updateComponent(session, rep, model, false);
            adminEvent.operation(OperationType.UPDATE).resourcePath(session.getContext().getUri()).representation(StripSecretsUtils.strip(session, rep)).success();
            realm.updateComponent(model);
            return Response.noContent().build();
        } catch (ComponentValidationException e) {
            return localizedErrorResponse(e);
        } catch (IllegalArgumentException e) {
            throw new BadRequestException();
        }
    }

メンバ詳解

adminEvent

AdminEventBuilder org.keycloak.services.resources.admin.ComponentResource.adminEvent

private

auth

AdminPermissionEvaluator org.keycloak.services.resources.admin.ComponentResource.auth

private

clientConnection

ClientConnection org.keycloak.services.resources.admin.ComponentResource.clientConnection

protected

headers

HttpHeaders org.keycloak.services.resources.admin.ComponentResource.headers

protected

logger

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

staticprotected

realm

RealmModel org.keycloak.services.resources.admin.ComponentResource.realm

protected

session

KeycloakSession org.keycloak.services.resources.admin.ComponentResource.session

protected

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/services/resources/admin/ComponentResource.java