ariba.util.http.multitab
Class AbstractMultiTabHandler

java.lang.Object
  ariba.util.http.multitab.AbstractMultiTabHandler

All Implemented Interfaces:

MultiTabHandler

Direct Known Subclasses:

NoMultiTabSupport.ByPassHandler

public abstract class AbstractMultiTabHandler
extends java.lang.Object
implements MultiTabHandler

Nested Class Summary

Nested classes/interfaces inherited from interface ariba.util.http.multitab.MultiTabHandler

MultiTabHandler.MultiTabException, MultiTabHandler.RequestInfo

Field Summary

Fields inherited from interface ariba.util.http.multitab.MultiTabHandler

AppHandlder, InspectorHandler, MultiTabExceptionMessageKey, MultiTabExceptionReportMessageKey, StringTable

Constructor Summary

AbstractMultiTabHandler()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMultiTabHandler

public AbstractMultiTabHandler()

Method Detail

initialize

public void initialize()

Description copied from interface: MultiTabHandler

Gives option to make some initialization

Specified by:

initialize in interface MultiTabHandler

setServletRequest

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

Description copied from interface: MultiTabHandler

Mainly used for our factory methods which instantiates this handlers.

Specified by:

setServletRequest in interface MultiTabHandler

setRequestProcessor

public void setRequestProcessor(RequestProcessor processor)

Specified by:

setRequestProcessor in interface MultiTabHandler

handleDefault

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

Description copied from interface: MultiTabHandler

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

Specified by:

handleDefault in interface MultiTabHandler

Parameters:

data - Data wrapping object.

Throws:

java.io.IOException

isTabEnabled

public boolean isTabEnabled(MultiTabHandler.RequestInfo data)

Description copied from interface: MultiTabHandler

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

Specified by:

isTabEnabled in interface MultiTabHandler

Parameters:

data - Data wrapping object.

Returns:

Indicates if tab logic should run.

handleNewTab

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

Description copied from interface: MultiTabHandler

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

Specified by:

handleNewTab in interface MultiTabHandler

Parameters:

data - Data wrapping object.

Throws:

java.io.IOException

handleExistingTab

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

Description copied from interface: MultiTabHandler

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?

Specified by:

handleExistingTab in interface MultiTabHandler

Parameters:

data - Data wrapping object.

Throws:

java.io.IOException

mungeRedirectUrl

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

Description copied from interface: MultiTabHandler

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

Specified by:

mungeRedirectUrl in interface MultiTabHandler

Parameters:

redirectUrl - The redirect url to munge.

Returns:

The munged redirect url.

handleTooManyTabs

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

Description copied from interface: MultiTabHandler

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

Specified by:

handleTooManyTabs in interface MultiTabHandler

Parameters:

data - Data wrapping object.

Throws:

java.io.IOException