ariba.util.http.multitab
Interface MultiTabHandler

All Known Implementing Classes:

AbstractMultiTabHandler, NoMultiTabSupport.ByPassHandler

public interface MultiTabHandler

Handler for Serving multi-tab request. Once the request is served then is sent for actual processing.We can see this handler a link between the MultiTabSupport and the Servletadaptor

Nested Class Summary

static class	MultiTabHandler.MultiTabException Generic MultiTabException.
static class	MultiTabHandler.RequestInfo A wrapper object that contains the data needed to process multitab request

Field Summary

static java.lang.String	AppHandlder
static java.lang.String	InspectorHandler
static java.lang.String	MultiTabExceptionMessageKey
static java.lang.String	MultiTabExceptionReportMessageKey
static java.lang.String	StringTable

Method Summary

void	handleDefault(MultiTabHandler.RequestInfo data) What should the application do by default or when tabbing is disabled?
void	handleExistingTab(MultiTabHandler.RequestInfo data) What should the application do when the request is coming from existing tab.
void	handleNewTab(MultiTabHandler.RequestInfo data) What should the application do when processing a new tab request.
void	handleTooManyTabs(MultiTabHandler.RequestInfo data) What should the application do when too many tabs error is reached?
void	initialize() Gives option to make some initialization
boolean	isTabEnabled(MultiTabHandler.RequestInfo data) Tabs are false by default, please override if your need to enable it or has more complex logic.
java.lang.String	mungeRedirectUrl(java.lang.String redirectUrl) Function that can be overridden to allow munging of the redirect url.
void	setRequestProcessor(RequestProcessor processor)
void	setServletRequest(javax.servlet.http.HttpServletRequest request) Mainly used for our factory methods which instantiates this handlers.

Field Detail

AppHandlder

static final java.lang.String AppHandlder

See Also:

Constant Field Values

InspectorHandler

static final java.lang.String InspectorHandler

See Also:

Constant Field Values

StringTable

static final java.lang.String StringTable

See Also:

Constant Field Values

MultiTabExceptionMessageKey

static final java.lang.String MultiTabExceptionMessageKey

See Also:

Constant Field Values

MultiTabExceptionReportMessageKey

static final java.lang.String MultiTabExceptionReportMessageKey

See Also:

Constant Field Values

Method Detail

isTabEnabled

boolean isTabEnabled(MultiTabHandler.RequestInfo data)

Tabs are false by default, please override if your need to enable it or has more complex logic.

Parameters:

data - Data wrapping object.

Returns:

Indicates if tab logic should run.

handleDefault

void handleDefault(MultiTabHandler.RequestInfo data)
                   throws java.io.IOException

What should the application do by default or when tabbing is disabled?

Parameters:

data - Data wrapping object.

Throws:

java.io.IOException

handleNewTab

void handleNewTab(MultiTabHandler.RequestInfo data)
                  throws java.io.IOException

What should the application do when processing a new tab request.

Parameters:

data - Data wrapping object.

Throws:

java.io.IOException

handleExistingTab

void handleExistingTab(MultiTabHandler.RequestInfo data)
                       throws java.io.IOException

What should the application do when the request is coming from existing tab. The redirectUrl will be set to the `data` before calling this function?

Parameters:

data - Data wrapping object.

Throws:

java.io.IOException

mungeRedirectUrl

java.lang.String mungeRedirectUrl(java.lang.String redirectUrl)

Function that can be overridden to allow munging of the redirect url.

Parameters:

redirectUrl - The redirect url to munge.

Returns:

The munged redirect url.

handleTooManyTabs

void handleTooManyTabs(MultiTabHandler.RequestInfo data)
                       throws java.io.IOException

What should the application do when too many tabs error is reached?

Parameters:

data - Data wrapping object.

Throws:

java.io.IOException

initialize

void initialize()

Gives option to make some initialization

setServletRequest

void setServletRequest(javax.servlet.http.HttpServletRequest request)

Mainly used for our factory methods which instantiates this handlers.

setRequestProcessor

void setRequestProcessor(RequestProcessor processor)