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

Interface LoggerService

All Superinterfaces:

JAXRSService

@Path(value="loggers")
public interface LoggerService
extends JAXRSService

REST operations for logging and auditing.

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
void	delete(@NotNull LoggerType type, @NotNull String name) Deletes the logger with matching name.
List<EventCategory>	events() Returns the list of all managed events in audit.
List<LogStatement>	getLastLogStatements(@NotNull String memoryAppender) Return the last log statements available in the provided memory appender.
List<LoggerTO>	list(@NotNull LoggerType type) Returns a list of loggers with matching type.
List<LogAppender>	memoryAppenders() Returns the list of memory appenders available in the current logging configuration.
LoggerTO	read(@NotNull LoggerType type, @NotNull String name) Returns logger with matching type and name.
PagedResult<AuditEntry>	search(AuditQuery auditQuery) Returns a paged list of audit entries matching the given query.
void	update(@NotNull LoggerType type, @NotNull LoggerTO logger) Creates or updates (if existing) the logger with matching name.

Method Detail

memoryAppenders

@GET
 @Path(value="memoryAppenders")
 @Produces(value={"application/json","application/yaml","application/xml"})
List<LogAppender> memoryAppenders()

Returns the list of memory appenders available in the current logging configuration.

Returns:

the list of memory appenders available in the current logging configuration

getLastLogStatements

@GET
 @Path(value="memoryAppenders/{memoryAppender}/lastLogStatements")
 @Produces(value={"application/json","application/yaml","application/xml"})
List<LogStatement> getLastLogStatements(@NotNull @PathParam(value="memoryAppender")
                                                                                                                                                                                            @NotNull String memoryAppender)

Return the last log statements available in the provided memory appender.

Parameters:

memoryAppender - memory appender name

Returns:

the last log statements available in the provided memory appender

events

@GET
 @Path(value="events")
 @Produces(value={"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(value="AUDIT/entries")
 @Produces(value={"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

read

@GET
 @Path(value="{type}/{name}")
 @Produces(value={"application/json","application/yaml","application/xml"})
LoggerTO read(@NotNull @PathParam(value="type")
                                                                                                                             @NotNull LoggerType type,
                                                                                                                             @NotNull @PathParam(value="name")
                                                                                                                             @NotNull String name)

Returns logger with matching type and name.

Parameters:

type - LoggerType to be selected.

name - Logger name to be read

Returns:

logger with matching type and name

list

@GET
 @Path(value="{type}")
 @Produces(value={"application/json","application/yaml","application/xml"})
List<LoggerTO> list(@NotNull @PathParam(value="type")
                                                                                                                            @NotNull LoggerType type)

Returns a list of loggers with matching type.

Parameters:

type - LoggerType to be selected

Returns:

list of loggers with matching type

update

@PUT
 @Path(value="{type}/{key}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void update(@NotNull @PathParam(value="type")
                                                                                                                                                                                                      @NotNull LoggerType type,
                                                                                                                                                                                                      @NotNull
                                                                                                                                                                                                      @NotNull LoggerTO logger)

Creates or updates (if existing) the logger with matching name.

Parameters:

type - LoggerType to be selected

logger - Logger to be created or updated

delete

@DELETE
 @Path(value="{type}/{name}")
 @Produces(value={"application/json","application/yaml","application/xml"})
void delete(@NotNull @PathParam(value="type")
                                                                                                                              @NotNull LoggerType type,
                                                                                                                              @NotNull @PathParam(value="name")
                                                                                                                              @NotNull String name)

Deletes the logger with matching name.

Parameters:

type - LoggerType to be selected

name - Logger name to be deleted