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

Interface ApplicationService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

ApplicationServiceImpl

@Path("applications")
public interface ApplicationService
extends JAXRSService

REST operations for 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
Response	create(@NotNull ApplicationTO applicationTO)	Creates a new application.
void	delete(@NotNull String key)	Deletes the application matching the provided key.
List<ApplicationTO>	list()	Returns a list of all applications.
ApplicationTO	read(@NotNull String key)	Returns application with matching key.
PrivilegeTO	readPrivilege(@NotNull String key)	Returns privilege with matching key.
void	update(@NotNull ApplicationTO applicationTO)	Updates the application matching the provided key.

Method Details

list

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

Returns a list of all applications.

Returns:

list of all applications.

read

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

Returns application with matching key.

Parameters:

key - application key to be read

Returns:

application with matching key

readPrivilege

@GET
@Path("privileges/{key}")
@Produces({"application/json","application/yaml","application/xml"})
PrivilegeTO readPrivilege(@NotNull @PathParam("key")
 @NotNull String key)

Returns privilege with matching key.

Parameters:

key - privilege key to be read

Returns:

privilege with matching key

create

@POST
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
Response create(@NotNull
 @NotNull ApplicationTO applicationTO)

Creates a new application.

Parameters:

applicationTO - application to be created

Returns:

Response object featuring Location header of created application

update

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

Updates the application matching the provided key.

Parameters:

applicationTO - application to be stored

delete

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

Deletes the application matching the provided key.

Parameters:

key - application key to be deleted