View Javadoc

1   package com.atlassian.sal.api.xsrf;
2   
3   import javax.servlet.http.HttpServletRequest;
4   
5   /**
6    * An interface which can be implemented to check if a request
7    * contains either a valid csrf token or a
8    * valid csrf header {@link com.atlassian.sal.api.xsrf.XsrfHeaderValidator#TOKEN_HEADER}.
9    *
10   * @since v2.10.18
11   */
12  public interface XsrfRequestValidator {
13      /**
14       * Returns true iff the given request has a valid csrf token or a
15       * valid csrf header.
16       *
17       * @param request the request to check.
18       * @return true iff the given request has a valid csrf token or a
19       * valid csrf header.
20       */
21      public boolean validateRequestPassesXsrfChecks(HttpServletRequest request);
22  }