1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions copyright [year] [name of copyright owner]".
13 *
14 * Copyright 2013-2017 ForgeRock AS.
15 */
16
17 package org.forgerock.json.jose.jwt;
18
19 /**
20 * The interface for each possible algorithm that can be used to sign and/or encrypt a JWT.
21 * <p>
22 * @see <a href="http://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-11">
23 * JSON Web Algorithms Specification</a>
24 *
25 * @since 2.0.0
26 */
27 public interface Algorithm {
28
29 /**
30 * Gets the actual name of the algorithm that is understood by Java cryptographic operations.
31 *
32 * @return The name of the algorithm.
33 */
34 String getAlgorithm();
35
36 /**
37 * Gets the name of the algorithm as defined in the JWA standard.
38 *
39 * @return The name of the algorithm.
40 */
41 String getJwaAlgorithmName();
42 }