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-2015 ForgeRock AS.
015 */
016
017package org.forgerock.json.jose.builders;
018
019import org.forgerock.json.jose.jwt.Jwt;
020
021/**
022 * The base interface for all JwtBuilders for each type of JWT (plaintext, signed or encrypted).
023 *
024 * @since 2.0.0
025 */
026public interface JwtBuilder {
027
028    /**
029     * Builds the JWT object from its constituent parts.
030     *
031     * @return The Jwt.
032     */
033    Jwt asJwt();
034
035    /**
036     * Builds the JWT into a <code>String</code> by calling the <tt>build</tt> method on the JWT object.
037     * <p>
038     * @see org.forgerock.json.jose.jwt.Jwt#build()
039     *
040     * @return The base64url encoded UTF-8 parts of the JWT.
041     */
042    String build();
043}