ariba.ui.servletadaptor
Class AWServletApplication

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWConcreteServerApplication
          ariba.ui.aribaweb.core.AWConcreteApplication
              ariba.ui.servletadaptor.AWServletApplication

All Implemented Interfaces:

AWApplication, AWRequestDispatching, AWRequestLocking, AWServerApplication, AWCooperativeMultithreadLocking, AWLogHandling, AWObject, AWResourceManagerFactory, ShutdownDelayer

public class AWServletApplication
extends AWConcreteApplication

An AWApplication for javax.servlet-based applications. By default will serve resources from WAR files. AWServletApplications use AWServletRequest for requests and AWServletResponse for responses.

Nested Class Summary

static class

AWServletApplication.DefaultDirectAction

Nested classes/interfaces inherited from class ariba.ui.aribaweb.core.AWConcreteApplication

AWConcreteApplication.ComponentDefinitionResolver, AWConcreteApplication.DidInitCallback, AWConcreteApplication.RequestURLInfo, AWConcreteApplication.SessionWrapper

Field Summary

java.lang.String

cleardotUrl

Fields inherited from class ariba.ui.aribaweb.core.AWConcreteApplication

AllowGlidEnhancementsFlag, ComponentActionRequestHandlerKey, DefaultAWLStringsSuffix, DefaultComponentClass, DefaultJavaStringsSuffix, DefaultPackageStringsSuffix, DirectActionRequestHandlerKey, IsActionLoggingEnabled, IsCookieSessionTrackingEnabled, IsDirectConnectEnabled, IsNotificationEnabled, IsRequestLoggingEnabled, IsResponseLoggingEnabled, IsSessionManagementEnabled, IsTemplateValidationDefaultVisible, RemoteHostMask, RetryKey, SAFE_ATTRS_FILE, SAFE_TAGS_FILE, StrictTagNamingFlag, TemplateValidationFlag, UseServletEnginesSession

Fields inherited from class ariba.ui.aribaweb.core.AWConcreteServerApplication

AllowsConcurrentRequestHandling, IsAutomationPageTitleTestModeEnabled, IsAutomationTestModeEnabled, IsDebuggingEnabled, IsJarApplication, IsRapidTurnaroundEnabled, IsStatisticsGatheringEnabled, IsVerboseMode, ResourceManagerFlushThreshold, SharedInstance

Fields inherited from class ariba.ui.aribaweb.util.AWBaseObject

AribaHashtableClass, AribaVectorClass, ClassClass, EmptyHashtable, EmptyMap, EmptyVector, False, IntegerClass, JavaHashtableClass, JavaMapClass, JavaVectorClass, LogHandling, NullObject, ObjectClass, StringClass, True, UndefinedObject, UndefinedString, UninitializedRealNumber

Constructor Summary

AWServletApplication()

Method Summary

boolean	allowsConcurrentRequestHandling()
java.lang.String	applicationNameSuffix()
java.lang.String	applicationUrl(AWRequest request)
AWRequest	createRequest(java.lang.Object servletRequest)
AWMultiLocaleResourceManager	createResourceManager()
AWResponse	createResponse()
java.lang.String	deploymentRootDirectory()
java.lang.String	directActionClassNameForKey(java.lang.String classNameKey)
java.lang.String	fullUrlPrefix()
java.lang.String	getLocalizedString(java.lang.String className, java.lang.String key, java.lang.String defaultString, java.util.Locale locale) implement LocalizedJavaString.Localizer interface
AWStringLocalizer	getStringLocalizer()
void	init()
void	initAdaptorUrl(javax.servlet.http.HttpServletRequest servletRequest) This is called by our DispatcherServlet on every request.
static void	initializeServletConfig(javax.servlet.ServletConfig servletConfig)
boolean	initIsStatisticsGatheringEnabled()
void	initSessionValidator()
AWResponseGenerating	monitorStatsPage(AWRequestContext requestContext)
java.lang.String	name()
void	registerRequestHandlerForKey(AWRequestHandler requestHandler, java.lang.String requestHandlerKey)
AWConcreteApplication.RequestURLInfo	requestUrlInfo(java.lang.String urlString) Parses the RequestURLInfo out from urlString and returns it.
java.lang.String	resourceFilePath()
java.lang.String	resourceUrl() This is somewhat temporary and is added for the benefit of the ariba.ui.validation package.
java.lang.String	resourceURL()
java.lang.String	servletUrlPrefix() Returns a string representing the part before the servlet name in request URLs.
int	servletUrlPrefixComponentCount() Returns the number of "component parts" in the servletUrlPrefix().
void	setCleardotUrl(java.lang.String cleardotUrlString)
static AWServerApplication	sharedInstance()
boolean	useServletEnginesSession()
java.lang.String	webserverDocumentRootPath()

Methods inherited from class ariba.ui.aribaweb.core.AWConcreteApplication

