at.porscheinformatik.tapestry.csrfprotection.CsrfToken Maven / Gradle / Ivy

Go to download
package at.porscheinformatik.tapestry.csrfprotection;

import java.io.Serializable;

/**
 * Provides the information about an expected CSRF token.
 *
 * @see at.porscheinformatik.tapestry.csrfprotection.internal.DefaultCsrfToken
 * @since 1.1
 */
public interface CsrfToken extends Serializable
{
    /**
     * 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.
     *
     * @return the HTTP header that the CSRF is populated on the response and
     *         can be placed on requests instead of the parameter
     */
    String getHeaderName();

    /**
     * Gets the HTTP parameter name that should contain the token. Cannot be null.
     * 
     * @return the HTTP parameter name that should contain the token.
     */
    String getParameterName();

    /**
     * Gets the token value. Cannot be null.
     * 
     * @return the token value
     */
    String getToken();
}