Package org.springframework.security.web.csrf

Interface CsrfToken

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    DefaultCsrfToken
    public interface CsrfToken
extends java.io.Serializable
    Provides the information about an expected CSRF token.
    Since:
    3.2
    See Also:
    DefaultCsrfToken

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getHeaderName()
      Gets the HTTP header that the CSRF is populated on the response and can be placed on requests instead of the parameter.
      java.lang.String getParameterName()
      Gets the HTTP parameter name that should contain the token.
      java.lang.String getToken()
      Gets the token value.

    • Method Detail

      • getHeaderName

        java.lang.String getHeaderName()
        Gets the HTTP header that the CSRF is populated on the response and can be placed on requests instead of the parameter. Cannot be null.
        Returns:
        the HTTP header that the CSRF is populated on the response and can be placed on requests instead of the parameter

      • getParameterName

        java.lang.String getParameterName()
        Gets the HTTP parameter name that should contain the token. Cannot be null.
        Returns:
        the HTTP parameter name that should contain the token.

      • getToken

        java.lang.String getToken()
        Gets the token value. Cannot be null.
        Returns:
        the token value