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

Interface DomainService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

DomainServiceImpl

@Path(value="domains")
public interface DomainService
extends JAXRSService

REST operations for domains.

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_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(@NotNull DomainTO domainTO) Creates a new domain.
void	delete(@NotNull String key) Deletes the domain matching the provided key.
List<DomainTO>	list() Returns a list of all domains.
DomainTO	read(@NotNull String key) Returns domain with matching key.
void	update(@NotNull DomainTO domainTO) Updates the domain matching the provided key.

Method Detail

list

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

Returns a list of all domains.

Returns:

list of all domains.

read

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

Returns domain with matching key.

Parameters:

key - domain key to be read

Returns:

domain with matching key

create

@POST
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                                                                                                                                                                               @NotNull DomainTO domainTO)

Creates a new domain.

Parameters:

domainTO - domain to be created

Returns:

Response object featuring Location header of created domain

update

@PUT
 @Path(value="{key}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void update(@NotNull
                                                                                                                                                                                               @NotNull DomainTO domainTO)

Updates the domain matching the provided key.

Parameters:

domainTO - domain to be stored

delete

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

Deletes the domain matching the provided key.

Parameters:

key - domain key to be deleted