org.xsocket.connection.http.server.IHttpResponseContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xSocket-http
xSocket http extension
There is a newer version: 2.0-beta-1
/*
 *  Copyright (c) xsocket.org, 2006 - 2008. All rights reserved.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Please refer to the LGPL license at: http://www.gnu.org/copyleft/lesser.txt
 * The latest copy of this software may be found on http://www.xsocket.org/
 */
package org.xsocket.connection.http.server;

import java.io.IOException;

import org.xsocket.connection.http.BodyDataSink;
import org.xsocket.connection.http.HttpResponse;
import org.xsocket.connection.http.HttpResponseHeader;



/**
 * represents the server side endpoint of a http connection
 *
 *
 * @author [email protected]
 */
public interface IHttpResponseContext {

	public static final boolean DEFAULT_AUTOHANDLE_EXPECT_100CONTINUE_HEADER = true;


	/**
	 * send the response. If the content-length header is not set, the message will send 
	 * in chunked mode 
	 *
	 * @param header   the header
	 * @return the body handle to write
	 * @throws IOException if an exception occurs
	 */
	public BodyDataSink send(HttpResponseHeader header) throws IOException;


	/**
	 * send the response in a plain body non-blocking mode
	 *
	 * @param header         the header
	 * @param contentLength  the body content length
	 * @return the body handle to write
	 * @throws IOException if an exception occurs
	 */
	public BodyDataSink send(HttpResponseHeader header, int contentLength) throws IOException;

	
	
	/**
	 * send the response
	 *
	 * @param status   the status
	 * @throws IOException if an exception occurs
	 */
	public void send(int status) throws IOException;


	/**
	 * send the response
	 *
	 * @param response   the response
	 * @throws IOException if an exception occurs
	 */
	public void send(HttpResponse response) throws IOException;


	/**
	 * send an error response
	 *
	 * @param errorCode   the error code
	 */
	public void sendError(int errorCode);


	/**
	 * send an error response
	 *
	 * @param errorCode   the error code
	 * @param msg         the error message
	 */
	public void sendError(int errorCode, String msg);


	/**
	 * returns the id
	 *
	 * @return id
	 */
	public String getId();
	
	
	/**
	 * set the max transactions per connection. Setting this filed causes that 
	 * a keep-alive response header will be added 
	 * 
	 * @param maxTransactions  the max transactions 
	 */
	public void setMaxTransactions(int maxTransactions);
	
	
	/**
	 * set the max receive timeout which is accepted for the connection. Setting this
	 * field cases, that a keep-alive response header will be added 
	 * 
	 * @param idleTimoutMillis the idle timeout
	 */
	public void setRequestTimeoutMillis(int idleTimoutMillis);
}