_componentDefinitionForName, _componentDefinitionResolver, _setComponentDefinitionResolver, activeHttpSessionCount, adaptorUrl, adaptorUrlSecure, allowBrandingImages, allowsJavascriptUrls, allowsStyleSheetUrls, appendGenericExceptionMessageToResponse, archiveHttpSession, assertExistingSession, assertValidNode, assertValidSession, canCacheResourceUrls, cancelShutdown, canShutdown, checkinHttpSession, checkinHttpSessionId, checkoutHttpSession, checkoutHttpSessionId, componentDefinitionForName, createApplication, createBookmarker, createComponentDefinitionForNameAndClass, createHttpSession, createMonitorStats, createPageWithName, createRequestContext, createSession, customKeyValueStats, defaultApplication, deregisterSession, didCompleteInit, disablePackageLevelFlag, dispatchRequest, enablePackageLevelFlag, formatUrlForResource, getAllComponentDefinitions, getApplicationType, getBookmarker, getBrand, getBrandManager, getComponentConfigurationSource, getConfigParameters, getNodeManager, getNodeName, getPollInterval, getPreferredTimezones, getSessionStatusManager, getStaticizer, getTimeZoneByOffsetKeys, getUISessionCount, getUISessionCountBuckets, getUISessionStatusBuckets, handleComponentActionSessionValidationError, handleException, handleExceptionPage, handleMaxWindowException, handleRemoteHostMismatchException, handleSessionRestorationError, handleSessionRestorationErrorPage, handleSessionValidationError, handleSiteUnavailableException, hibernationDepth, httpSessionCheckoutManager, incrementMarkedForTerminationSessionCount, initiateShutdown, initRequestHandlers, isHttpSessionCheckedOut, isPackageLevelFlagEnabled, isValidRemoteHost, logActionMessage, logRequestMessage, logResponseMessage, mainPage, mainPageName, monitorSessionStatsPage, monitorStats, pageCacheSize, preinstantiateAllComponents, preloadAllTemplates, refuseNewSessionsPassword, registerApplicationType, registerComponentConfigurationSource, registerDidInitCallback, registerSession, restoreHttpSession, sessionTimeout, setMainPageName, setPageCacheSize, setRefuseNewSessionsPassword, setRefusingNewSessions, setSessionTimeout, setSessionValidator, setStaticizer, setTerminateApplicationPassword, setUseEmbeddedKeyPathes, sweepExpiredObjects, terminate, terminateApplicationPassword, timeoutForObject, useEmbeddedKeyPathes, validateRequest

Methods inherited from class ariba.ui.aribaweb.core.AWConcreteServerApplication

_debugSearchPaths, createResourceManager, createResponse, createTemplateResourceManager, debugString, defaultPerformanceCheck, defaultRequestHandler, flushResourceManager, getAribaUserCommunityUrl, getFoldInSituWindowSize, handleGarbageCollectionIssues, handleMalformedRequest, handleMalformedRequest, initializeForJarApplication, initIsRapidTurnaroundEnabled, initResourceUrl, isDebuggingEnabled, isRapidTurnaroundEnabled, isStateValidationEnabled, isStatisticsGatheringEnabled, isUserCommunityEnabled, lockRequestHandlingForRequest, logString, registerDebugSearchPath, relockRequestHandling, requestHandlerForKey, requiresThreadSafety, resourceManager, resourceManager, setDefaultRequestHandler, setName, setSharedInstance, temporarilyUnlockRequestHandling, unlockRequestHandlingForRequest

Methods inherited from class ariba.ui.aribaweb.util.AWBaseObject

ensureFieldValuesClear, getFieldValue, isKindOfClass, localizedJavaString, logWarning, setFieldValue

Methods inherited from class java.lang.Object

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

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

createResourceManager, createResponse, createTemplateResourceManager, debugString, defaultRequestHandler, flushResourceManager, handleGarbageCollectionIssues, handleMalformedRequest, handleMalformedRequest, initIsRapidTurnaroundEnabled, isDebuggingEnabled, isRapidTurnaroundEnabled, isStatisticsGatheringEnabled, logString, requestHandlerForKey, requiresThreadSafety, resourceManager, resourceManager, setDefaultRequestHandler, setName

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

lockRequestHandlingForRequest, unlockRequestHandlingForRequest

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

relockRequestHandling, temporarilyUnlockRequestHandling

Field Detail

cleardotUrl

public java.lang.String cleardotUrl

Constructor Detail

AWServletApplication

public AWServletApplication()

Method Detail

init

public void init()

Specified by:

init in interface AWObject

Overrides:

init in class AWConcreteApplication

initializeServletConfig

public static void initializeServletConfig(javax.servlet.ServletConfig servletConfig)

sharedInstance

public static AWServerApplication sharedInstance()

initAdaptorUrl

