001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2013-2017 ForgeRock AS.
015 */
016
017package org.forgerock.json.jose.jwt;
018
019/**
020 * The interface for each possible algorithm that can be used to sign and/or encrypt a JWT.
021 * <p>
022 * @see <a href="http://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-11">
023 *     JSON Web Algorithms Specification</a>
024 *
025 * @since 2.0.0
026 */
027public interface Algorithm {
028
029    /**
030     * Gets the actual name of the algorithm that is understood by Java cryptographic operations.
031     *
032     * @return The name of the algorithm.
033     */
034    String getAlgorithm();
035
036    /**
037     * Gets the name of the algorithm as defined in the JWA standard.
038     *
039     * @return The name of the algorithm.
040     */
041    String getJwaAlgorithmName();
042}