org.opencms.main.I_CmsRequestHandler Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* 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.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* 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
*/
package org.opencms.main;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* Describes an OpenCms request handler.
*
* Request handlers are used for special requests to OpenCms
* that should NOT be mapped to a VFS resource.
* A request handler URI always start with /handle
and then
* one or more possible handler names as defined with the {@link #getHandlerNames()}
* method.
*
* For example, if a registerd request handler has the name "MyName"
,
* any request (in a simple setup) to /opencms/opencms/handlerMyName...
will directly be transfered
* to the {@link #handle(HttpServletRequest, HttpServletResponse, String)} method of this
* handler.
*
* In essence, the request handlers are like simplified mini-servlets that run inside OpenCms.
* Of course they are not intended as replacements for real servlets.
* In case you require sophisticated lifecycle support use a genuine servlet instead.
*
* @since 6.0.0
*/
public interface I_CmsRequestHandler {
/**
* Returns the handler name.
*
* @return the handler name
*/
String[] getHandlerNames();
/**
* Handles an OpenCms request.
*
* @param req the current request
* @param res the current response
* @param name the handler name to invoke
* @throws ServletException in case an error occurs
* @throws IOException in case an error occurs
*/
void handle(HttpServletRequest req, HttpServletResponse res, String name) throws IOException, ServletException;
}