er.extensions.appserver

Class ERXRequest

java.lang.Object

com.webobjects.appserver.WOMessage

com.webobjects.appserver.WORequest

er.extensions.appserver.ERXRequest

All Implemented Interfaces:

com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, Cloneable

public class ERXRequest
extends com.webobjects.appserver.WORequest

Subclass of WORequest that fixes several Bugs. The ID's are #2924761 and #2961017. It can also be extended to handle #2957558 ("de-at" is converted to "German" instead of "German_Austria"). The request is created via ERXApplication.createRequest(String, String, String, Map, NSData, Map).

Nested Class Summary

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

com.webobjects.foundation.NSKeyValueCodingAdditions.DefaultImplementation, com.webobjects.foundation.NSKeyValueCodingAdditions.Utility

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ERXBrowser	_browser holds a reference to the browser object
protected NSArray<String>	_browserLanguages NSArray to keep browserLanguages in.
protected NSDictionary<String,NSArray<String>>	_cookieDictionary Holds the cookies in a NSDictionary.
protected boolean	_secureDisabled Specifies whether https should be overridden to be enabled or disabled app-wide.
protected static NSArray<String>	HOST_ADDRESS_KEYS
protected static NSArray<String>	HOST_NAME_KEYS
protected static Boolean	isBrowserFormValueEncodingOverrideEnabled
static String	UNKNOWN_HOST
static String	X_FORWARDED_PROTO_FOR_SSL
static String	X_FORWARDED_PROTO_HEADER_KEY_FOR_SSL

Fields inherited from class com.webobjects.appserver.WORequest

_finishedParsingMultipartFormData, _firstFormValueInvocation, _formValues, _IsmapCoords, _legacyMultipart, _method, _multipartIterator, _uri, ApplicationInstanceKey, ContextIDKey, DataKey, InstanceKey, PageNameKey, SenderIDKey, ServerPortHeader, ServerPortHeaderX, ServerPortSecureValue, SessionIDKey, SingleInstanceID, SingleInstanceIDString

Fields inherited from class com.webobjects.appserver.WOMessage

_content, _contentData, _contentEncoding, _cookies, _headerEncoding, _httpHeaders, _httpVersion, _storePageInBacktrackCache, _TheCookieKey, _TheSetCookieKey, _userInfo, HTTP_STATUS_FORBIDDEN, HTTP_STATUS_FOUND, HTTP_STATUS_INTERNAL_ERROR, HTTP_STATUS_MOVED_PERMANENTLY, HTTP_STATUS_NO_CONTENT, HTTP_STATUS_NOT_FOUND, HTTP_STATUS_OK, map, TheDefaultResponseEncoding

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
ERXRequest(String aMethod, String aURL, String anHTTPVersion, Map someHeaders, com.webobjects.foundation.NSData aContent, Map aUserInfoDictionary) Returns a ERXRequest object initialized with the specified parameters.

Method Summary

Modifier and Type	Method and Description
void	_completeURLPrefix(StringBuffer stringbuffer) Add the protocol, server and port parts of this request to a StringBuffer.
void	_completeURLPrefix(StringBuffer stringbuffer, boolean secure, int port) Add the protocol, server and port parts to a StringBuffer to build an URL to this app.
protected String	_getSessionIDFromValuesOrCookie(boolean inCookiesFirst) Overridden because the super implementation would pull in all content even if the request is supposed to be streaming and thus very large.
static boolean	_isSecureDisabled() Returns true if er.extensions.ERXRequest.secureDisabled is true.
String	_serverName() This method is used by WOContext when generating full URLs for form actions in secure mode, etc.
ERXBrowser	browser() Gets the ERXBrowser associated with the user-agent of the request.
NSArray<String>	browserLanguages() Returns a cooked version of the languages the user has set in his Browser.
com.webobjects.appserver.WOContext	context()
NSDictionary	cookieValues() Overridden to call _cookieDictionary() where we parse the cookies one at a time using java.net.HttpCookie so that we don't get an empty cookie dictionary if one cookie is malformed.
com.webobjects.foundation.NSTimestamp	dateFormValueForKey(String aKey, SimpleDateFormat dateFormatter)
void	finalize() Cleaning up retain count on the browser.
protected NSArray<String>	fixAbbreviationArray(NSArray<String> languages) Translates ("de", "en-us;q=0.33", "en", "en-gb;q=0.66") to ("de", "en_gb", "en-us", "en").
boolean	isBrowserFormValueEncodingOverrideEnabled()
static boolean	isRequestSecure(com.webobjects.appserver.WORequest request) Returns whether or not the given request is secure.
boolean	isSecure() Returns whether or not this request is secure.
boolean	isSecureDisabled() Returns true if er.extensions.ERXRequest.secureDisabled is true.
boolean	isSessionIDInRequest() Overridden because the super implementation would pull in all content even if the request is supposed to be streaming and thus very large.
NSMutableDictionary<String,Object>	mutableUserInfo()
String	remoteHostAddress() Returns the remote client host address.
String	remoteHostName() Returns the remote client host name.
void	setCredentials(String userName, String password) Utility method to set credentials for basic authorization.
String	stringFormValueForKey(String key)

