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

Interface AnyTypeClassService

All Superinterfaces:

JAXRSService

@Path("anyTypeClasses")
public interface AnyTypeClassService
extends JAXRSService

REST operations for any type classes.

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 AnyTypeClassTO anyTypeClassTO)	Creates a new anyTypeClass.
void	delete(@NotNull String key)	Deletes the anyTypeClass matching the provided key.
List<AnyTypeClassTO>	list()	Returns a list of all anyTypeClasss.
AnyTypeClassTO	read(@NotNull String key)	Returns anyTypeClass with matching key.
void	update(@NotNull AnyTypeClassTO anyTypeClassTO)	Updates the anyTypeClass matching the provided key.

Method Details

list

@GET
@Produces({"application/json","application/yaml","application/xml"})
List<AnyTypeClassTO> list()

Returns a list of all anyTypeClasss.

Returns:

list of all anyTypeClasss.

read

@GET
@Path("{key}")
@Produces({"application/json","application/yaml","application/xml"})
AnyTypeClassTO read(@NotNull @PathParam("key")
 @NotNull String key)

Returns anyTypeClass with matching key.

Parameters:

key - anyTypeClass key to be read

Returns:

anyTypeClass with matching key

create

@POST
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
jakarta.ws.rs.core.Response create(@NotNull
 @NotNull AnyTypeClassTO anyTypeClassTO)

Creates a new anyTypeClass.

Parameters:

anyTypeClassTO - anyTypeClass to be created

Returns:

Response object featuring Location header of created anyTypeClass

update

@PUT
@Path("{key}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
void update(@NotNull
 @NotNull AnyTypeClassTO anyTypeClassTO)

Updates the anyTypeClass matching the provided key.

Parameters:

anyTypeClassTO - anyTypeClass to be stored

delete

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

Deletes the anyTypeClass matching the provided key.

Parameters:

key - anyTypeClass key to be deleted