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

Interface AuditService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

AuditServiceImpl

@Path("audit")
public interface AuditService
extends JAXRSService

REST operations for audit.

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
void	create(@NotNull AuditEntry auditEntry)	Create an audit entry.
void	delete(@NotNull String key)	Deletes the audit matching the provided key.
List<EventCategory>	events()	Returns the list of all managed events in audit.
List<AuditConfTO>	list()	Returns a list of all audits.
AuditConfTO	read(@NotNull String key)	Returns audit with matching key.
PagedResult<AuditEntry>	search(AuditQuery auditQuery)	Returns a paged list of audit entries matching the given query.
void	set(@NotNull AuditConfTO auditTO)	Set an audit setting.

Method Detail

list

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

Returns a list of all audits.

Returns:

list of all audits.

read

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

Returns audit with matching key.

Parameters:

key - audit key to be read

Returns:

audit with matching key

set

@PUT
@Path("{key}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
void set(@NotNull
         @NotNull AuditConfTO auditTO)

Set an audit setting.

Parameters:

auditTO - audit to be stored

delete

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

Deletes the audit matching the provided key.

Parameters:

key - audit key to be deleted

events

@GET
@Path("events")
@Produces({"application/json","application/yaml","application/xml"})
List<EventCategory> events()

Returns the list of all managed events in audit.

Returns:

list of all managed events in audit

search

@GET
@Path("entries")
@Produces({"application/json","application/yaml","application/xml"})
PagedResult<AuditEntry> search(@BeanParam
                               AuditQuery auditQuery)

Returns a paged list of audit entries matching the given query.

Parameters:

auditQuery - query conditions

Returns:

paged list of audit entries matching the given query

create

@POST
@Path("entries")
@Consumes({"application/json","application/yaml","application/xml"})
void create(@NotNull
            @NotNull AuditEntry auditEntry)

Create an audit entry.

Parameters:

auditEntry - audit entry to persist.