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.jwt;
18
19 /**
20 * The interface represents the body of a JWT.
21 * <p>
22 * When the JWT is digitally signed or MACed, the bytes of the UTF-8 representation of the Payload are base64url
23 * encoded to create the Encoded JWS Payload. When the JWT is encrypted, the bytes of the UTF-8 representation of the
24 * Payload are used as the JWE Plaintext.
25 *
26 * @since 2.0.0
27 */
28 public interface Payload {
29
30 /**
31 * Builds the JWTs Payload into a <code>String</code> by following the steps specified in the relevant specification
32 * according to whether the JWT is being signed and/or encrypted.
33 * <p>
34 * @see <a href="http://tools.ietf.org/html/draft-jones-json-web-token-10#section-7">
35 * JSON Web Token Specification</a>
36 * @see <a href="http://tools.ietf.org/html/draft-ietf-jose-json-web-signature-11#section-5">
37 * JSON Web Signature Specification</a>
38 * @see <a href="http://tools.ietf.org/html/draft-ietf-jose-json-web-encryption-11#section-5">
39 * JSON Web Encryption Specification</a>
40 *
41 * @return The base64url encoded UTF-8 representation of the JWTs Payload.
42 */
43 String build();
44 }