+ * {@code
+ * @Audited(type = AuditEventType.USER_REGISTRATION, level = AuditLevel.BASIC)
+ * public void registerUser(String username) {
+ * // Method implementation
+ * }
+ * }
+ *
+ *
+ * For backward compatibility, string-based event types are still supported:
+ *
+ *
+ * {@code
+ * @Audited(typeString = "CUSTOM_EVENT_TYPE", level = AuditLevel.BASIC)
+ * public void customOperation() {
+ * // Method implementation
+ * }
+ * }
+ *
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Audited {
+
+ /**
+ * The type of audit event using the standardized AuditEventType enum.
+ * This is the preferred way to specify the event type.
+ *
+ * If both type() and typeString() are specified, type() takes precedence.
+ */
+ AuditEventType type() default AuditEventType.HTTP_REQUEST;
+
+ /**
+ * The type of audit event as a string (e.g., "FILE_UPLOAD", "USER_REGISTRATION").
+ * Provided for backward compatibility and custom event types not in the enum.
+ *
+ * If both type() and typeString() are specified, type() takes precedence.
+ */
+ String typeString() default "";
+
+ /**
+ * The audit level at which this event should be logged
+ */
+ AuditLevel level() default AuditLevel.STANDARD;
+
+ /**
+ * Should method arguments be included in the audit event
+ */
+ boolean includeArgs() default true;
+
+ /**
+ * Should the method return value be included in the audit event
+ */
+ boolean includeResult() default false;
+}
\ No newline at end of file
diff --git a/proprietary/src/main/java/stirling/software/proprietary/audit/ControllerAuditAspect.java b/proprietary/src/main/java/stirling/software/proprietary/audit/ControllerAuditAspect.java
new file mode 100644
index 000000000..6f3990a68
--- /dev/null
+++ b/proprietary/src/main/java/stirling/software/proprietary/audit/ControllerAuditAspect.java
@@ -0,0 +1,211 @@
+package stirling.software.proprietary.audit;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
+import org.aspectj.lang.ProceedingJoinPoint;
+import org.aspectj.lang.annotation.Around;
+import org.aspectj.lang.annotation.Aspect;
+import org.aspectj.lang.reflect.MethodSignature;
+import org.springframework.stereotype.Component;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PatchMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.context.request.RequestContextHolder;
+import org.springframework.web.context.request.ServletRequestAttributes;
+
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import stirling.software.proprietary.config.AuditConfigurationProperties;
+import stirling.software.proprietary.service.AuditService;
+
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Method;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Aspect for automatically auditing controller methods with web mappings
+ * (GetMapping, PostMapping, etc.)
+ */
+@Aspect
+@Component
+@Slf4j
+@RequiredArgsConstructor
+public class ControllerAuditAspect {
+
+ private final AuditService auditService;
+ private final AuditConfigurationProperties auditConfig;
+
+
+ @Around("execution(* org.springframework.web.servlet.resource.ResourceHttpRequestHandler.handleRequest(..))")
+ public Object auditStaticResource(ProceedingJoinPoint jp) throws Throwable {
+ return auditController(jp, "GET");
+ }
+ /**
+ * Intercept all methods with GetMapping annotation
+ */
+ @Around("@annotation(org.springframework.web.bind.annotation.GetMapping)")
+ public Object auditGetMethod(ProceedingJoinPoint joinPoint) throws Throwable {
+ return auditController(joinPoint, "GET");
+ }
+
+ /**
+ * Intercept all methods with PostMapping annotation
+ */
+ @Around("@annotation(org.springframework.web.bind.annotation.PostMapping)")
+ public Object auditPostMethod(ProceedingJoinPoint joinPoint) throws Throwable {
+ return auditController(joinPoint, "POST");
+ }
+
+ /**
+ * Intercept all methods with PutMapping annotation
+ */
+ @Around("@annotation(org.springframework.web.bind.annotation.PutMapping)")
+ public Object auditPutMethod(ProceedingJoinPoint joinPoint) throws Throwable {
+ return auditController(joinPoint, "PUT");
+ }
+
+ /**
+ * Intercept all methods with DeleteMapping annotation
+ */
+ @Around("@annotation(org.springframework.web.bind.annotation.DeleteMapping)")
+ public Object auditDeleteMethod(ProceedingJoinPoint joinPoint) throws Throwable {
+ return auditController(joinPoint, "DELETE");
+ }
+
+ /**
+ * Intercept all methods with PatchMapping annotation
+ */
+ @Around("@annotation(org.springframework.web.bind.annotation.PatchMapping)")
+ public Object auditPatchMethod(ProceedingJoinPoint joinPoint) throws Throwable {
+ return auditController(joinPoint, "PATCH");
+ }
+
+ private Object auditController(ProceedingJoinPoint joinPoint, String httpMethod) throws Throwable {
+ MethodSignature sig = (MethodSignature) joinPoint.getSignature();
+ Method method = sig.getMethod();
+
+ // Fast path: check if auditing is enabled before doing any work
+ // This avoids all data collection if auditing is disabled
+ if (!AuditUtils.shouldAudit(method, auditConfig)) {
+ return joinPoint.proceed();
+ }
+
+ // Check if method is explicitly annotated with @Audited
+ Audited auditedAnnotation = method.getAnnotation(Audited.class);
+ AuditLevel level = auditConfig.getAuditLevel();
+
+ // If @Audited annotation is present, respect its level setting
+ if (auditedAnnotation != null) {
+ // Use the level from annotation if it's stricter than global level
+ level = auditedAnnotation.level();
+ }
+
+ String path = getRequestPath(method, httpMethod);
+
+ // Skip static GET resources
+ if ("GET".equals(httpMethod)) {
+ HttpServletRequest maybe = AuditUtils.getCurrentRequest();
+ if (maybe != null && AuditUtils.isStaticResourceRequest(maybe)) {
+ return joinPoint.proceed();
+ }
+ }
+
+ ServletRequestAttributes attrs = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
+ HttpServletRequest req = attrs != null ? attrs.getRequest() : null;
+ HttpServletResponse resp = attrs != null ? attrs.getResponse() : null;
+
+ long start = System.currentTimeMillis();
+
+ // Use AuditUtils to create the base audit data
+ Map| ID | +Time | +User | +Type | +Details | +
|---|
The export will include all audit events matching the selected filters. For large datasets, the export may take a few moments to generate.
+Exported data will include:
+