er.extensions.appserver.ajax

Class ERXAjaxApplication

java.lang.Object

com.webobjects.appserver.WOApplication

er.extensions.appserver.ajax.ERXAjaxApplication

All Implemented Interfaces:

WOApplicationMBean, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions

Direct Known Subclasses:

ERXApplication

public abstract class ERXAjaxApplication
extends WOApplication

ERXAjaxApplication is the part of ERXApplication that handles Ajax requests. If you want to use the Ajax framework without using other parts of Project Wonder (i.e. ERXSession or ERXApplication), you should steal all of the code in ERXAjaxSession, ERXAjaxApplication, and ERXAjaxContext.

ERXAjaxApplication は Ajax リクエストをサポートします。

Author:

mschrag

Properties

Name	Description
er.extensions.ERXAjaxApplication.allowContextPageResponse	er.extensions.ERXAjaxApplication.allowContextPageResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ERXAjaxApplication.ERXAjaxResponseDelegate ERXAjaxResponseDelegate receives callbacks from within the R-R loop when certain situations occur.

Nested classes/interfaces inherited from class com.webobjects.appserver.WOApplication

WOApplication._EventLoggingEnabler, WOApplication.Event, WOApplication.TimeoutTask

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_AJAX_SUBMIT_BUTTON
static String	KEY_PARTIAL_FORM_SENDER_ID
static String	KEY_REPLACED
static String	KEY_UPDATE_CONTAINER_ID

Fields inherited from class com.webobjects.appserver.WOApplication

_adminRequestHandlerKey, _cgiAdaptorURLParsed, _classPathURLs, _launchServices, _terminating, _TheLastApplicationAccessTime, _unsetHost, _wasMainInvoked, ApplicationDidDispatchRequestNotification, ApplicationDidFinishLaunchingNotification, ApplicationWillDispatchRequestNotification, ApplicationWillFinishLaunchingNotification, CGIAdaptorURLProperty, DirectoryAliasProperty, DocumentRootProperty

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Constructor Summary

Constructors

Constructor and Description
ERXAjaxApplication()

Method Summary

Modifier and Type	Method and Description
static String	ajaxSubmitButtonName(WORequest request) Returns the form name of the submitting Ajax button.
static void	cleanUpHeaders(WOResponse response) Removes Ajax response headers that are no longer necessary.
static void	enableShouldNotStorePage() Set flag on current context to not store the current page.
static boolean	forceStorePage(WOMessage message) Checks if the page should not be stored in the cache ページを強制的にキャシュに登録する必要ああるかどうかをチェックします。
WOActionResults	invokeAction(WORequest request, WOContext context) Overridden to allow for redirected responses.
static boolean	isAjaxReplacement(WORequest request) Returns true if this is an Ajax replacement (_r key is set).
static boolean	isAjaxRequest(WORequest request) Return whether or not the given request is an Ajax request.
static boolean	isAjaxSubmit(WORequest request) Returns true if this is an ajax submit.
static boolean	isAjaxUpdate(WORequest request) Returns true if this request will update an AjaxUpdateContainer.
static String	partialFormSenderID(WORequest request) Returns the form name of the partial form submission.
static void	setForceStorePage(WOMessage message) ページを強制的にキャシュに登録します。
void	setResponseDelegate(ERXAjaxApplication.ERXAjaxResponseDelegate responseDelegate) Sets the response delegate for this application.
static boolean	shouldIgnoreResults(WORequest request, WOContext context, WOActionResults results)
static boolean	shouldNotStorePage(WOContext context) Checks if the page should not be stored in the cache ページがキャッシュに登録する必要がないことをチェックします。
static boolean	shouldNotStorePage(WOMessage message) Checks if the page should not be stored in the cache キャッシュ内にページを登録しないかどうかをチェックします。
void	takeValuesFromRequest(WORequest request, WOContext context) Ajax links have a ?_u=xxx&2309482093 in the url which makes it look like a form submission to WebObjects.

