org.glassfish.grizzly.http2.frames.HeaderBlockFragment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grizzly-http2 Show documentation
There is a newer version: 4.0.2
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2014-2015 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.grizzly.http2.frames;

import java.util.HashMap;
import java.util.Map;
import org.glassfish.grizzly.Buffer;

public abstract class HeaderBlockFragment extends Http2Frame {

    public static final byte END_HEADERS = 0x4;
    
    static final Map FLAG_NAMES_MAP =
            new HashMap<>(2);
    
    static {
        FLAG_NAMES_MAP.put((int) END_HEADERS, "END_HEADERS");
    }
    
    protected Buffer compressedHeaders;


    // ---------------------------------------------------------- Public Methods


    public Buffer getCompressedHeaders() {
        return compressedHeaders;
    }

    public boolean isEndHeaders() {
        return isFlagSet(END_HEADERS);
    }    

    public Buffer takePayload() {
        final Buffer payload = compressedHeaders;
        compressedHeaders = null;
        
        return payload;
    }

    @Override
    protected Map getFlagNamesMap() {
        return FLAG_NAMES_MAP;
    }
    
    // -------------------------------------------------- Methods from Cacheable


    @Override
    public void recycle() {
        if (DONT_RECYCLE) {
            return;
        }

        compressedHeaders = null;
        super.recycle();
    }


    // ---------------------------------------------------------- Nested Classes


    public static abstract class HeaderBlockFragmentBuilder
            extends Http2FrameBuilder {

        protected Buffer compressedHeaders;


        // -------------------------------------------------------- Constructors


        protected HeaderBlockFragmentBuilder() {
        }


        // ------------------------------------------------------ Public Methods

        public T endHeaders(boolean endHeaders) {
            if (endHeaders) {
                setFlag(END_HEADERS);
            }
            return getThis();
        }


        /**
         * Sets compressed headers buffer.
         *
         * @param compressedHeaders
         * @see CompressedHeadersBuilder
         */
        @SuppressWarnings("unchecked")
        public T compressedHeaders(final Buffer compressedHeaders) {
            this.compressedHeaders = compressedHeaders;
            
            return getThis();
        }

    } // END SynStreamFrameBuilder

}