org.xsocket.connection.http.server.IHttpRequestHandler 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.Execution;
import org.xsocket.connection.http.IHttpHandler;
import org.xsocket.connection.http.InvokeOn;
import org.xsocket.connection.http.HttpRequest;








/**
 * call back interface which will be notified if a new requests is received
 *
 *
 *
 * @author [email protected]
 */
public interface IHttpRequestHandler extends IHttpHandler {

	public static final int DEFAULT_EXECUTION_MODE = Execution.MULTITHREADED;
	public static final int DEFAULT_INVOKE_ON_MODE = InvokeOn.HEADER_RECEIVED;


	/**
	 * call back method, which will be called if a request message (header) is received
	 * 
	 * @param request           the request 
	 * @param responseContext   the response context
	 * @throws IOException if an exception occurred. By throwing this exception an error http response message 
	 *                     will be sent by xSocket, if one or more requests are unanswered. The underlying 
	 *                     connection will be closed
	 */
	public void onRequest(HttpRequest request, IHttpResponseContext responseContext) throws IOException;
}