org.ofbiz.webapp.event
Interface EventHandler

All Known Implementing Classes:

AbstractJSONEventHandler, BsfEventHandler, DojoJSONServiceEventHandler, GroovyEventHandler, JavaEventHandler, JSONJavaEventHandler, JSONServiceEventHandler, JSONSimpleEventHandler, RomeEventHandler, ServiceEventHandler, ServiceMultiEventHandler, ServiceStreamHandler, SimpleEventHandler, SOAPEventHandler, WfsEventHandler, XmlRpcEventHandler

public interface EventHandler

EventHandler - Event Handler Interface

Method Summary

void	init(ServletContext context) Initializes the handler.
java.lang.String	invoke(ConfigXMLReader.Event event, ConfigXMLReader.RequestMap requestMap, HttpServletRequest request, HttpServletResponse response) Invoke the web event

Method Detail

init

void init(ServletContext context)
          throws EventHandlerException

Initializes the handler. Since handlers use the singleton pattern this method should only be called the first time the handler is used.

Parameters:

context - ServletContext This may be needed by the handler in order to lookup properties or XML definition files for rendering pages or handler options.

Throws:

EventHandlerException

invoke

java.lang.String invoke(ConfigXMLReader.Event event,
                        ConfigXMLReader.RequestMap requestMap,
                        HttpServletRequest request,
                        HttpServletResponse response)
                        throws EventHandlerException

Invoke the web event

Parameters:

event - Contains information about what to execute

requestMap - Contains information about the request-map the event was called from

request - The servlet request object

response - The servlet response object

Returns:

String Result code

Throws:

EventHandlerException