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

Interface ApplicationService

All Superinterfaces:

JAXRSService

@Path(value="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_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 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 Detail

list

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

Returns a list of all applications.

Returns:

list of all applications.

read

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

Returns application with matching key.

Parameters:

key - application key to be read

Returns:

application with matching key

readPrivilege

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

Returns privilege with matching key.

Parameters:

key - privilege key to be read

Returns:

privilege 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 ApplicationTO applicationTO)

Creates a new application.

Parameters:

applicationTO - application to be created

Returns:

Response object featuring Location header of created application

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 ApplicationTO applicationTO)

Updates the application matching the provided key.

Parameters:

applicationTO - application 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 application matching the provided key.

Parameters:

key - application key to be deleted