org.eclipse.jetty.http2.frames.HeadersFrame Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetty-http2-common Show documentation
The newest version!
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//

package org.eclipse.jetty.http2.frames;

import org.eclipse.jetty.http.MetaData;

public class HeadersFrame extends StreamFrame
{
    private final MetaData metaData;
    private final PriorityFrame priority;
    private final boolean endStream;

    /**
     * Creates a new {@code HEADERS} frame with an unspecified stream {@code id}.
     * The stream {@code id} will be generated by the implementation while sending
     * this frame to the other peer.
     *
     * @param metaData the metadata containing HTTP request information
     * @param priority the PRIORITY frame associated with this HEADERS frame
     * @param endStream whether this frame ends the stream
     */
    public HeadersFrame(MetaData metaData, PriorityFrame priority, boolean endStream)
    {
        this(0, metaData, priority, endStream);
    }

    /**
     * Creates a new {@code HEADERS} frame with the specified stream {@code id}.
     * {@code HEADERS} frames with a specific stream {@code id} are typically used
     * in responses to request {@code HEADERS} frames.
     *
     * @param streamId the stream id
     * @param metaData the metadata containing HTTP request/response information
     * @param priority the PRIORITY frame associated with this HEADERS frame
     * @param endStream whether this frame ends the stream
     */
    public HeadersFrame(int streamId, MetaData metaData, PriorityFrame priority, boolean endStream)
    {
        super(FrameType.HEADERS, streamId);
        this.metaData = metaData;
        this.priority = priority;
        this.endStream = endStream;
    }

    public MetaData getMetaData()
    {
        return metaData;
    }

    public PriorityFrame getPriority()
    {
        return priority;
    }

    public boolean isEndStream()
    {
        return endStream;
    }

    @Override
    public HeadersFrame withStreamId(int streamId)
    {
        PriorityFrame priority = getPriority();
        priority = priority == null ? null : priority.withStreamId(streamId);
        return new HeadersFrame(streamId, getMetaData(), priority, isEndStream());
    }

    @Override
    public String toString()
    {
        return String.format("%s#%d[end=%b,{%s},priority=%s]", super.toString(), getStreamId(), isEndStream(), getMetaData(), getPriority());
    }
}