01: /*******************************************************************************
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: *******************************************************************************/package org.ofbiz.webapp.event;
19:
20: import javax.servlet.http.HttpServletRequest;
21: import javax.servlet.http.HttpServletResponse;
22: import javax.servlet.ServletContext;
23:
24: /**
25: * EventHandler - Event Handler Interface
26: */
27:
28: public interface EventHandler {
29:
30: /**
31: * Initializes the handler. Since handlers use the singleton pattern this method should only be called
32: * the first time the handler is used.
33: *
34: * @param context ServletContext This may be needed by the handler in order to lookup properties or XML
35: * definition files for rendering pages or handler options.
36: * @throws EventHandlerException
37: */
38: public void init(ServletContext context)
39: throws EventHandlerException;
40:
41: /**
42: * Invoke the web event
43: *
44: *@param eventPath The path or location of this event
45: *@param eventMethod The method to invoke
46: *@param request The servlet request object
47: *@param response The servlet response object
48: *@return String Result code
49: *@throws EventHandlerException
50: */
51: public String invoke(String eventPath, String eventMethod,
52: HttpServletRequest request, HttpServletResponse response)
53: throws EventHandlerException;
54: }
|