com.barchart.http.request.ServerResponse Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2011-2013 Barchart, Inc. 
 *
 * All rights reserved. Licensed under the OSI BSD License.
 *
 * http://www.opensource.org/licenses/bsd-license.php
 */
package com.barchart.http.request;

import io.netty.channel.ChannelFuture;
import io.netty.handler.codec.http.Cookie;
import io.netty.handler.codec.http.HttpResponse;
import io.netty.handler.codec.http.HttpResponseStatus;
import io.netty.handler.codec.http.HttpVersion;

import java.io.IOException;
import java.io.OutputStream;
import java.io.Writer;
import java.nio.charset.Charset;

/**
 * Encapsulates a response to an inbound ServerRequest.
 */
public interface ServerResponse extends ServerMessage, HttpResponse {

	@Override
	HttpResponseStatus getStatus();

	@Override
	ServerResponse setStatus(HttpResponseStatus status);

	@Override
	ServerResponse setProtocolVersion(HttpVersion version);

	public boolean isChunkedEncoding();

	public void setChunkedEncoding(final boolean chunked);

	/**
	 * Send a cookie to the client.
	 */
	public void setCookie(Cookie cookie);

	/**
	 * Send a cookie to the client.
	 */
	public void setCookie(String name, String value);

	/**
	 * Set the character encoding for this response (default is UTF-8).
	 */
	public void setCharacterEncoding(String charSet);

	/**
	 * Set the character encoding for this response (default is UTF-8).
	 */
	public Charset getCharacterEncoding();

	/**
	 * Set the content-length for this response. This is set automatically by
	 * default if chunked transfer encoding is not active.
	 */
	public void setContentLength(int length);

	/**
	 * Set the response content MIME type.
	 */
	public void setContentType(String mimeType);

	/**
	 * Send a URL redirect to the client.
	 */
	public void sendRedirect(String location);

	/**
	 * Get the raw output stream for writing to the client. Note that unless
	 * chunked transfer encoding is turned on, all output will still be
	 * buffered.
	 */
	public OutputStream getOutputStream();

	/**
	 * Get a writer that writes data directly to the client. Note that unless
	 * chunked transfer encoding is turned on, all output will still be
	 * buffered.
	 */
	public Writer getWriter();

	/**
	 * Write a string to the client.
	 */
	public void write(String data) throws IOException;

	/**
	 * Write a byte stream to the client.
	 */
	public void write(byte[] data) throws IOException;

	/**
	 * Write a byte stream to the client.
	 */
	public void write(byte[] data, int offset, int length) throws IOException;

	/**
	 * Get the number of bytes written to the client for this response.
	 */
	public long writtenBytes();

	/**
	 * Flush the output buffers. Buffers are flushed automatically, and this
	 * should not usually be necessary.
	 */
	public void flush() throws IOException;

	/**
	 * Mark the request as suspended for future asynchronous responses, which
	 * prevents the framework from closing the response prematurely.
	 */
	public void suspend();

	/**
	 * Check if this response has been suspended.
	 */
	public boolean isSuspended();

	/**
	 * Mark this response as finished, and release any resources associated with
	 * it.
	 */
	public ChannelFuture finish() throws IOException;

	/**
	 * Check if this response has been finished.
	 */
	public boolean isFinished();

}