Methods inherited from class com.webobjects.appserver.WORequest

_acceptingAddress, _acceptingPort, _contentLengthHeader, _context, _formValueKeyEnumerator, _formValues, _hasFormValues, _lookForIDsInCookiesFirst, _multipartIterator, _originatingAddress, _originatingPort, _remoteAddress, _serverPort, _setAcceptingAddress, _setAcceptingPort, _setApplicationNumber, _setContext, _setIsUsingWebServer, _setOriginatingAdaptor, _setOriginatingAddress, _setOriginatingPort, _uriDecomposed, adaptorPrefix, ajaxFormSubmitKey, applicationName, applicationNumber, applicationURLPrefix, clone, contentInputStream, contentType, cookies, cookieValueForKey, cookieValuesForKey, dateFormValueForKey, defaultFormValueEncoding, detectFormValuesEncoding, formValueEncoding, formValueForKey, formValueKeys, formValues, formValuesForKey, getFormValuesFromMultipartFormData, getFormValuesFromURLEncoding, isAjaxSubmit, isFormValueEncodingDetectionEnabled, isFromClientComponent, isMultipartFormData, isRequestFromFormSubmission, isUsingWebServer, isWhitespaceOrNull, method, multipartIterator, numericFormValueForKey, originatingAdaptor, queryString, removeCRLF, requestHandlerKey, requestHandlerPath, requestHandlerPathArray, sessionID, setAjaxFormSubmitKey, setContext, setDefaultFormValueEncoding, setFormValueEncoding, setFormValueEncodingDetectionEnabled, toString, uri, useLegacyMultipart

Methods inherited from class com.webobjects.appserver.WOMessage

_appendContentAsciiString, _contentLength, _finalizeCookies, _initCookies, _setHeaders, _stringByEscapingString, addCookie, appendContentCharacter, appendContentData, appendContentDOMDocumentFragment, appendContentHTMLAttributeValue, appendContentHTMLString, appendContentString, appendHeader, appendHeaders, canAccessFieldsDirectly, content, contentAsDOMDocument, contentEncoding, contentString, defaultEncoding, defaultHeaderEncoding, defaultURLEncoding, equals, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasHeaderForKey, headerForKey, headerForKey, headerKeys, headers, headersForKey, httpVersion, removeCookie, removeHeadersForKey, requiresHTMLEscaping, setContent, setContent, setContent, setContent, setContentDOMDocument, setContentEncoding, setDefaultEncoding, setDefaultHeaderEncoding, setDefaultURLEncoding, setHeader, setHeaders, setHeaders, setHTTPVersion, setStorePageInBacktrackCache, setUserInfo, setUserInfoForKey, storePageInBacktrackCache, stringByEscapingHTMLAttributeValue, stringByEscapingHTMLString, takeValueForKey, takeValueForKeyPath, unableToSetNullForKey, userInfo, userInfoForKey, valueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN_HOST

public static final String UNKNOWN_HOST

See Also:

Constant Field Values

