ariba.ui.aribaweb.core
Interface AWApplication

All Superinterfaces:

AWCooperativeMultithreadLocking, AWRequestDispatching, AWRequestLocking, AWServerApplication

All Known Implementing Classes:

AWConcreteApplication, AWDefaultApplication, AWServletApplication, AWStaticSiteGenerator.ExtendedDefaultApplication

public interface AWApplication
extends AWServerApplication

A process wide coordinator of AribaWeb processing. AWApplication (and its main concrete implementations AWConcreteServerApplication, AWConcreteApplication, and AWServletApplication provide methods links to via services (e.g. AWServerApplication.resourceManager()) and methods overridden, acts as a factory for vital objects involved in request handling (e.g. createSession(AWRequestContext), createRequestContext(AWRequest), and provides hooks to be overridden by by subclasses to affect process flow (e.g. handleSessionRestorationError(AWRequestContext).

Method Summary

int	activeHttpSessionCount()
java.lang.String	adaptorUrl()
java.lang.String	adaptorUrlSecure()
java.lang.String	applicationUrl(AWRequest request)
void	archiveHttpSession(javax.servlet.http.HttpSession httpSession)
void	assertExistingSession(AWRequestContext requestContext)
void	assertValidNode(AWRequestContext requestContext, java.lang.String directActionClassName, java.lang.String actionName)
void	assertValidSession(AWRequestContext requestContext)
void	checkinHttpSession(javax.servlet.http.HttpSession httpSession)
void	checkinHttpSessionId(java.lang.String sessionId)
void	checkoutHttpSession(javax.servlet.http.HttpSession httpSession)
void	checkoutHttpSessionId(java.lang.String sessionId)
AWComponentDefinition	componentDefinitionForName(java.lang.String componentName)
AWComponentDefinition	createComponentDefinitionForNameAndClass(java.lang.String componentName, java.lang.Class componentClass)
javax.servlet.http.HttpSession	createHttpSession(AWRequest request)
AWComponent	createPageWithName(java.lang.String componentName, AWRequestContext requestContext)
AWRequestContext	createRequestContext(AWRequest request)
AWSession	createSession(AWRequestContext requestContext)
java.util.Map	customKeyValueStats()
void	deregisterSession(AWSession session)
java.lang.String	directActionClassNameForKey(java.lang.String classNameKey)
java.lang.String	getApplicationType()
AWBrand	getBrand(AWRequestContext requestContext)
AWBrandManager	getBrandManager()
AWComponentConfigurationSource	getComponentConfigurationSource(java.lang.Class componentClass)
AWParameters	getConfigParameters()
AWNodeManager	getNodeManager()
java.lang.String	getNodeName() Returns the node name of the local server.
int	getPollInterval()
AWSessionStatusManager	getSessionStatusManager()
AWResponseGenerating	handleComponentActionSessionValidationError(AWRequestContext requestContext, java.lang.Exception exception)
AWResponseGenerating	handleException(AWRequestContext requestContext, java.lang.Exception exception)
AWResponseGenerating	handleMaxWindowException(AWRequestContext requestContext, MaximumTabExceededException exception)
AWResponseGenerating	handleRemoteHostMismatchException(AWRequestContext requestContext, AWRemoteHostMismatchException exception)
AWResponseGenerating	handleSessionRestorationError(AWRequestContext requestContext)
AWResponseGenerating	handleSessionValidationError(AWRequestContext requestContext, java.lang.Exception exception)
AWResponseGenerating	handleSiteUnavailableException(AWRequestContext requestContext)
int	hibernationDepth()
void	initiateShutdown()
boolean	isHttpSessionCheckedOut(java.lang.String sessionId)
boolean	isValidRemoteHost(AWRequest request)
void	logActionMessage(java.lang.String actionLogMessage)
AWResponseGenerating	mainPage(AWRequestContext requestContext)
java.lang.String	mainPageName()
AWResponseGenerating	monitorSessionStatsPage(AWRequestContext requestContext)
AWMonitorStats	monitorStats()
AWResponseGenerating	monitorStatsPage(AWRequestContext requestContext)
int	pageCacheSize()
java.lang.String	refuseNewSessionsPassword()
void	registerComponentConfigurationSource(java.lang.Class componentClass, AWComponentConfigurationSource source)
void	registerSession(AWSession session)
java.lang.String	resourceFilePath()
java.lang.String	resourceURL()
javax.servlet.http.HttpSession	restoreHttpSession(AWRequest request, java.lang.String sessionId)
int	sessionTimeout()
void	setPageCacheSize(int intValue)
void	setRefuseNewSessionsPassword(java.lang.String refuseNewSessionsPassword)
void	setRefusingNewSessions(boolean refusingNewSessions)
void	setSessionValidator(AWSessionValidator validator)
void	setTerminateApplicationPassword(java.lang.String terminateApplicationPassword)
void	setUseEmbeddedKeyPathes(boolean useEmbeddedKeyPathes)
void	sweepExpiredObjects()
void	terminate()
java.lang.String	terminateApplicationPassword()
void	timeoutForObject(java.lang.Object object)
boolean	useEmbeddedKeyPathes()
boolean	useServletEnginesSession()
void	validateRequest(AWRequestContext requestContext)
java.lang.String	webserverDocumentRootPath()

Methods inherited from interface ariba.ui.aribaweb.core.AWServerApplication

createRequest, createResourceManager, createResourceManager, createResponse, createResponse, createTemplateResourceManager, debugString, defaultRequestHandler, deploymentRootDirectory, flushResourceManager, getStringLocalizer, handleGarbageCollectionIssues, handleMalformedRequest, handleMalformedRequest, initIsRapidTurnaroundEnabled, initRequestHandlers, isDebuggingEnabled, isRapidTurnaroundEnabled, isStatisticsGatheringEnabled, logString, name, registerRequestHandlerForKey, requestHandlerForKey, requiresThreadSafety, resourceManager, resourceManager, setDefaultRequestHandler, setName

Methods inherited from interface ariba.ui.aribaweb.core.AWRequestDispatching

dispatchRequest

Methods inherited from interface ariba.ui.aribaweb.core.AWRequestLocking

lockRequestHandlingForRequest, unlockRequestHandlingForRequest

Methods inherited from interface ariba.ui.aribaweb.util.AWCooperativeMultithreadLocking

relockRequestHandling, temporarilyUnlockRequestHandling

Method Detail

setPageCacheSize

void setPageCacheSize(int intValue)

pageCacheSize

int pageCacheSize()

webserverDocumentRootPath

java.lang.String webserverDocumentRootPath()

resourceFilePath

java.lang.String resourceFilePath()

resourceURL

java.lang.String resourceURL()

adaptorUrl

java.lang.String adaptorUrl()

adaptorUrlSecure

java.lang.String adaptorUrlSecure()

setUseEmbeddedKeyPathes

void setUseEmbeddedKeyPathes(boolean useEmbeddedKeyPathes)

useEmbeddedKeyPathes

boolean useEmbeddedKeyPathes()

getApplicationType

java.lang.String getApplicationType()

createPageWithName

AWComponent createPageWithName(java.lang.String componentName,
                               AWRequestContext requestContext)

mainPageName

java.lang.String mainPageName()

mainPage

AWResponseGenerating mainPage(AWRequestContext requestContext)

createSession

AWSession createSession(AWRequestContext requestContext)

sessionTimeout

int sessionTimeout()

createHttpSession

javax.servlet.http.HttpSession createHttpSession(AWRequest request)

restoreHttpSession

javax.servlet.http.HttpSession restoreHttpSession(AWRequest request,
                                                  java.lang.String sessionId)

archiveHttpSession

void archiveHttpSession(javax.servlet.http.HttpSession httpSession)

checkoutHttpSessionId

void checkoutHttpSessionId(java.lang.String sessionId)

checkinHttpSessionId

void checkinHttpSessionId(java.lang.String sessionId)

isHttpSessionCheckedOut

boolean isHttpSessionCheckedOut(java.lang.String sessionId)

activeHttpSessionCount

int activeHttpSessionCount()

terminate

void terminate()

setTerminateApplicationPassword

void setTerminateApplicationPassword(java.lang.String terminateApplicationPassword)

terminateApplicationPassword

java.lang.String terminateApplicationPassword()

registerSession

void registerSession(AWSession session)

deregisterSession

void deregisterSession(AWSession session)

getSessionStatusManager

AWSessionStatusManager getSessionStatusManager()

monitorSessionStatsPage

AWResponseGenerating monitorSessionStatsPage(AWRequestContext requestContext)

createRequestContext

AWRequestContext createRequestContext(AWRequest request)

handleException

AWResponseGenerating handleException(AWRequestContext requestContext,
                                     java.lang.Exception exception)

handleSessionRestorationError

AWResponseGenerating handleSessionRestorationError(AWRequestContext requestContext)

handleSessionValidationError

AWResponseGenerating handleSessionValidationError(AWRequestContext requestContext,
                                                  java.lang.Exception exception)

handleComponentActionSessionValidationError

AWResponseGenerating handleComponentActionSessionValidationError(AWRequestContext requestContext,
                                                                 java.lang.Exception exception)

handleSiteUnavailableException

AWResponseGenerating handleSiteUnavailableException(AWRequestContext requestContext)

handleRemoteHostMismatchException

AWResponseGenerating handleRemoteHostMismatchException(AWRequestContext requestContext,
                                                       AWRemoteHostMismatchException exception)

handleMaxWindowException

AWResponseGenerating handleMaxWindowException(AWRequestContext requestContext,
                                              MaximumTabExceededException exception)

applicationUrl

java.lang.String applicationUrl(AWRequest request)

setRefusingNewSessions

void setRefusingNewSessions(boolean refusingNewSessions)

setRefuseNewSessionsPassword

void setRefuseNewSessionsPassword(java.lang.String refuseNewSessionsPassword)

refuseNewSessionsPassword

java.lang.String refuseNewSessionsPassword()

directActionClassNameForKey

java.lang.String directActionClassNameForKey(java.lang.String classNameKey)

hibernationDepth

int hibernationDepth()

createComponentDefinitionForNameAndClass

AWComponentDefinition createComponentDefinitionForNameAndClass(java.lang.String componentName,
                                                               java.lang.Class componentClass)

componentDefinitionForName

AWComponentDefinition componentDefinitionForName(java.lang.String componentName)

logActionMessage

void logActionMessage(java.lang.String actionLogMessage)

monitorStats

AWMonitorStats monitorStats()

monitorStatsPage

AWResponseGenerating monitorStatsPage(AWRequestContext requestContext)

customKeyValueStats

java.util.Map customKeyValueStats()

isValidRemoteHost

boolean isValidRemoteHost(AWRequest request)

initiateShutdown

void initiateShutdown()

setSessionValidator

void setSessionValidator(AWSessionValidator validator)

assertExistingSession

void assertExistingSession(AWRequestContext requestContext)

assertValidSession

void assertValidSession(AWRequestContext requestContext)

validateRequest

void validateRequest(AWRequestContext requestContext)

getBrandManager

AWBrandManager getBrandManager()

getBrand

AWBrand getBrand(AWRequestContext requestContext)

getNodeManager

AWNodeManager getNodeManager()

assertValidNode

void assertValidNode(AWRequestContext requestContext,
                     java.lang.String directActionClassName,
                     java.lang.String actionName)

getNodeName

java.lang.String getNodeName()

Returns the node name of the local server.

Returns:

name of the local node

registerComponentConfigurationSource

void registerComponentConfigurationSource(java.lang.Class componentClass,
                                          AWComponentConfigurationSource source)

getComponentConfigurationSource

AWComponentConfigurationSource getComponentConfigurationSource(java.lang.Class componentClass)

sweepExpiredObjects

void sweepExpiredObjects()

checkinHttpSession

void checkinHttpSession(javax.servlet.http.HttpSession httpSession)

checkoutHttpSession

void checkoutHttpSession(javax.servlet.http.HttpSession httpSession)

useServletEnginesSession

boolean useServletEnginesSession()

timeoutForObject

void timeoutForObject(java.lang.Object object)

getConfigParameters

AWParameters getConfigParameters()

getPollInterval

int getPollInterval()