Package io.jans.configapi.rest.resource.auth

Class AuditLogResource

java.lang.Object

io.jans.configapi.core.rest.BaseResource

io.jans.configapi.rest.resource.auth.ConfigBaseResource

io.jans.configapi.rest.resource.auth.AuditLogResource

@Path("/audit")
@Consumes("application/json")
@Produces("application/json")
public class AuditLogResource
extends ConfigBaseResource

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUDIT_FILE_ISO_OFFSET_DATE_TIME
static String	AUDIT_FILE_NAME
static String	AUDIT_FILE_PATH
static String	DEFAULT_DATE_FORMAT
static String	PARAM_DATE_ISO_OFFSET_DATE_TIME

Fields inherited from class io.jans.configapi.core.rest.BaseResource

DEFAULT_SEARCH_PATTERN

Constructor Summary

Constructors

Constructor	Description
AuditLogResource()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getLogsEnteries(String pattern, int startIndex, int limit, String startDate, String endDate)	Searches and returns paginated audit log entries filtered by an optional pattern and date range.

Methods inherited from class io.jans.configapi.rest.resource.auth.ConfigBaseResource

getMaxCount

Methods inherited from class io.jans.configapi.core.rest.BaseResource

checkNotEmpty, checkNotEmpty, checkNotNull, checkNotNull, checkNotNull, checkResourceNotNull, createSearchRequest, findRootError, getBadRequestException, getBadRequestException, getBadRequestException, getHttpHeaders, getHttpRequest, getInternalServerException, getInternalServerException, getMissingAttributeError, getNotAcceptableException, getNotFoundError, getNotFoundError, getRegexPattern, getUriInfo, throwBadRequestException, throwBadRequestException, throwBadRequestException, throwInternalServerException, throwInternalServerException, throwInternalServerException, throwInternalServerException, throwMissingAttributeError, throwNotFoundException, throwNotFoundException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AUDIT_FILE_PATH

public static final String AUDIT_FILE_PATH

See Also:

Constant Field Values

AUDIT_FILE_NAME

public static final String AUDIT_FILE_NAME

See Also:

Constant Field Values

DEFAULT_DATE_FORMAT

public static final String DEFAULT_DATE_FORMAT

See Also:

Constant Field Values

AUDIT_FILE_ISO_OFFSET_DATE_TIME

public static final String AUDIT_FILE_ISO_OFFSET_DATE_TIME

See Also:

Constant Field Values

PARAM_DATE_ISO_OFFSET_DATE_TIME

public static final String PARAM_DATE_ISO_OFFSET_DATE_TIME

See Also:

Constant Field Values

Constructor Detail

AuditLogResource

public AuditLogResource()

Method Detail

getLogsEnteries

@GET
public jakarta.ws.rs.core.Response getLogsEnteries(@QueryParam("pattern")
                                                   String pattern,
                                                   @DefaultValue("0") @QueryParam("startIndex")
                                                   int startIndex,
                                                   @DefaultValue("50") @QueryParam("limit")
                                                   int limit,
                                                   @QueryParam("start_date")
                                                   String startDate,
                                                   @QueryParam("end_date")
                                                   String endDate)

Searches and returns paginated audit log entries filtered by an optional pattern and date range.

Parameters:

pattern - a substring to filter log lines; blank returns all entries

startIndex - index of the first result to return

limit - maximum number of results to return

startDate - optional start date (dd-MM-yyyy or ISO-8601 date-time) to include entries on or after this date

endDate - optional end date (dd-MM-yyyy or ISO-8601 date-time) to include entries on or before this date

Returns:

a HTTP 200 Response containing a LogPagedResult with the matching log lines and pagination metadata