Methods inherited from class com.webobjects.appserver.WOApplication

_addToExpectedLanguages, _allowsCacheControlHeader, _checksForSpecialHeaders, _componentDefinition, _componentDefinitionFromClassNamed, _debugString, _discountTerminatedSession, _expectedLanguages, _finishInitializingSession, _initializeSessionInContext, _isDebuggingEnabled, _isDomesticSupportedDevelopmentPlatform, _isForeignSupportedDevelopmentPlatform, _isPageRecreationEnabled, _isSupportedDevelopmentPlatform, _lockDefaultEditingContext, _newLocationForRequest, _openInitialURL, _parseCGIAdaptorURL, _quitTimer, _rapidTurnaroundActiveForAnyProject, _removeComponentDefinitionCacheContents, _runLoop, _sessionClass, _setAllowsCacheControlHeader, _setChecksForSpecialHeaders, _setHost, _setHostAddress, _setLifebeatDestinationPort, _setLockDefaultEditingContext, _terminateFromMonitor, _terminateOrResetTimer, activeSessionsCount, adaptor, adaptorExtensions, adaptorName, adaptorPath, adaptors, adaptorsDispatchRequestsConcurrently, adaptorWithName, additionalAdaptors, ajaxRequestHandlerKey, allowsConcurrentRequestHandling, appendToResponse, application, applicationBaseURL, applicationExtension, associationFactory, associationFactoryRegistry, autoOpenClientApplication, autoOpenInBrowser, awake, baseURL, canAccessFieldsDirectly, cgiAdaptorURL, combinedComponentPathURL, componentRequestHandlerKey, contextClassName, createContextForRequest, createDefaultAssociationFactoryRegistry, createDefaultNamespaceProvider, createRequest, createResourceManager, createResponseInContext, createSessionForRequest, debugString, defaultAdaptor, defaultRequestHandler, defaultRequestHandlerClassName, defaultUndoStackLimit, directActionRequestHandlerKey, directConnectURL, dispatchRequest, documentRoot, dynamicElementWithName, frameworksBaseURL, getAdaptorsDispatchRequestsConcurrently, getAdditionalAdaptors, getAgentID, getAllowsConcurrentRequestHandling, getApplicationBaseURL, getApplicationExtension, getAutoOpenClientApplication, getBaseURL, getCGIAdaptorURL, getClassPaths, getComponentRequestHandlerKey, getDefaultAdaptor, getDefaultUndoStackLimit, getDirectConnectURL, getFrameworkVersions, getHost, getHostAddress, getIncludeCommentsInResponses, getIsCachingEnabled, getIsMonitorEnabled, getIsPageRefreshOnBacktrackEnabled, getIsRefusingNewSessions, getIsTerminating, getJMXDomain, getLifebeatDestinationPort, getLifebeatInterval, getListenQueueSize, getMaxSocketIdleTime, getMBeanServer, getMinimumActiveSessionsCount, getName, getOutputPath, getPageCacheSize, getPageFragmentCacheSize, getPort, getServletConnectURL, getSessionTimeOut, getTimeOut, getWebObjectsVersion, getWebserverConnectURL, getWorkerThreadCountMax, getWorkerThreadCountMin, handleActionRequestError, handleException, handleMalformedCookieString, handlePageRestorationErrorInContext, handleQueryWithUnboundKey, handlerForRequest, handleSessionCreationErrorInContext, handleSessionRestorationErrorInContext, handleTakeValueForUnboundKey, host, hostAddress, includeCommentsInResponses, instanceIdKey, isCachingEnabled, isConcurrentRequestHandlingEnabled, isDebuggingEnabled, isDirectConnectEnabled, isMonitorEnabled, isPageRefreshOnBacktrackEnabled, isRefusingNewSessions, isTerminating, launchArguments, licensedRequestLimit, licensedRequestWindow, licensingAllowsMultipleInstances, licensingAllowsMultipleThreads, lifebeatDestinationPort, lifebeatEnabled, lifebeatInterval, listenQueueSize, loadFrameworks, lock, logSetValueForDeclarationNamed, logString, logTakeValueForDeclarationNamed, main, main, maxSocketIdleTime, minimumActiveSessionsCount, monitorEnabled, monitorHost, monitoringEnabled, name, namespaceProvider, newDynamicURL, newDynamicURL, number, outputPath, pageCacheSize, pageFragmentCacheSize, pageWithName, path, permanentPageCacheSize, port, primeApplication, primeApplication, printsHTMLParserDiagnostics, projectSearchPath, recordingPath, refuseNewSessions, registeredRequestHandlerKeys, registerMBean, registerMBean, registerRequestHandler, removeRequestHandlerForKey, requestHandlerForKey, requestHandlingLock, resourceManager, resourceRequestHandlerKey, responseForComponentWithName, responseForDirectActionWithNameAndClass, restoreSessionWithID, run, saveSessionForContext, servletConnectURL, sessionIdKey, sessionStore, sessionStoreClassName, sessionTimeOut, setAdaptor, setAdditionalAdaptors, setAllowsConcurrentRequestHandling, setApplicationBaseURL, setAutoOpenClientApplication, setAutoOpenInBrowser, setCachingEnabled, setCGIAdaptorURL, setComponentRequestHandlerKey, setContextClassName, setDefaultRequestHandler, setDefaultUndoStackLimit, setDirectActionRequestHandlerKey, setDirectConnectEnabled, setFrameworksBaseURL, setIncludeCommentsInResponses, setJMXDomain, setListenQueueSize, setLoadFrameworks, setMaxSocketIdleTime, setMinimumActiveSessionsCount, setMonitorEnabled, setMonitorHost, setNamespaceProvider, setPageCacheSize, setPageFragmentCacheSize, setPageRefreshOnBacktrackEnabled, setPermanentPageCacheSize, setPort, setPrintsHTMLParserDiagnostics, setProjectSearchPath, setRecordingPath, setResourceManager, setResourceRequestHandlerKey, setSessionStore, setSessionStoreClassName, setSessionTimeOut, setSMTPHost, setSocketCacheSize, setSocketMonitorSleepTime, setStatisticsStore, setTimeOut, setWebServiceRequestHandlerKey, setWorkerThreadCount, setWorkerThreadCountMax, setWorkerThreadCountMin, sharedEditingContext, shouldRestoreSessionOnCleanEntry, sleep, SMTPHost, socketCacheSize, socketMonitorSleepTime, statistics, statisticsStore, streamActionRequestHandlerKey, takeValueForKey, takeValueForKeyPath, terminate, terminateAfterTimeInterval, timeOut, toString, unableToSetNullForKey, unlock, unregisterMBean, validationFailedWithException, valueForKey, valueForKeyPath, wasMainInvoked, webserverConnectURL, webServiceRequestHandlerKey, workerThreadCount, workerThreadCountMax, workerThreadCountMin

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

