er.extensions.appserver

Class ERXWOContext

java.lang.Object

com.webobjects.appserver.WOContext

er.extensions.appserver.ajax.ERXAjaxContext

er.extensions.appserver.ERXWOContext

All Implemented Interfaces:

NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, ERXMutableUserInfoHolderInterface, Cloneable

public class ERXWOContext
extends ERXAjaxContext
implements ERXMutableUserInfoHolderInterface

Replacement of WOContext. This subclass is installed when the frameworks loads.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ERXWOContext.Observer

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	CONTEXT_DICTIONARY_KEY
static String	CONTEXT_KEY

Fields inherited from class com.webobjects.appserver.WOContext

_pageFragementID, _session, _userInfo, EscapeQueryDictionary, SessionIDBindingKey, WOURLEncoding

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
ERXWOContext(WORequest worequest)

Method Summary

Modifier and Type	Method and Description
static NSArray<WOComponent>	_componentPath(WOContext context) Debugging help, returns the path to current component as WOComponent objects.
protected static NSMutableDictionary	_contextDictionary()
boolean	_generatingCompleteResourceURLs() Returns whether or not resources generate complete URLs.
protected String	_postprocessURL(String url)
protected void	_preprocessURL() If er.extensions.ERXWOContext.forceRemoveApplicationNumber is true, then always remove the application number from the generated URLs.
void	_setCurrentComponent(WOComponent component) Implemented so that the thread checks if it should get interrupted.
void	_setGenerateCompleteResourceURLs(boolean generateCompleteResourceURLs) Turn on complete resource URL generation.
String	_urlWithRequestHandlerKey(String requestHandlerKey, String requestHandlerPath, String queryString, boolean secure)
String	_urlWithRequestHandlerKey(String requestHandlerKey, String requestHandlerPath, String queryString, boolean isSecure, int somePort)
Object	clone()
static NSArray<String>	componentPath(WOContext context) Debugging help, returns the path to current component as a list of component names.
static NSMutableDictionary	contextDictionary()
static WOContext	currentContext()
static String	directActionUrl(WOContext context, String directActionName, Boolean secure, boolean includeSessionID) Generates direct action URLs with support for various overrides.
static String	directActionUrl(WOContext context, String host, Integer port, String path, String directActionName, NSDictionary<String,Object> queryParameters, Boolean secure, boolean includeSessionID) Generates direct action URLs with support for various overrides.
static String	directActionUrl(WOContext context, String host, Integer port, String path, String directActionName, String key, Object value, Boolean secure, boolean includeSessionID) Generates direct action URLs with support for various overrides.
static String	directActionUrl(WOContext context, String directActionName, NSDictionary<String,Object> queryParameters, Boolean secure, boolean includeSessionID) Generates direct action URLs with support for various overrides.
static String	directActionUrl(WOContext context, String directActionName, String key, String value, Boolean secure, boolean includeSessionID) Generates direct action URLs with support for various overrides.
String	directActionURLForActionNamed(String actionName, NSDictionary queryDict, boolean includeSessionID) Returns a complete URL for the specified action.
boolean	doesGenerateCompleteURLs()
<T extends ERXRequest> T	erxRequest()
WOSession	existingSession() Returns the existing session if any is given in the form values or URL.
void	generateCompleteURLs()
void	generateRelativeURLs()
boolean	hasSession() Returns true if there is an existing session.
NSMutableDictionary	mutableUserInfo() Returns the mutableUserInfo.
static ERXWOContext	newContext() Creates a WOContext using a dummy WORequest.
protected String	relativeURLWithRequestHandlerKey(String requestHandlerKey, String requestHandlerPath, String queryString)
String	safeElementID()
static String	safeIdentifierName(WOContext context, boolean willCache) Returns a safe identifier for the current component.
static void	setCurrentContext(Object object)
void	setMutableUserInfo(NSMutableDictionary userInfo) Set the mutableUserInfo
static String	stripSessionIDFromURL(String url) Removes session ID query key/value pair from the given URL string.
NSDictionary	userInfo()

Methods inherited from class er.extensions.appserver.ajax.ERXAjaxContext

_wasFormSubmitted, wasFormSubmitted

Methods inherited from class com.webobjects.appserver.WOContext

