de.hybris.platform.cockpit.session

Interface RequestHandler

All Known Implementing Classes:

AbstractRequestHandler, DefaultRequestHandler

public interface RequestHandler

Cockpit HTTP request handler. Responsible for intercepting and handling cockpit events triggered by the use of HTTP request parameters.

Makes it possible to perform cockpit actions from an external application by the use of URLs.

See Also:

RequestEventHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENTS_KEY

Method Summary

Modifier and Type	Method and Description
void	addRequestEventHandler(java.lang.String eventName, RequestEventHandler eventHandler)
UICockpitPerspective	getRequestedPerspective(java.util.Map<java.lang.String,java.lang.String[]> params)
void	handleRequest(java.util.Map<java.lang.String,java.lang.String[]> params) Called whenever a new HTTP request is received.
void	removeRequestEventHandler(java.lang.String eventName, RequestEventHandler eventHandler)
void	setRequestEventHandlers(java.util.Map<java.lang.String,java.util.List<RequestEventHandler>> eventHandlers)

Field Detail

EVENTS_KEY

static final java.lang.String EVENTS_KEY

See Also:

Constant Field Values

Method Detail

handleRequest

void handleRequest(java.util.Map<java.lang.String,java.lang.String[]> params)

Called whenever a new HTTP request is received.

Typically handles request events by calling the appropriate RequestEventHandlers registered for the event in question.

Parameters:

params - HTTP request parameters

See Also:

addRequestEventHandler(String, RequestEventHandler), setRequestEventHandlers(Map), RequestEventHandler

getRequestedPerspective

UICockpitPerspective getRequestedPerspective(java.util.Map<java.lang.String,java.lang.String[]> params)

setRequestEventHandlers

void setRequestEventHandlers(java.util.Map<java.lang.String,java.util.List<RequestEventHandler>> eventHandlers)

addRequestEventHandler

void addRequestEventHandler(java.lang.String eventName,
                            RequestEventHandler eventHandler)

removeRequestEventHandler

void removeRequestEventHandler(java.lang.String eventName,
                               RequestEventHandler eventHandler)