io.inverno.mod.security.http.digest.ExpiredNonceException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of inverno-security-http Show documentation
Inverno security HTTP module
The newest version!
/*
 * Copyright 2022 Jeremy Kuhn
 *
 * 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 io.inverno.mod.security.http.digest;

import io.inverno.mod.security.authentication.AuthenticationException;

/**
 * 
 * Thrown by a {@link DigestCredentialsMatcher} to indicate that the provided nonce has expired.
 * 
 * 
 * 
 * This exception should be intercepted by a {@link DigestAuthenticationErrorInterceptor} to send with a stale response to the client as defined by
 * RFC 7616 section 3.3.
 * 
 * 
 * @author Jeremy Kuhn
 * @since 1.5
 */
public class ExpiredNonceException extends AuthenticationException {

	private static final long serialVersionUID = 1L;

	/**
	 * 
	 * Creates an expired nonce exception.
	 * 
	 */
	public ExpiredNonceException() {
	}

	/**
	 * 
	 * Creates an expired nonce exception with the specified message.
	 * 
	 * 
	 * @param message the message
	 */
	public ExpiredNonceException(String message) {
		super(message);
	}
	
	/**
	 * 
	 * Creates an expired nonce exception with the specified cause.
	 * 
	 *
	 * @param cause the cause
	 */
	public ExpiredNonceException(Throwable cause) {
		super(cause);
	}

	/**
	 * 
	 * Creates an expired nonce exception with the specified message and cause.
	 * 
	 *
	 * @param message the message
	 * @param cause   the cause
	 */
	public ExpiredNonceException(String message, Throwable cause) {
		super(message, cause);
	}

	/**
	 * 
	 * Creates an expired nonce exception with the specified message, cause, suppression enabled or disabled and writable stack trace enabled or disabled.
	 * 
	 *
	 * @param message            the message
	 * @param cause              the cause
	 * @param enableSuppression  true to enable suppression, false otherwise
	 * @param writableStackTrace true to make the stack trace writable, false otherwise
	 */
	public ExpiredNonceException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
		super(message, cause, enableSuppression, writableStackTrace);
	}
}