com.purej.vminspect.http.HttpResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of purej-vminspect Show documentation

An easy to use, feature-rich, JMX-based and embeddable Java VM monitoring tool with a web-based user-interface

There is a newer version: 2.1.1

// Copyright (c), 2013, adopus consulting GmbH Switzerland, all rights reserved.
package com.purej.vminspect.http;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

/**
 * Encapsulates a HTTP response and decouples it from the original socket-stream or servlet-response.
 * 
 * Reasons:

 * - If there are exceptions in the middle of writing the body content, it's too late to show an error page.
 * Therefore the complete response is built in memory and if successful, it will be written to the socket output-stream/servlet-response.
 * 

 * - Http clients sometimes require the content-length to be specified in the HTML header - This is only possible if the number of bytes to
 * be written as content is known BEFORE the actual writing.
 *
 * @author Stefan Mueller
 */
public abstract class HttpResponse {
  private final Map _cookies = new HashMap(7);
  private final String _contentType;
  private final int _cacheSeconds;

  protected HttpResponse(String contentType, int cacheSeconds) {
    _contentType = contentType;
    _cacheSeconds = cacheSeconds;
  }

  /**
   * Returns the content type of this response.
   */
  public String getContentType() {
    return _contentType;
  }

  /**
   * Returns the number of seconds for this response to be cached
   * in the client-side.
   */
  public int getCacheSeconds() {
    return _cacheSeconds;
  }

  /**
   * Returns the cookies to be set.
   */
  public Map getCookies() {
    return _cookies;
  }

  /**
   * Returns the content bytes to be written to the response.
   * @throws IOException if an I/O error occurred
   */
  public abstract byte[] getContentBytes() throws IOException;
}