_componentActionURL, _componentName, _directActionURL, _directActionURL, _generateCompleteURLs, _generateRelativeURLs, _incrementContextID, _isMultipleSubmitForm, _languages, _originalContextID, _pageChanged, _pageComponent, _pageElement, _putAwakeComponentsToSleep, _refuseThisRequest, _removeSessionIDFromDictionary, _requestContextID, _requestSessionID, _session, _sessionIDInURL, _set_refuseThisRequest, _setActionInvoked, _setComponentName, _setFormSubmitted, _setIsMultipleSubmitForm, _setOriginalContextID, _setPageChanged, _setPageComponent, _setPageElement, _setRequest, _setRequestContextID, _setRequestSessionID, _setResponse, _setSenderID, _setSession, _setTempComponentDefinition, _setUserInfo, _stripSessionIDFromURL, _synchronizeForDistribution, _takeAwakeComponent, _tempComponentDefinition, _url, _urlForResourceNamed, _userInfo, _wasActionInvoked, appendElementIDComponent, appendZeroElementIDComponent, canAccessFieldsDirectly, completeApplicationURLPrefix, completeURLWithRequestHandlerKey, completeURLWithRequestHandlerKey, component, componentActionURL, componentActionURL, componentActionURL, computeQueryDictionary, contextID, contextWithRequest, deleteAllElementIDComponents, deleteLastElementIDComponent, directActionURLForActionNamed, directActionURLForActionNamed, directActionURLForActionNamed, directConnect, elementID, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, incrementLastElementIDComponent, isInForm, isMultipleSubmitForm, javaScriptElementID, javaScriptElementIDPrefix, javaScriptElementIDSeparator, page, pageFragementID, request, response, secureMode, secureRequest, senderID, session, sessionIDInQueryDictionary, setActionInvoked, setFormSubmitted, setInForm, setIsMultipleSubmitForm, setJavaScriptElementIDPrefix, setJavaScriptElementIDSeparator, setPageFragmentID, setSecureMode, setUserInfo, setUserInfoForKey, shouldNotStorePageInBacktrackCache, takeValueForKey, takeValueForKeyPath, toString, unableToSetNullForKey, urlWithRequestHandlerKey, userInfoForKey, valueForKey, valueForKeyPath, wasActionInvoked

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_KEY

public static final String CONTEXT_KEY

See Also:

Constant Field Values

CONTEXT_DICTIONARY_KEY

public static final String CONTEXT_DICTIONARY_KEY

See Also:

Constant Field Values

Constructor Detail

ERXWOContext

public ERXWOContext(WORequest worequest)

Method Detail

existingSession

public WOSession existingSession()

Returns the existing session if any is given in the form values or URL.

Returns:

session for this request or null

hasSession

public boolean hasSession()

Returns true if there is an existing session.

Overrides:

hasSession in class WOContext

contextDictionary

public static NSMutableDictionary contextDictionary()

currentContext

public static WOContext currentContext()

setCurrentContext

public static void setCurrentContext(Object object)

_contextDictionary

protected static NSMutableDictionary _contextDictionary()

_setCurrentComponent

public void _setCurrentComponent(WOComponent component)

Implemented so that the thread checks if it should get interrupted.

Overrides:

_setCurrentComponent in class WOContext

Parameters:

component - the current component

clone

public Object clone()

Overrides:

clone in class WOContext

_setGenerateCompleteResourceURLs

public void _setGenerateCompleteResourceURLs(boolean generateCompleteResourceURLs)

Turn on complete resource URL generation.

Parameters:

generateCompleteResourceURLs - if true, resources will generate complete URLs.

_generatingCompleteResourceURLs

public boolean _generatingCompleteResourceURLs()

Returns whether or not resources generate complete URLs.

Returns:

whether or not resources generate complete URLs

generateCompleteURLs

public void generateCompleteURLs()

Overrides:

generateCompleteURLs in class WOContext

generateRelativeURLs

public void generateRelativeURLs()

Overrides:

generateRelativeURLs in class WOContext

doesGenerateCompleteURLs

public boolean doesGenerateCompleteURLs()

Overrides:

doesGenerateCompleteURLs in class WOContext

newContext

public static ERXWOContext newContext()

Creates a WOContext using a dummy WORequest.

Returns:

the new WOContext

erxRequest

public <T extends ERXRequest> T erxRequest()

mutableUserInfo

public NSMutableDictionary mutableUserInfo()

Description copied from interface: ERXMutableUserInfoHolderInterface

Returns the mutableUserInfo.

Specified by:

mutableUserInfo in interface ERXMutableUserInfoHolderInterface

setMutableUserInfo

public void setMutableUserInfo(NSMutableDictionary userInfo)

Description copied from interface: ERXMutableUserInfoHolderInterface

Set the mutableUserInfo

Specified by:

setMutableUserInfo in interface ERXMutableUserInfoHolderInterface

userInfo

public NSDictionary userInfo()

Overrides:

userInfo in class WOContext

_preprocessURL

protected void _preprocessURL()

If er.extensions.ERXWOContext.forceRemoveApplicationNumber is true, then always remove the application number from the generated URLs. You have to be aware of how your app is written to know if this is something you can do without causing problems. For instance, you MUST be using cookies, and you must not use WOImages with data bindings -- anything that requires a per-instance cache has the potential to fail when this is enabled (if you have more than one instance of your app deployed).

_postprocessURL

protected String _postprocessURL(String url)

_urlWithRequestHandlerKey

public String _urlWithRequestHandlerKey(String requestHandlerKey,
                                        String requestHandlerPath,
                                        String queryString,
                                        boolean secure)

Overrides:

_urlWithRequestHandlerKey in class WOContext

_urlWithRequestHandlerKey

public String _urlWithRequestHandlerKey(String requestHandlerKey,
                                        String requestHandlerPath,
                                        String queryString,
                                        boolean isSecure,
                                        int somePort)

Overrides:

_urlWithRequestHandlerKey in class WOContext

directActionURLForActionNamed

