org.apache.syncope.common.services

Interface LoggerService

All Superinterfaces:

JAXRSService

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

REST operations for logging and auditing.

Field Summary

Fields inherited from interface org.apache.syncope.common.services.JAXRSService

DEFAULT_PARAM_PAGE, DEFAULT_PARAM_PAGE_VALUE, DEFAULT_PARAM_SIZE, DEFAULT_PARAM_SIZE_VALUE, PARAM_DETAILS, PARAM_FIQL, PARAM_ORDERBY, PARAM_PAGE, PARAM_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(LoggerType type, String name) Deletes the logger with matching name.
List<EventCategoryTO>	events() Returns a list of all managed events in audit.
List<LoggerTO>	list(LoggerType type) Returns a list of loggers with matching type.
LoggerTO	read(LoggerType type, String name) Returns logger with matching type and name.
void	update(LoggerType type, String name, LoggerTO logger) Creates or updates (if existing) the logger with matching name.

Method Detail

events

@GET
@Path(value="events")
@Produces(value={"application/xml","application/json"})
List<EventCategoryTO> events()

Returns a list of all managed events in audit.

Returns:

list of all managed events in audit

read

@GET
@Path(value="{type}/{name}")
@Produces(value={"application/xml","application/json"})
LoggerTO read(@NotNull@PathParam(value="type")
                              LoggerType type,
                              @NotNull@PathParam(value="name")
                              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/xml","application/json"})
List<LoggerTO> list(@NotNull@PathParam(value="type")
                                    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}/{name}")
@Consumes(value={"application/xml","application/json"})
void update(@NotNull@PathParam(value="type")
                            LoggerType type,
                            @NotNull@PathParam(value="name")
                            String name,
                            @NotNull
                            LoggerTO logger)

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

Parameters:

type - LoggerType to be selected

name - Logger name to be updated

logger - Logger to be created or updated

delete

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

Deletes the logger with matching name.

Parameters:

type - LoggerType to be selected

name - Logger name to be deleted