Package org.keycloak.services.resources.admin

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 final ClientConnection	clientConnection
protected final jakarta.ws.rs.core.HttpHeaders	headers
protected static final org.jboss.logging.Logger	logger
protected final RealmModel	realm
static final String	SECRET_PLACEHOLDER_FIELDS_ATTR	Session attribute key used to record which config fields in an update request contained the ComponentRepresentation.SECRET_VALUE placeholder or were omitted instead of being explicitly re-entered.
protected final KeycloakSession	session

Constructor Summary

Constructors

Constructor	Description
ComponentResource(KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	create(ComponentRepresentation rep)
ComponentRepresentation	getComponent(String id)
Stream<ComponentRepresentation>	getComponents(String parent, String type, String name, String providerId)
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)
jakarta.ws.rs.core.Response	updateComponent(String id, ComponentRepresentation rep)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

protected static final org.jboss.logging.Logger logger

SECRET_PLACEHOLDER_FIELDS_ATTR

public static final String SECRET_PLACEHOLDER_FIELDS_ATTR

Session attribute key used to record which config fields in an update request contained the ComponentRepresentation.SECRET_VALUE placeholder or were omitted instead of being explicitly re-entered. This allows downstream validation (e.g. in provider factories) to distinguish auto-preserved secrets from explicitly re-entered ones.

See Also:

• Constant Field Values

realm

protected final RealmModel realm

clientConnection

protected final ClientConnection clientConnection

session

protected final KeycloakSession session

headers

protected final jakarta.ws.rs.core.HttpHeaders headers

Constructor Details

ComponentResource

public ComponentResource(KeycloakSession session,
 AdminPermissionEvaluator auth,
 AdminEventBuilder adminEvent)

Method Details

getComponents

@GET
@Produces("application/json")
public Stream<ComponentRepresentation> getComponents(@QueryParam("parent")
 String parent,
 @QueryParam("type")
 String type,
 @QueryParam("name")
 String name,
 @QueryParam("providerId")
 String providerId)

create

@POST
@Consumes("application/json")
public jakarta.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 jakarta.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: