Package org.apache.syncope.common.rest.api.service

Interface ClientAppService

All Superinterfaces:

JAXRSService

@Path("clientApps")
public interface ClientAppService
extends JAXRSService

REST operations for client applications.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	create(@NotNull ClientAppType type, @NotNull ClientAppTO clientAppTO)	Create a new client app.
void	delete(@NotNull ClientAppType type, @NotNull String key)	Delete client app matching the given key.
<T extends ClientAppTO> List<T>	list(@NotNull ClientAppType type)	Returns a list of client apps of the matching type.
<T extends ClientAppTO> T	read(@NotNull ClientAppType type, @NotNull String key)	Returns the client app matching the given key.
void	update(@NotNull ClientAppType type, @NotNull ClientAppTO clientAppTO)	Updates client app matching the given key.

Method Details

read

@GET
@Path("{type}/{key}")
@Produces({"application/json","application/yaml","application/xml"})
<T extends ClientAppTO> T read(@NotNull @PathParam("type")
 @NotNull ClientAppType type,
 @NotNull @PathParam("key")
 @NotNull String key)

Returns the client app matching the given key.

Type Parameters:

T - response type (extending ClientAppTO)

Parameters:

type - client app type

key - key of requested client app

Returns:

client app with matching id

list

@GET
@Path("{type}")
@Produces({"application/json","application/yaml","application/xml"})
<T extends ClientAppTO> List<T> list(@NotNull @PathParam("type")
 @NotNull ClientAppType type)

Returns a list of client apps of the matching type.

Type Parameters:

T - response type (extending ClientAppTO)

Parameters:

type - Type selector for requested client apps

Returns:

list of client apps with matching type

create

@POST
@Path("{type}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
jakarta.ws.rs.core.Response create(@NotNull @PathParam("type")
 @NotNull ClientAppType type,
 @NotNull
 @NotNull ClientAppTO clientAppTO)

Create a new client app.

Parameters:

type - client app type

clientAppTO - ClientApp to be created (needs to match type)

Returns:

Response object featuring Location header of created client app

update

@PUT
@Path("{type}/{key}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
void update(@NotNull @PathParam("type")
 @NotNull ClientAppType type,
 @NotNull
 @NotNull ClientAppTO clientAppTO)

Updates client app matching the given key.

Parameters:

type - client app type

clientAppTO - ClientApp to replace existing client app

delete

@DELETE
@Path("{type}/{key}")
@Produces({"application/json","application/yaml","application/xml"})
void delete(@NotNull @PathParam("type")
 @NotNull ClientAppType type,
 @NotNull @PathParam("key")
 @NotNull String key)

Delete client app matching the given key.

Parameters:

type - client app type

key - key of client app to be deleted