org.ofbiz.webapp.event
Class ServiceEventHandler

java.lang.Object
  org.ofbiz.webapp.event.ServiceEventHandler

All Implemented Interfaces:

EventHandler

public class ServiceEventHandler
extends java.lang.Object
implements EventHandler

ServiceEventHandler - Service Event Handler

Field Summary

static java.lang.String	ASYNC
static java.lang.String	module
static java.lang.String	SYNC

Constructor Summary

ServiceEventHandler()

Method Summary

static void	checkSecureParameter(ConfigXMLReader.RequestMap requestMap, java.util.Set<java.lang.String> urlOnlyParameterNames, java.lang.String name, HttpSession session, java.lang.String serviceName)
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

module

public static final java.lang.String module

SYNC

public static final java.lang.String SYNC

See Also:

Constant Field Values

ASYNC

public static final java.lang.String ASYNC

See Also:

Constant Field Values

Constructor Detail

ServiceEventHandler

public ServiceEventHandler()

Method Detail

init

public void init(ServletContext context)
          throws EventHandlerException

Description copied from interface: EventHandler

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

Specified by:

init in interface EventHandler

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

See Also:

org.ofbiz.webapp.event.EventHandler#init(javax.servlet.ServletContext)

invoke

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

Description copied from interface: EventHandler

Invoke the web event

Specified by:

invoke in interface EventHandler

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

See Also:

org.ofbiz.webapp.event.EventHandler#invoke(java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

checkSecureParameter

public static void checkSecureParameter(ConfigXMLReader.RequestMap requestMap,
                                        java.util.Set<java.lang.String> urlOnlyParameterNames,
                                        java.lang.String name,
                                        HttpSession session,
                                        java.lang.String serviceName)
                                 throws EventHandlerException

Throws:

EventHandlerException