com.phloc.web.servlet.response.ResponseHelper Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.phloc.web.servlet.response;

import java.io.IOException;
import java.io.OutputStream;
import java.util.zip.GZIPOutputStream;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import com.phloc.commons.GlobalDebug;
import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.annotations.PresentForCodeCoverage;
import com.phloc.web.http.AcceptEncodingHandler;
import com.phloc.web.http.AcceptEncodingList;
import com.phloc.web.http.CHTTPHeader;

/**
 * Misc. helper methods on {@link HttpServletResponse} objects.

 * Most method got deprecated by the activation of the {@link UnifiedResponse}
 * and the respective servlet and filter.
 *
 * @author Philip Helger
 */
@Immutable
public final class ResponseHelper
{
  @PresentForCodeCoverage
  @SuppressWarnings ("unused")
  private static final ResponseHelper s_aInstance = new ResponseHelper ();

  private ResponseHelper ()
  {}

  /**
   * Determine the best suitable output stream type for the given request
   * without actually modifying response data. If the request supports gzip, the
   * result is a {@link EResponseStreamType#GZIP}, if the request supports
   * deflate or compress, the result will be a
   * {@link EResponseStreamType#DEFLATE}. If none of that matches, the regular
   * value {@link EResponseStreamType#PLAIN} will be returned.
   *
   * @param aHttpRequest
   *        request
   * @return The best matching output stream type. Never null.
   * @see ResponseHelperSettings
   */
  @Nonnull
  public static EResponseStreamType getBestSuitableOutputStreamType (@Nonnull final HttpServletRequest aHttpRequest)
  {
    if (ResponseHelperSettings.isResponseCompressionEnabled ())
    {
      // Can we get resource transfer working with GZIP or deflate?
      final AcceptEncodingList aAcceptEncodings = AcceptEncodingHandler.getAcceptEncodings (aHttpRequest);

      if (ResponseHelperSettings.isResponseGzipEnabled ())
      {
        // Check if GZip is supported by the requester
        if (aAcceptEncodings.getUsedGZIPEncoding () != null)
        {
          // Use GZip
          return EResponseStreamType.GZIP;
        }
      }

      if (ResponseHelperSettings.isResponseDeflateEnabled ())
      {
        // Check if Deflate is supported by the requester
        if (aAcceptEncodings.getUsedDeflateEncoding () != null)
        {
          // Use Deflate
          return EResponseStreamType.DEFLATE;
        }
      }
    }

    // Use plain response
    return EResponseStreamType.PLAIN;
  }

  /**
   * Get the best suitable output stream for the given combination of request
   * and response. If the request supports gzip, the result is a
   * {@link GZIPOutputStream}, if the request supports deflate or compress, the
   * result will be a {@link ZipOutputStream}. If none of that matches, the
   * regular response output stream is used
   *
   * @param aHttpRequest
   *        request
   * @param aHttpResponse
   *        Response
   * @return The best matching output stream
   * @throws IOException
   *         on access to the output stream
   * @see ResponseHelperSettings
   */
  @Nonnull
  public static OutputStream getBestSuitableOutputStream (@Nonnull final HttpServletRequest aHttpRequest,
                                                          @Nonnull final HttpServletResponse aHttpResponse) throws IOException
  {
    OutputStream aOS = aHttpResponse.getOutputStream ();

    if (ResponseHelperSettings.isResponseCompressionEnabled ())
    {
      // Can we get resource transfer working with GZIP or deflate?
      final AcceptEncodingList aAcceptEncodings = AcceptEncodingHandler.getAcceptEncodings (aHttpRequest);

      // Inform caches that responses may vary according to Accept-Encoding
      aHttpResponse.setHeader (CHTTPHeader.VARY, CHTTPHeader.ACCEPT_ENCODING);
      if (GlobalDebug.isDebugMode ())
      {
        // ResponseHelper used
        aHttpResponse.setHeader ("X-P", "RH");
      }

      final String sGZipEncoding = aAcceptEncodings.getUsedGZIPEncoding ();
      if (sGZipEncoding != null && ResponseHelperSettings.isResponseGzipEnabled ())
      {
        // Use GZip
        aHttpResponse.setHeader (CHTTPHeader.CONTENT_ENCODING, sGZipEncoding);
        aOS = new GZIPOutputStream (aHttpResponse.getOutputStream ());
      }
      else
      {
        final String sDeflateEncoding = aAcceptEncodings.getUsedDeflateEncoding ();
        if (sDeflateEncoding != null && ResponseHelperSettings.isResponseDeflateEnabled ())
        {
          // Use Deflate
          aHttpResponse.setHeader (CHTTPHeader.CONTENT_ENCODING, sDeflateEncoding);
          aOS = new ZipOutputStream (aHttpResponse.getOutputStream ());
          // A dummy ZIP entry is required!
          ((ZipOutputStream) aOS).putNextEntry (new ZipEntry ("dummy name"));
        }
      }
    }

    return aOS;
  }

  public static void finishReponseOutputStream (@Nonnull final OutputStream aOS) throws IOException
  {
    ValueEnforcer.notNull (aOS, "OutputStream");

    aOS.flush ();
    aOS.close ();
  }

  public static boolean isEmptyStatusCode (final int nSC)
  {
    // 301 || 302 || 304
    return nSC == HttpServletResponse.SC_MOVED_PERMANENTLY ||
           nSC == HttpServletResponse.SC_MOVED_TEMPORARILY ||
           nSC == HttpServletResponse.SC_NOT_MODIFIED;
  }

  /**
   * Set the content length of an HTTP response. If the passed content length is
   * a valid integer, aHttpResponse.setContentLength is invoked,
   * else the HTTP header {@link CHTTPHeader#CONTENT_LENGTH} is set manually.
   *
   * @param aHttpResponse
   *        The response to set the content length to
   * @param nContentLength
   *        The content length to set
   */
  public static void setContentLength (@Nonnull final HttpServletResponse aHttpResponse,
                                       @Nonnegative final long nContentLength)
  {
    if (nContentLength < Integer.MAX_VALUE)
      aHttpResponse.setContentLength ((int) nContentLength);
    else
      aHttpResponse.setHeader (CHTTPHeader.CONTENT_LENGTH, Long.toString (nContentLength));
  }
}