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.jws.JwsHeader;
020
021/**
022 * An implementation of a JWS Header builder that provides a fluent builder pattern to create JWS headers.
023 * <p>
024 * See {@link JwsHeader} for information on the JwsHeader object that this builder creates.
025 *
026 * @since 2.0.0
027 */
028public class JwsHeaderBuilder extends JwtSecureHeaderBuilder<SignedJwtBuilderImpl, JwsHeaderBuilder> {
029
030    /**
031     * Constructs a new JwsHeaderBuilder, parented by the given JwtBuilder.
032     *
033     * @param jwtBuilder The JwtBuilder instance that this JwsHeaderBuilder is a child of.
034     */
035    public JwsHeaderBuilder(SignedJwtBuilderImpl jwtBuilder) {
036        super(jwtBuilder);
037    }
038
039    /**
040     * Creates a JwsHeader instance from the header parameters set in this builder.
041     *
042     * @return A JwsHeader instance.
043     */
044    @Override
045    protected JwsHeader build() {
046        return new JwsHeader(getHeaders());
047    }
048}