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.JwtClaimsSet;
20
21 /**
22 * A base implementation for all JwtBuilders that provides the basis of the JWT builder methods.
23 *
24 * @since 2.0.0
25 */
26 public abstract class AbstractJwtBuilder implements JwtBuilder {
27
28 private JwtHeaderBuilder<?, ?> headerBuilder;
29 private JwtClaimsSet claimsSet;
30
31 /**
32 * Gets the JwtHeaderBuilder that this JwtBuilder will use to build the JWT's header parameters.
33 *
34 * @return The JwtHeaderBuilder instance.
35 */
36 public abstract JwtHeaderBuilder<?, ?> headers();
37
38 /**
39 * Sets the JwtHeaderBuilder that this JwtBuilder will use to build the JWT's header parameters.
40 *
41 * @param headerBuilder The JwtHeaderBuilder instance.
42 */
43 void setJwtHeaderBuilder(JwtHeaderBuilder<?, ?> headerBuilder) {
44 this.headerBuilder = headerBuilder;
45 }
46
47 /**
48 * Gets the JwtHeaderBuilder that is used to build the JWT's header parameters.
49 *
50 * @return The JwtHeaderBuilder instance.
51 */
52 JwtHeaderBuilder<?, ?> getHeaderBuilder() {
53 return headerBuilder;
54 }
55
56 /**
57 * Sets the JwtClaimsSet for this JwtBuilder.
58 *
59 * @param claimsSet The JwtClaimsSet containing the JWT's claims.
60 * @return This AbstractJwtBuilder.
61 */
62 public AbstractJwtBuilder claims(JwtClaimsSet claimsSet) {
63 this.claimsSet = claimsSet;
64 return this;
65 }
66
67 /**
68 * Gets the JwtClaimsSet that has been set in this JwtBuilder.
69 *
70 * @return The JwtClaimsSet containing the JWT's claims.
71 */
72 JwtClaimsSet getClaimsSet() {
73 return claimsSet;
74 }
75 }