001/*
002 * JGrapes Event Driven Framework
003 * Copyright (C) 2017-2018 Michael N. Lipp
004 * 
005 * This program is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Affero General Public License as published by 
007 * the Free Software Foundation; either version 3 of the License, or 
008 * (at your option) any later version.
009 * 
010 * This program is distributed in the hope that it will be useful, but 
011 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
012 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Affero General Public License along 
016 * with this program; if not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jgrapes.http;
020
021import org.jgrapes.core.ComponentFactory;
022import org.jgrapes.http.events.Request;
023
024/**
025 * A component factory that creates components with at least one
026 * handler for {@link Request} events. The kind of requests and
027 * the service(s) provided are up to the component. If created using 
028 * {@link ComponentFactory#create(org.jgrapes.core.Channel, java.util.Map)},
029 * the created component may only handle requests that start with the
030 * specified prefix.
031 */
032public interface HttpRequestHandlerFactory extends ComponentFactory {
033
034    /** The key for the prefix property. */
035    @SuppressWarnings("PMD.ConstantsInInterface")
036    String PREFIX = HttpRequestHandlerFactory.class.getName()
037        + ".PREFIX";
038}