X_FORWARDED_PROTO_FOR_SSL

public static final String X_FORWARDED_PROTO_FOR_SSL

X_FORWARDED_PROTO_HEADER_KEY_FOR_SSL

public static final String X_FORWARDED_PROTO_HEADER_KEY_FOR_SSL

isBrowserFormValueEncodingOverrideEnabled

protected static Boolean isBrowserFormValueEncodingOverrideEnabled

HOST_ADDRESS_KEYS

protected static final NSArray<String> HOST_ADDRESS_KEYS

HOST_NAME_KEYS

protected static final NSArray<String> HOST_NAME_KEYS

_browserLanguages

protected NSArray<String> _browserLanguages

NSArray to keep browserLanguages in.

_browser

protected ERXBrowser _browser

holds a reference to the browser object

_secureDisabled

protected boolean _secureDisabled

Specifies whether https should be overridden to be enabled or disabled app-wide. This is useful if you are developing with DirectConnect and you want to be able to specify secure forms and links, but you want to be able to continue testing them without setting up SSL. Defaults to false, set er.extensions.ERXRequest.secureDisabled=true to turn it off.

_cookieDictionary

protected NSDictionary<String,NSArray<String>> _cookieDictionary

Holds the cookies in a NSDictionary.

Constructor Detail

ERXRequest

public ERXRequest(String aMethod,
                  String aURL,
                  String anHTTPVersion,
                  Map someHeaders,
                  com.webobjects.foundation.NSData aContent,
                  Map aUserInfoDictionary)

Returns a ERXRequest object initialized with the specified parameters.

Parameters:

aMethod - a "GET", "POST" or "HEAD", may not be null. If null, or not one of the allowed methods, an IllegalArgumentException will be thrown

aURL - a URL, may not be null or an IllegalArgumentException will be thrown

anHTTPVersion - the version of HTTP used when sending the message, may not be null or an IllegalArgumentException will be thrown

someHeaders - a dictionary whose String keys correspond to header names and whose values are arrays of one or more strings corresponding to the values of each header

aContent - the HTML content

aUserInfoDictionary - java.util.Map that contains any information that the WORequest object wants to pass along to other objects

Method Detail

_serverName

public String _serverName()

This method is used by WOContext when generating full URLs for form actions in secure mode, etc. Overriding this because WORequest checks 'server_name' before 'Host' by default and it does not cut it for generating full secure urls in the case of a hostname that uses a wildcard SSL certificate allowing infinite secure subdomains. For example, if we have a wildcard ssl cert for https://*.mydomain.com (where * = wildcard subdomain), and we use subdomains to implement CSS skinning for different customers that are all using the same WO app while using subdomains to get their "custom" site, with host names such as acmesandwiches.mydomain.com, apple.mydomain.com, kfc.mydomain.com, etc., and we configure apache with one virtual host config for *.mydomain.com, then the stupid 'server_name' header will return *.mydomain.com INSTEAD OF the host name used in the request URL, and thus all https urls in forms, links etc will be broken.

Overrides:

_serverName in class com.webobjects.appserver.WORequest

Returns:

the server name, which happens to be used by WOContext for generating full URLs.

See Also:

WORequest._serverName(), WOContext.completeURLWithRequestHandlerKey(String, String, String, String, boolean, int), WORequest._completeURLPrefix(StringBuffer, boolean, int)

_isSecureDisabled

public static boolean _isSecureDisabled()

Returns true if er.extensions.ERXRequest.secureDisabled is true. Defaults to false.

Returns:

true if er.extensions.ERXRequest.secureDisabled is true

isSecureDisabled

public boolean isSecureDisabled()

Returns true if er.extensions.ERXRequest.secureDisabled is true.

Returns:

true if er.extensions.ERXRequest.secureDisabled is true

isBrowserFormValueEncodingOverrideEnabled

public boolean isBrowserFormValueEncodingOverrideEnabled()

context

public com.webobjects.appserver.WOContext context()

Overrides:

context in class com.webobjects.appserver.WORequest

browserLanguages

public NSArray<String> browserLanguages()

