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

Interface SyncopeService

All Superinterfaces:

JAXRSService

@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

PARAM_ANYTYPE_KIND, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_RESOURCE, PARAM_SIZE

Method Summary

Modifier and Type	Method and Description
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, ...).
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/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/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/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...)