Class ComponentResource
- java.lang.Object
-
- org.keycloak.services.resources.admin.ComponentResource
-
public class ComponentResource extends Object
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Field Summary
Fields Modifier and Type Field Description protected ClientConnection
clientConnection
protected javax.ws.rs.core.HttpHeaders
headers
protected static org.jboss.logging.Logger
logger
protected RealmModel
realm
protected KeycloakSession
session
-
Constructor Summary
Constructors Constructor Description ComponentResource(KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description javax.ws.rs.core.Response
create(ComponentRepresentation rep)
ComponentRepresentation
getComponent(String id)
Stream<ComponentRepresentation>
getComponents(String parent, String type, String name)
Stream<ComponentTypeRepresentation>
getSubcomponentConfig(String parentId, String subtype)
List of subcomponent types that are available to configure for a particular parent component.void
removeComponent(String id)
javax.ws.rs.core.Response
updateComponent(String id, ComponentRepresentation rep)
-
-
-
Field Detail
-
logger
protected static final org.jboss.logging.Logger logger
-
realm
protected final RealmModel realm
-
clientConnection
protected final ClientConnection clientConnection
-
session
protected final KeycloakSession session
-
headers
protected final javax.ws.rs.core.HttpHeaders headers
-
-
Constructor Detail
-
ComponentResource
public ComponentResource(KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
-
-
Method Detail
-
getComponents
@GET @Produces("application/json") public Stream<ComponentRepresentation> getComponents(@QueryParam("parent") String parent, @QueryParam("type") String type, @QueryParam("name") String name)
-
create
@POST @Consumes("application/json") public javax.ws.rs.core.Response create(ComponentRepresentation rep)
-
getComponent
@GET @Path("{id}") @Produces("application/json") public ComponentRepresentation getComponent(@PathParam("id") String id)
-
updateComponent
@PUT @Path("{id}") @Consumes("application/json") public javax.ws.rs.core.Response updateComponent(@PathParam("id") String id, ComponentRepresentation rep)
-
removeComponent
@DELETE @Path("{id}") public void removeComponent(@PathParam("id") String id)
-
getSubcomponentConfig
@GET @Path("{id}/sub-component-types") @Produces("application/json") public Stream<ComponentTypeRepresentation> getSubcomponentConfig(@PathParam("id") String parentId, @QueryParam("type") String subtype)
List of subcomponent types that are available to configure for a particular parent component.- Parameters:
parentId
-subtype
-- Returns:
-
-