com.github.wnameless.spring.papertrail.AfterPaperTrailCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-paper-trail Show documentation

Add automatic audit trail to all stateful HTTP requests by the annotation @EnablePaperTrail

The newest version!

/*
 *
 * Copyright 2016 Wei-Ming Wu
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 *
 */
package com.github.wnameless.spring.papertrail;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

/**
 * 
 * {@link AfterPaperTrailCallback} provides an alternative way for users to perform any operation
 * they want with the {@link PaperTrail} which is created during the paper trail mechanism AFTER
 * this {@link PaperTrail} saved.
 *
 * @param  the type of a PaperTrail implementation
 */
public interface AfterPaperTrailCallback, PT extends PaperTrail> {

  /**
   * The callback of the paper trail mechanism BEFORE this {@link PaperTrail} saved.
   * 
   * @param paperTrail a {@link PaperTrail}
   * @param request a {@link HttpServletRequest}
   * @param response a {@link HttpServletResponse}
   */
  public void afterPaperTrail(R paperTrailRepo, PT paperTrail, HttpServletRequest request,
      HttpServletResponse response);

}