Returns a cooked version of the languages the user has set in his Browser. Adds "Nonlocalized" and ERXLocalizer.defaultLanguage() if not already present. Transforms regionalized en_us to English_US as a key.

Overrides:

browserLanguages in class com.webobjects.appserver.WORequest

Returns:

cooked version of user's languages

stringFormValueForKey

public String stringFormValueForKey(String key)

Overrides:

stringFormValueForKey in class com.webobjects.appserver.WORequest

dateFormValueForKey

public com.webobjects.foundation.NSTimestamp dateFormValueForKey(String aKey,
                                                                 SimpleDateFormat dateFormatter)

Overrides:

dateFormValueForKey in class com.webobjects.appserver.WORequest

browser

public ERXBrowser browser()

Gets the ERXBrowser associated with the user-agent of the request.

Returns:

browser object for the request

finalize

public void finalize()
              throws Throwable

Cleaning up retain count on the browser.

Overrides:

finalize in class Object

Throws:

Throwable

isSecure

public boolean isSecure()

Returns whether or not this request is secure.

Overrides:

isSecure in class com.webobjects.appserver.WORequest

Returns:

whether or not this request is secure

_completeURLPrefix

public void _completeURLPrefix(StringBuffer stringbuffer)

Add the protocol, server and port parts of this request to a StringBuffer.

Parameters:

stringbuffer -

_completeURLPrefix

public void _completeURLPrefix(StringBuffer stringbuffer,
                               boolean secure,
                               int port)

Add the protocol, server and port parts to a StringBuffer to build an URL to this app. if port is set to 0, this request port will be used.

Overrides:

_completeURLPrefix in class com.webobjects.appserver.WORequest

Parameters:

stringbuffer -

secure - generate a https url

port - the port number to use, 0 this request port

isRequestSecure

public static boolean isRequestSecure(com.webobjects.appserver.WORequest request)

Returns whether or not the given request is secure. MS: I found this somewhere else a while ago, but I have no idea where or I'd give attribution.

Parameters:

request - the request to check

Returns:

whether or not the given request is secure.

fixAbbreviationArray

protected NSArray<String> fixAbbreviationArray(NSArray<String> languages)

Translates ("de", "en-us;q=0.33", "en", "en-gb;q=0.66") to ("de", "en_gb", "en-us", "en").

Parameters:

languages - NSArray of Strings

Returns:

sorted NSArray of normalized Strings

cookieValues

public NSDictionary cookieValues()

Overridden to call _cookieDictionary() where we parse the cookies one at a time using java.net.HttpCookie so that we don't get an empty cookie dictionary if one cookie is malformed.

Overrides:

cookieValues in class com.webobjects.appserver.WORequest

isSessionIDInRequest

public boolean isSessionIDInRequest()

Overridden because the super implementation would pull in all content even if the request is supposed to be streaming and thus very large. Will now return false if the request handler is streaming.

Overrides:

isSessionIDInRequest in class com.webobjects.appserver.WORequest

Returns:

true if the session ID can be obtained from the form values or a cookie.

_getSessionIDFromValuesOrCookie

protected String _getSessionIDFromValuesOrCookie(boolean inCookiesFirst)

Overridden because the super implementation would pull in all content even if the request is supposed to be streaming and thus very large. Will now look for the session ID only in the cookie values.

Overrides:

_getSessionIDFromValuesOrCookie in class com.webobjects.appserver.WORequest

Parameters:

inCookiesFirst - define if session ID should be searched first in cookie

setCredentials

public void setCredentials(String userName,
                           String password)

Utility method to set credentials for basic authorization.

Parameters:

userName - the user name

password - the password

remoteHostAddress

public String remoteHostAddress()

Returns the remote client host address. Works in various setups, like direct connect, deployed etc. If no host name can be found, returns "UNKNOWN".

Returns:

remote client host address

remoteHostName

public String remoteHostName()

Returns the remote client host name. If no host name can be found, returns "UNKNOWN".

Returns:

remote client host name

mutableUserInfo

public NSMutableDictionary<String,Object> mutableUserInfo()