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-2015 ForgeRock AS.
15 */
16
17 package org.forgerock.json.jose.builders;
18
19 import org.forgerock.json.jose.jwt.Jwt;
20
21 /**
22 * The base interface for all JwtBuilders for each type of JWT (plaintext, signed or encrypted).
23 *
24 * @since 2.0.0
25 */
26 public interface JwtBuilder {
27
28 /**
29 * Builds the JWT object from its constituent parts.
30 *
31 * @return The Jwt.
32 */
33 Jwt asJwt();
34
35 /**
36 * Builds the JWT into a <code>String</code> by calling the <tt>build</tt> method on the JWT object.
37 * <p>
38 * @see org.forgerock.json.jose.jwt.Jwt#build()
39 *
40 * @return The base64url encoded UTF-8 parts of the JWT.
41 */
42 String build();
43 }