KEY_AJAX_SUBMIT_BUTTON

public static final String KEY_AJAX_SUBMIT_BUTTON

See Also:

Constant Field Values

KEY_PARTIAL_FORM_SENDER_ID

public static final String KEY_PARTIAL_FORM_SENDER_ID

See Also:

Constant Field Values

KEY_UPDATE_CONTAINER_ID

public static final String KEY_UPDATE_CONTAINER_ID

See Also:

Constant Field Values

KEY_REPLACED

public static final String KEY_REPLACED

See Also:

Constant Field Values

Constructor Detail

ERXAjaxApplication

public ERXAjaxApplication()

Method Detail

setResponseDelegate

public void setResponseDelegate(ERXAjaxApplication.ERXAjaxResponseDelegate responseDelegate)

Sets the response delegate for this application.

このアプリケーションのレスポンス・デリゲートをセットします。

Parameters:

responseDelegate -

the response delegate

レスポンス・デリゲート

shouldIgnoreResults

public static boolean shouldIgnoreResults(WORequest request,
                                          WOContext context,
                                          WOActionResults results)

takeValuesFromRequest

public void takeValuesFromRequest(WORequest request,
                                  WOContext context)

Ajax links have a ?_u=xxx&2309482093 in the url which makes it look like a form submission to WebObjects. Therefore takeValues is called on every update even though many many updates aren't submits. This method checks to see if all you have is a _u or _r and an ismap (the #) param for form values. If so, it's not a form submission and takeValues can be skipped.