public void initAdaptorUrl(javax.servlet.http.HttpServletRequest servletRequest)

This is called by our DispatcherServlet on every request. The first time we use the request to determine our URL prefix (which we subsequently use when constructing DirectAction URLs).

initIsStatisticsGatheringEnabled

public boolean initIsStatisticsGatheringEnabled()

Specified by:

initIsStatisticsGatheringEnabled in class AWConcreteServerApplication

allowsConcurrentRequestHandling

public boolean allowsConcurrentRequestHandling()

Overrides:

allowsConcurrentRequestHandling in class AWConcreteServerApplication

name

public java.lang.String name()

Specified by:

name in interface AWServerApplication

Overrides:

name in class AWConcreteServerApplication

fullUrlPrefix

public java.lang.String fullUrlPrefix()

resourceUrl

public java.lang.String resourceUrl()

Description copied from class: AWConcreteServerApplication

This is somewhat temporary and is added for the benefit of the ariba.ui.validation package. At some point we will rationalize all of this and this may go away.

Overrides:

resourceUrl in class AWConcreteServerApplication

resourceURL

public java.lang.String resourceURL()

resourceFilePath

public java.lang.String resourceFilePath()

deploymentRootDirectory

public java.lang.String deploymentRootDirectory()

Specified by:

deploymentRootDirectory in interface AWServerApplication

Overrides:

deploymentRootDirectory in class AWConcreteServerApplication

useServletEnginesSession

public boolean useServletEnginesSession()

Specified by:

useServletEnginesSession in interface AWApplication

Overrides:

useServletEnginesSession in class AWConcreteApplication

getStringLocalizer

public AWStringLocalizer getStringLocalizer()

getLocalizedString

public java.lang.String getLocalizedString(java.lang.String className,
                                           java.lang.String key,
                                           java.lang.String defaultString,
                                           java.util.Locale locale)

implement LocalizedJavaString.Localizer interface

createResourceManager

public AWMultiLocaleResourceManager createResourceManager()

Specified by:

createResourceManager in interface AWServerApplication

Specified by:

createResourceManager in class AWConcreteServerApplication

createRequest

public AWRequest createRequest(java.lang.Object servletRequest)

Specified by:

createRequest in interface AWServerApplication

Specified by:

createRequest in class AWConcreteServerApplication

createResponse

public AWResponse createResponse()

Specified by:

createResponse in interface AWServerApplication

Specified by:

createResponse in class AWConcreteServerApplication

servletUrlPrefixComponentCount

public int servletUrlPrefixComponentCount()

Returns the number of "component parts" in the servletUrlPrefix(). This turns out to be the number of path parts in the web app name. E.g. if the web app name is "Buyer", this method will return 1. If it's "foo/bar", it will return 2.

Returns:

the number of component parts in the web app name

servletUrlPrefix

public java.lang.String servletUrlPrefix()

Returns a string representing the part before the servlet name in request URLs. This turns out to be the web app name with a leading slash.

Returns:

a string of the following form: "/{web-app-name}"

applicationNameSuffix

public java.lang.String applicationNameSuffix()

requestUrlInfo

public AWConcreteApplication.RequestURLInfo requestUrlInfo(java.lang.String urlString)

Parses the RequestURLInfo out from urlString and returns it.

Overrides:

requestUrlInfo in class AWConcreteApplication

Parameters:

urlString - the "path" part of the URI, not including request params. Doesn't include the protocol and hostname. E.g. usually looks like one of the following: /{web-app-name}/{servlet-name}/{request-handler-key}/{extra-stuff} /{web-app-name}/{servlet-name}/{tab-index}/{request-handler-key}/{extra-stuff}

Returns:

registerRequestHandlerForKey

public void registerRequestHandlerForKey(AWRequestHandler requestHandler,
                                         java.lang.String requestHandlerKey)

Specified by:

registerRequestHandlerForKey in interface AWServerApplication

Overrides:

registerRequestHandlerForKey in class AWConcreteServerApplication

webserverDocumentRootPath

public java.lang.String webserverDocumentRootPath()

Specified by:

webserverDocumentRootPath in interface AWApplication

Specified by:

webserverDocumentRootPath in class AWConcreteApplication

applicationUrl

public java.lang.String applicationUrl(AWRequest request)

Specified by:

applicationUrl in interface AWApplication

Specified by:

applicationUrl in class AWConcreteApplication

setCleardotUrl

public void setCleardotUrl(java.lang.String cleardotUrlString)

monitorStatsPage

public AWResponseGenerating monitorStatsPage(AWRequestContext requestContext)

initSessionValidator

public void initSessionValidator()

Overrides:

initSessionValidator in class AWConcreteApplication

directActionClassNameForKey

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

Specified by:

directActionClassNameForKey in interface AWApplication

Overrides:

directActionClassNameForKey in class AWConcreteApplication