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

Interface AttrRepoService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

AttrRepoServiceImpl

@Path("attrRepos")
public interface AttrRepoService
extends JAXRSService

REST operations for attribute repositories.

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
javax.ws.rs.core.Response	create(@NotNull AttrRepoTO attrRepoTO)	Create a new attribute repository.
void	delete(@NotNull String key)	Delete attribute repository matching the given key.
List<AttrRepoTO>	list()	Returns a list of attribute repositories.
AttrRepoTO	read(@NotNull String key)	Returns the attribute repository matching the given key.
void	update(@NotNull AttrRepoTO attrRepoTO)	Updates attribute repository matching the given key.

Method Detail

read

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

Returns the attribute repository matching the given key.

Parameters:

key - key of requested attribute repository

Returns:

attribute repository with matching id

list

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

Returns a list of attribute repositories.

Returns:

list of attribute repositories

create

@POST
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                 @NotNull AttrRepoTO attrRepoTO)

Create a new attribute repository.

Parameters:

attrRepoTO - AttrRepo to be created.

Returns:

Response object featuring Location header of created attribute repository

update

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

Updates attribute repository matching the given key.

Parameters:

attrRepoTO - AttrRepo to replace existing attribute repository

delete

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

Delete attribute repository matching the given key.

Parameters:

key - key of attribute repository to be deleted