Overrides:

takeValuesFromRequest in class WOApplication

Parameters:

request - the current request

context - the context

See Also:

WOApplication.takeValuesFromRequest(com.webobjects.appserver.WORequest, com.webobjects.appserver.WOContext)

invokeAction

public WOActionResults invokeAction(WORequest request,
                                    WOContext context)

Overridden to allow for redirected responses.

リダイレクト・リスポンスを許可するためにオーバライドします。

Overrides:

invokeAction in class WOApplication

Parameters:

request -

WORequest

リクエスト

context -

WOContext

コンテクスト

setForceStorePage

public static void setForceStorePage(WOMessage message)

ページを強制的にキャシュに登録します。

Parameters:

message - WOMessage

forceStorePage

public static boolean forceStorePage(WOMessage message)

Checks if the page should not be stored in the cache

ページを強制的にキャシュに登録する必要ああるかどうかをチェックします。

Parameters:

message - WOMessage

Returns:

true の場合は登録する必要がある

shouldNotStorePage

public static boolean shouldNotStorePage(WOMessage message)

Checks if the page should not be stored in the cache

キャッシュ内にページを登録しないかどうかをチェックします。

Parameters:

message -

Returns:

boolean

true の場合は登録しないように

cleanUpHeaders

public static void cleanUpHeaders(WOResponse response)

Removes Ajax response headers that are no longer necessary.

必要ない Ajax リスポンス・ヘッダーを削除します。

Parameters:

response -

the response to clean up

クリーンアップするリスポンス

shouldNotStorePage

public static boolean shouldNotStorePage(WOContext context)

Checks if the page should not be stored in the cache

ページがキャッシュに登録する必要がないことをチェックします。

Parameters:

context -

Returns:

true の場合は登録しないように

enableShouldNotStorePage

public static void enableShouldNotStorePage()

Set flag on current context to not store the current page.

isAjaxRequest

public static boolean isAjaxRequest(WORequest request)

Return whether or not the given request is an Ajax request.

指定リクエストが Ajax リクエストかどうかを戻します。

Parameters:

request -

the request to check

チェックするリクエスト

Returns:

boolean

partialFormSenderID

public static String partialFormSenderID(WORequest request)

Returns the form name of the partial form submission.

部分フォーム・サブミットのフォーム名を戻します。

Parameters:

request -

the request

リクエスト

Returns:

the form name of the partial form submission

部分フォーム・サブミットのフォーム名

ajaxSubmitButtonName

public static String ajaxSubmitButtonName(WORequest request)

Returns the form name of the submitting Ajax button.

サブミット Ajax ボタンのフォーム名を戻します。

Parameters:

request -

the request

リクエスト

Returns:

the form name of the submitting Ajax button

サブミット Ajax ボタンのフォーム名

isAjaxSubmit

public static boolean isAjaxSubmit(WORequest request)

Returns true if this is an ajax submit.

Ajax サブミットの場合には true が戻ります。

Parameters:

request -

Returns:

boolean

isAjaxReplacement

public static boolean isAjaxReplacement(WORequest request)

Returns true if this is an Ajax replacement (_r key is set).

Parameters:

request - - WORequest

Returns:

boolean

isAjaxUpdate

public static boolean isAjaxUpdate(WORequest request)

Returns true if this request will update an AjaxUpdateContainer.

Parameters:

request - - WORequest

Returns:

boolean