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

Interface SyncopeService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

SyncopeServiceImpl

@Path(value="")
public interface SyncopeService
extends JAXRSService

General info about this Apache Syncope deployment.

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	batch() Gets batch results, in case asynchronous was requested.
javax.ws.rs.core.Response	batch(InputStream input) Requests for batch execution.
void	clearEntityCache() Evicts all entities from cache.
NumbersInfo	numbers() Provides some numbers about the managed entities (users, groups, any objects...).
PlatformInfo	platform() Provides information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...).
TypeExtensionTO	readUserTypeExtension(@NotNull String groupName) Extracts User type extension information, for the provided group.
PagedResult<GroupTO>	searchAssignableGroups(@NotNull String realm, String term, @Min(value=1L) int page, @Min(value=1L) int size) Returns the list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm.
Map<String,Object>	statistics() Provides entity cache statistics information.
javax.ws.rs.core.Response	statistics(@NotNull String operation) Operates on entity cache statistics.
SystemInfo	system() Provides information about the underlying system (Operating System, CPU / memory usage, ...).

Method Detail

platform

@GET
 @Path(value="/platform")
 @Produces(value={"application/json","application/yaml","application/xml"})
PlatformInfo platform()

Provides information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...).

Returns:

information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...)

system

@GET
 @Path(value="/system")
 @Produces(value={"application/json","application/yaml","application/xml"})
SystemInfo system()

Provides information about the underlying system (Operating System, CPU / memory usage, ...).

Returns:

information about the underlying system (Operating System, CPU / memory usage, ...)

numbers

@GET
 @Path(value="/numbers")
 @Produces(value={"application/json","application/yaml","application/xml"})
NumbersInfo numbers()

Provides some numbers about the managed entities (users, groups, any objects...).

Returns:

some numbers about the managed entities (users, groups, any objects...)

statistics

@GET
 @Path(value="/statistics")
 @Produces(value={"application/json","application/yaml","application/xml"})
Map<String,Object> statistics()

Provides entity cache statistics information.

Returns:

cache statistics

statistics

@POST
 @Path(value="/statistics")
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response statistics(@NotNull @QueryParam(value="operation")
                                                                                                                                                   @NotNull String operation)

Operates on entity cache statistics.

Parameters:

operation - enable, disable or reset entity cache statistics

Returns:

clearEntityCache

@DELETE
 @Path(value="/entityCache")
 @Produces(value={"application/json","application/yaml","application/xml"})
void clearEntityCache()

Evicts all entities from cache.

batch

@POST
 @Path(value="/batch")
 @Consumes(value="multipart/mixed")
 @Produces(value="multipart/mixed")
javax.ws.rs.core.Response batch(InputStream input)

Requests for batch execution.

Parameters:

input - batch request

Returns:

batch results returned as Response entity, in case no 'Prefer: respond-async' was specified

batch

@GET
 @Path(value="/batch")
 @Produces(value="multipart/mixed")
javax.ws.rs.core.Response batch()

Gets batch results, in case asynchronous was requested.

Returns:

batch results as Response entity

searchAssignableGroups

@POST
 @Path(value="/assignableGroups/{realm:.*}")
 @Produces(value={"application/json","application/yaml","application/xml"})
PagedResult<GroupTO> searchAssignableGroups(@NotNull @PathParam(value="realm")
                                                                                                                                                                           @NotNull String realm,
                                                                                                                                                                           @QueryParam(value="term")
                                                                                                                                                                           String term,
                                                                                                                                                                           @Min(value=1L) @QueryParam(value="page") @DefaultValue(value="1")
                                                                                                                                                                           @Min(value=1L) int page,
                                                                                                                                                                           @Min(value=1L) @QueryParam(value="size") @DefaultValue(value="25")
                                                                                                                                                                           @Min(value=1L) int size)

Returns the list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm.

Parameters:

term - groups search term

realm - of the User and Any Objects assignable to the returned Groups

page - search page

size - search page size

Returns:

list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm

readUserTypeExtension

@GET
 @Path(value="/userTypeExtension/{groupName}")
 @Produces(value={"application/json","application/yaml","application/xml"})
TypeExtensionTO readUserTypeExtension(@NotNull @PathParam(value="groupName")
                                                                                                                                                                      @NotNull String groupName)

Extracts User type extension information, for the provided group.

Parameters:

groupName - group name

Returns:

User type extension information, for the provided group