com.nimbusds.jose.KeyLengthException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nimbus-jose-jwt Show documentation

Java library for Javascript Object Signing and Encryption (JOSE) and JSON Web Tokens (JWT)

There is a newer version: 9.47

/*
 * nimbus-jose-jwt
 *
 * Copyright 2012-2016, Connect2id Ltd.
 *
 * 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.nimbusds.jose;


/**
 * Key length exception.
 *
 * @author Vladimir Dzhuvinov
 * @version 205-06-29
 */
public class KeyLengthException extends KeyException {


	/**
	 * The expected key length.
	 */
	private final int expectedLength;


	/**
	 * The algorithm.
	 */
	private final Algorithm alg;


	/**
	 * Creates a new key length exception.
	 *
	 * @param message The exception message.
	 */
	public KeyLengthException(final String message) {

		super(message);
		expectedLength = 0;
		alg = null;
	}


	/**
	 * Creates a new key length exception.
	 *
	 * @param alg The JOSE algorithm, {@code null} if not specified.
	 */
	public KeyLengthException(final Algorithm alg) {

		this(0, alg);
	}


	/**
	 * Creates a new key length exception.
	 *
	 * @param expectedLength The expected key length in bits, zero if not
	 *                       specified.
	 * @param alg            The JOSE algorithm, {@code null} if not
	 *                       specified.
	 */
	public KeyLengthException(final int expectedLength, final Algorithm alg) {

		super((
			(expectedLength > 0) ? "The expected key length is " + expectedLength + " bits" : "Unexpected key length") +
			((alg != null) ? " (for " + alg + " algorithm)" : "")
		);

		this.expectedLength = expectedLength;
		this.alg = alg;
	}


	/**
	 * Returns the expected key length.
	 *
	 * @return The expected key length in bits, zero if not specified.
	 */
	public int getExpectedKeyLength() {

		return expectedLength;
	}


	/**
	 * Returns the algorithm.
	 *
	 * @return The JOSE algorithm, {@code null} if not specified.
	 */
	public Algorithm getAlgorithm() {

		return alg;
	}
}