org.xsocket.connection.http.server.IRequestHandler 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;








/**
 * call back interface which will be notified if a new requests is received 


 * 
 * Example:
 *  * class MyRequestHandler implements IRequestHandler {
 * 
 *    public void onRequest(HttpServerConnection httpServerConnection) throws IOException {
 *
 *       Request request = httpServerConnection.readRequest();
 *       
 *       ResponseHeader response = new ResponseHeader(200, "text/plain", "requested uri=" + request.getRequestURI());
 *       httpServerConnection.send(response);
 *    }    
 * }
 *  
 * 
 *  
 * 
 * @author [email protected]
 */
public interface IRequestHandler extends IHttpHandler {
	
	public static final Execution.Mode DEFAULT_EXECUTION_MODE = Execution.Mode.MULTITHREADED;
	public static final InvokeOn.Mode DEFAULT_INVOKE_ON_MODE = InvokeOn.Mode.HEADER_RECEIVED;
	
	
	/**
	 * call back method, which will be called if a request is received 
	 * 
	 * @param httpServerConnection   the http server connection
	 * @throws IOException if an exception occurs 
	 */
	public void onRequest(HttpServerConnection httpServerConnection) throws IOException;
}