org.glassfish.grizzly.http.HttpTrailer Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2013 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.http;
import org.glassfish.grizzly.ThreadCache;
import org.glassfish.grizzly.http.util.Header;
import org.glassfish.grizzly.http.util.HeaderValue;
import org.glassfish.grizzly.http.util.MimeHeaders;
/**
* {@link HttpContent} message, which represents HTTP trailer message.
* Applicable only for chunked HTTP messages.
*
* @author Alexey Stashok
*/
public class HttpTrailer extends HttpContent implements MimeHeadersPacket {
private static final ThreadCache.CachedTypeIndex CACHE_IDX =
ThreadCache.obtainIndex(HttpTrailer.class, 16);
/**
* Returns true if passed {@link HttpContent} is a HttpTrailder.
*
* @param httpContent
* @return true if passed {@link HttpContent} is a HttpTrailder.
*/
public static boolean isTrailer(HttpContent httpContent) {
return HttpTrailer.class.isAssignableFrom(httpContent.getClass());
}
public static HttpTrailer create() {
return create(null);
}
public static HttpTrailer create(HttpHeader httpHeader) {
final HttpTrailer httpTrailer =
ThreadCache.takeFromCache(CACHE_IDX);
if (httpTrailer != null) {
httpTrailer.httpHeader = httpHeader;
return httpTrailer;
}
return new HttpTrailer(httpHeader);
}
/**
* Returns {@link HttpTrailer} builder.
*
* @return {@link Builder}.
*/
public static Builder builder(HttpHeader httpHeader) {
return new Builder().httpHeader(httpHeader);
}
private MimeHeaders headers;
protected HttpTrailer(HttpHeader httpHeader) {
super(httpHeader);
headers = new MimeHeaders();
}
/**
* Always true true for the trailer message.
*
* @return Always true true for the trailer message.
*/
@Override
public final boolean isLast() {
return true;
}
// -------------------- Headers --------------------
/**
* {@inheritDoc}
*/
@Override
public MimeHeaders getHeaders() {
return headers;
}
/**
* {@inheritDoc}
*/
@Override
public String getHeader(final String name) {
return headers.getHeader(name);
}
/**
* {@inheritDoc}
*/
@Override
public String getHeader(final Header header) {
return headers.getHeader(header);
}
/**
* {@inheritDoc}
*/
@Override
public void setHeader(final String name, final String value) {
if (name == null || value == null) {
return;
}
headers.setValue(name).setString(value);
}
/**
* {@inheritDoc}
*/
@Override
public void setHeader(final String name, final HeaderValue value) {
if (name == null || value == null || !value.isSet()) {
return;
}
value.serializeToDataChunk(headers.setValue(name));
}
/**
* {@inheritDoc}
*/
@Override
public void setHeader(final Header header, final String value) {
if (header == null || value == null) {
return;
}
headers.setValue(header).setString(value);
}
/**
* {@inheritDoc}
*/
@Override
public void setHeader(final Header header, final HeaderValue value) {
if (header == null || value == null || !value.isSet()) {
return;
}
value.serializeToDataChunk(headers.setValue(header));
}
/**
* {@inheritDoc}
*/
@Override
public void addHeader(final String name, final String value) {
if (name == null || value == null) {
return;
}
headers.addValue(name).setString(value);
}
/**
* {@inheritDoc}
*/
@Override
public void addHeader(final String name, final HeaderValue value) {
if (name == null || value == null || !value.isSet()) {
return;
}
value.serializeToDataChunk(headers.setValue(name));
}
/**
* {@inheritDoc}
*/
@Override
public void addHeader(final Header header, final String value) {
if (header == null || value == null) {
return;
}
headers.addValue(header).setString(value);
}
/**
* {@inheritDoc}
*/
@Override
public void addHeader(final Header header, final HeaderValue value) {
if (header == null || value == null || !value.isSet()) {
return;
}
value.serializeToDataChunk(headers.setValue(header));
}
/**
* {@inheritDoc}
*/
@Override
public boolean containsHeader(final String name) {
return headers.contains(name);
}
/**
* {@inheritDoc}
*/
@Override
public boolean containsHeader(final Header header) {
return headers.contains(header);
}
/**
* Set the mime headers.
* @param mimeHeaders {@link MimeHeaders}.
*/
protected void setHeaders(final MimeHeaders mimeHeaders) {
this.headers = mimeHeaders;
}
/**
* {@inheritDoc}
*/
@Override
protected void reset() {
this.headers.recycle();
super.reset();
}
/**
* {@inheritDoc}
*/
@Override
public void recycle() {
reset();
ThreadCache.putToCache(CACHE_IDX, this);
}
/**
* HttpTrailer message builder.
*/
public static final class Builder extends HttpContent.Builder {
private MimeHeaders mimeHeaders;
protected Builder() {
}
/**
* Set the mime headers.
*
* This method will overwrite any headers provided via
* {@link #header(String, String)} before this invocation.
*
* @param mimeHeaders {@link MimeHeaders}.
*/
public final Builder headers(MimeHeaders mimeHeaders) {
this.mimeHeaders = mimeHeaders;
return this;
}
/**
* Add the HTTP mime header.
*
* @param name the mime header name.
* @param value the mime header value.
*/
public final Builder header(String name, String value) {
if (mimeHeaders == null) {
mimeHeaders = new MimeHeaders();
}
mimeHeaders.addValue(name).setString(value);
return this;
}
/**
* Build the HttpTrailer message.
*
* @return HttpTrailer
*/
@Override
public final HttpTrailer build() {
HttpTrailer trailer = (HttpTrailer) super.build();
if (mimeHeaders != null) {
trailer.headers = mimeHeaders;
}
return trailer;
}
@Override
protected HttpContent create() {
return HttpTrailer.create();
}
}
}