01: /******************************************************************************
02: * JBoss, a division of Red Hat *
03: * Copyright 2006, Red Hat Middleware, LLC, and individual *
04: * contributors as indicated by the @authors tag. See the *
05: * copyright.txt in the distribution for a full listing of *
06: * individual contributors. *
07: * *
08: * This is free software; you can redistribute it and/or modify it *
09: * under the terms of the GNU Lesser General Public License as *
10: * published by the Free Software Foundation; either version 2.1 of *
11: * the License, or (at your option) any later version. *
12: * *
13: * This software is distributed in the hope that it will be useful, *
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16: * Lesser General Public License for more details. *
17: * *
18: * You should have received a copy of the GNU Lesser General Public *
19: * License along with this software; if not, write to the Free *
20: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
21: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
22: ******************************************************************************/package org.jboss.portal.core.controller.command.mapper;
23:
24: import org.jboss.portal.core.controller.ControllerCommand;
25: import org.jboss.portal.core.controller.ControllerContext;
26: import org.jboss.portal.server.ServerInvocation;
27:
28: /**
29: * The <code>CommandMapper</code> interface defines a service that can map an invocation to a command and also provide a
30: * mapping from a command to an url.
31: *
32: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
33: * @version $Revision: 8786 $
34: */
35: public interface CommandFactory {
36: /**
37: * Create a command.
38: *
39: * @param controllerContext the controller context
40: * @param invocation the server invocation
41: * @param host the host
42: * @param contextPath the context path
43: * @param requestPath the request path @return the command or null if no command is recognized
44: */
45: ControllerCommand doMapping(ControllerContext controllerContext,
46: ServerInvocation invocation, String host,
47: String contextPath, String requestPath);
48: }
|