public String directActionURLForActionNamed(String actionName,
                                            NSDictionary queryDict,
                                            boolean includeSessionID)

Returns a complete URL for the specified action. Works like WOContext.directActionURLForActionNamed(java.lang.String, com.webobjects.foundation.NSDictionary<java.lang.String, java.lang.Object>) but has one extra parameter to specify whether or not to include the current session ID in the URL. Convenient if you embed the link for the direct action into an email message and don't want to keep the session ID in it.

actionName can be either an action -- "ActionName" -- or an action on a class -- "ActionClass/ActionName". You can also specify queryDict to be an NSDictionary which contains form values as key/value pairs. includeSessionID indicates if you want to include the session ID in the URL.

Parameters:

actionName - String action name

queryDict - NSDictionary containing query key/value pairs

includeSessionID - true: to include the session ID (if has one),
false: not to include the session ID

Returns:

a String containing the URL for the specified action

See Also:

WODirectAction

stripSessionIDFromURL

public static String stripSessionIDFromURL(String url)

Removes session ID query key/value pair from the given URL string.

Parameters:

url - String URL

Returns:

a String with the session ID removed

componentPath

public static NSArray<String> componentPath(WOContext context)

Debugging help, returns the path to current component as a list of component names.

Parameters:

context - the current context

Returns:

an array of component names

_componentPath

public static NSArray<WOComponent> _componentPath(WOContext context)

Debugging help, returns the path to current component as WOComponent objects.

Parameters:

context - the current context

Returns:

an array of components

safeIdentifierName

public static String safeIdentifierName(WOContext context,
                                        boolean willCache)

Returns a safe identifier for the current component. If willCache is true, your component should cache the identifier name so that it does not change. In this case, your component will be given an incrementing counter value that is unique on the current page. If willCache is false (because you cannot cache the value), the identifier returned will be based on the context.elementID(). While unique on the page at any point in time, be aware that structural changes to the page can cause the elementID of your component to change.

Parameters:

context - the WOContext

willCache - if true, you should cache the resulting value in your component

Returns:

a safe identifier name

directActionUrl

public static String directActionUrl(WOContext context,
                                     String directActionName,
                                     Boolean secure,
                                     boolean includeSessionID)

Generates direct action URLs with support for various overrides.

Parameters:

context - the context to generate the URL within

directActionName - the direct action name

secure - true = https, false = http, null = same as request

includeSessionID - if false, removes session ID from query parameters

Returns:

the constructed direct action URL

directActionUrl

public static String directActionUrl(WOContext context,
                                     String directActionName,
                                     String key,
                                     String value,
                                     Boolean secure,
                                     boolean includeSessionID)

Generates direct action URLs with support for various overrides.

Parameters:

context - the context to generate the URL within

directActionName - the direct action name

key - the query parameter key to add (or null to skip)

value - the query parameter value to add (or null to skip)

secure - true = https, false = http, null = same as request

includeSessionID - if false, removes session ID from query parameters

Returns:

the constructed direct action URL

directActionUrl

public static String directActionUrl(WOContext context,
                                     String directActionName,
                                     NSDictionary<String,Object> queryParameters,
                                     Boolean secure,
                                     boolean includeSessionID)

Generates direct action URLs with support for various overrides.

Parameters:

context - the context to generate the URL within

directActionName - the direct action name

queryParameters - the query parameters to append (or null)

secure - true = https, false = http, null = same as request

includeSessionID - if false, removes session ID from query parameters

Returns:

the constructed direct action URL

directActionUrl

public static String directActionUrl(WOContext context,
                                     String host,
                                     Integer port,
                                     String path,
                                     String directActionName,
                                     String key,
                                     Object value,
                                     Boolean secure,
                                     boolean includeSessionID)

Generates direct action URLs with support for various overrides.

Parameters:

context - the context to generate the URL within

host - the host name for the URL (or null for default)

port - the port number of the URL (or null for default)

path - the custom path prefix (or null for none)

directActionName - the direct action name

key - the query parameter key to add (or null to skip)

value - the query parameter value to add (or null to skip)

secure - true = https, false = http, null = same as request

includeSessionID - if false, removes session ID from query parameters

Returns:

the constructed direct action URL

directActionUrl

public static String directActionUrl(WOContext context,
                                     String host,
                                     Integer port,
                                     String path,
                                     String directActionName,
                                     NSDictionary<String,Object> queryParameters,
                                     Boolean secure,
                                     boolean includeSessionID)

Generates direct action URLs with support for various overrides.

Parameters:

context - the context to generate the URL within

host - the host name for the URL (or null for default)

port - the port number of the URL (or null for default)

path - the custom path prefix (or null for none)

directActionName - the direct action name

queryParameters - the query parameters to append (or null)

secure - true = https, false = http, null = same as request

includeSessionID - if false, removes session ID from query parameters

Returns:

the constructed direct action URL

safeElementID

public String safeElementID()

relativeURLWithRequestHandlerKey

protected String relativeURLWithRequestHandlerKey(String requestHandlerKey,
                                                  String requestHandlerPath,
                                                  String queryString)

Overrides:

relativeURLWithRequestHandlerKey in class WOContext