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
List<AuditConfTO>	confs()	Returns a list of all audit configurations.
void	create(@NotNull AuditEventTO auditEvent)	Persist an audit event.
void	deleteConf(@NotNull String key)	Deletes the audit configuration matching the provided key.
List<OpEvent>	events()	Returns the list of all managed events in audit.
AuditConfTO	getConf(@NotNull String key)	Returns the audit configuration with matching key.
PagedResult<AuditEventTO>	search(AuditQuery auditQuery)	Returns a paged list of audit entries matching the given query.
void	setConf(@NotNull AuditConfTO auditTO)	Sets an audit configuration

Method Details

confs

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

Returns a list of all audit configurations.

Returns:

list of all audit configurations.

getConf

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

Returns the audit configuration with matching key.

Parameters:

key - audit key to be read

Returns:

audit configuration with matching key

setConf

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

Sets an audit configuration

Parameters:

auditTO - audit configuration to be stored

deleteConf

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

Deletes the audit configuration matching the provided key.

Parameters:

key - audit configuration key to be deleted

events

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

Returns the list of all managed events in audit.

Returns:

list of all managed events in audit

search

@GET
@Path("auditEvents")
@Produces({"application/json","application/yaml","application/xml"})
PagedResult<AuditEventTO> 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("auditEvents")
@Consumes({"application/json","application/yaml","application/xml"})
void create(@NotNull
 @NotNull AuditEventTO auditEvent)

Persist an audit event.

Parameters:

auditEvent - audit event to persist.