er.extensions.appserver

Class ERXResponse

java.lang.Object

com.webobjects.appserver.WOMessage

com.webobjects.appserver.WOResponse

er.extensions.appserver.ERXResponse

All Implemented Interfaces:

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

Direct Known Subclasses:

AjaxResponse, ERXKeepAliveResponse

public class ERXResponse
extends com.webobjects.appserver.WOResponse

ERXResponse provides a place to override methods of WOResponse. This is returned by default from ERXApplication. Also has support for "partials", i.e. in your render tree, you can define a new "partial", where the content will actually get rendered.

Author:

mschrag, ak

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ERXResponse.Context

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
static String	ContentDispositionHeaderKey
static String	ContentTypeHeaderKey
static String	DisablePageCachingKey

Fields inherited from class com.webobjects.appserver.WOResponse

_channelCount, _channelPosition, _contentInputStream, _contentInputStreamBufferSize, _contentInputStreamLength, _fileChannel, _lastDitchErrorResponse

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
ERXResponse()
ERXResponse(int status) Convenience constructor for direct actions.
ERXResponse(String content) Convenience constructor for direct actions.
ERXResponse(String content, int status) Convenience constructor for direct actions.
ERXResponse(com.webobjects.appserver.WOContext context)

Method Summary

Modifier and Type	Method and Description
protected void	__setContent(Object appendable)
void	_finalizeInContext(com.webobjects.appserver.WOContext originalContext) Overridden to insert the partials in the respective area.
boolean	allowClientCaching()
String	contentDisposition()
String	contentType()
void	disableClientCaching() Overridden to not call super if trying to download an attachment to IE or if allowClientCaching is true.
boolean	isAttachment()
boolean	isHTML()
boolean	isIE()
boolean	isPageCachingDisabled()
static boolean	isXHTML(com.webobjects.appserver.WOResponse response) Returns whether or not XHTML is turned on for the given response.
void	mark(String key) Call this to mark the place where a partial should get rendered.
void	popContent(boolean append) Pops the last _content off the stack, optionally appending the current content to it.
static ERXResponse	popPartial() Returns the top-most response after this one has been pulled from the stack.
void	pushContent() Pushes a new _content onto the stack, so you can write to this response and capture the output.
static ERXResponse	pushPartial(String key) Returns the associated response for the supplied key.
void	setAllowClientCaching(boolean allowClientCaching) Can be used to enable client-side caching of the response content, for example if the response contains a static image.
void	setUserInfoForKey(Object value, String key) WO 5.4 API Sets the value for key in the user info dictionary.
static void	setXHTML(com.webobjects.appserver.WOResponse response, boolean xhtml) Sets whether the given response should turn on XHTML tag rendering.
Object	userInfoForKey(String key) WO 5.4 API

Methods inherited from class com.webobjects.appserver.WOResponse

_appendTagAttributeAndValue, _isClientCachingDisabled, _redirectionResponseForAbsoluteURL, _redirectResponse, clone, contentInputStream, contentInputStreamBufferSize, contentInputStreamLength, generateResponse, setContentStream, setContentStream, setStatus, status, toString

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, cookies, 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, storePageInBacktrackCache, stringByEscapingHTMLAttributeValue, stringByEscapingHTMLString, takeValueForKey, takeValueForKeyPath, unableToSetNullForKey, userInfo, valueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

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

Field Detail

ContentDispositionHeaderKey

public static final String ContentDispositionHeaderKey

See Also:

Constant Field Values

ContentTypeHeaderKey

public static final String ContentTypeHeaderKey

See Also:

Constant Field Values

DisablePageCachingKey

public static final String DisablePageCachingKey

See Also:

Constant Field Values

Constructor Detail

ERXResponse

public ERXResponse()

ERXResponse

public ERXResponse(String content,
                   int status)

Convenience constructor for direct actions.

Parameters:

content - text content of the response

status - HTTP status code of the response

ERXResponse

public ERXResponse(String content)

Convenience constructor for direct actions.

Parameters:

content - text content of the response

ERXResponse

public ERXResponse(int status)

Convenience constructor for direct actions.

Parameters:

status - HTTP status code of the response

ERXResponse

public ERXResponse(com.webobjects.appserver.WOContext context)

Method Detail

__setContent

protected void __setContent(Object appendable)

pushContent

public void pushContent()

Pushes a new _content onto the stack, so you can write to this response and capture the output.

popContent

public void popContent(boolean append)

Pops the last _content off the stack, optionally appending the current content to it.

Parameters:

append -

mark

public void mark(String key)

Call this to mark the place where a partial should get rendered.

Parameters:

key -

_finalizeInContext

public void _finalizeInContext(com.webobjects.appserver.WOContext originalContext)

Overridden to insert the partials in the respective area.

Overrides:

_finalizeInContext in class com.webobjects.appserver.WOResponse

Parameters:

originalContext - context

pushPartial

public static ERXResponse pushPartial(String key)

Returns the associated response for the supplied key. Creates it if needed.

Parameters:

key - the key to push the partial as

Returns:

the new ERXResponse to write to

popPartial

public static ERXResponse popPartial()

Returns the top-most response after this one has been pulled from the stack.

Returns:

the previous partial

disableClientCaching

public void disableClientCaching()

Overridden to not call super if trying to download an attachment to IE or if allowClientCaching is true.

Overrides:

disableClientCaching in class com.webobjects.appserver.WOResponse

See Also:

WOResponse.disableClientCaching()

setAllowClientCaching

public void setAllowClientCaching(boolean allowClientCaching)

Can be used to enable client-side caching of the response content, for example if the response contains a static image. Normally it will be prevented by disableClientCaching(). Note that additionally you might need to set the cache-control header.

Parameters:

allowClientCaching - true prevents calling disableClientCaching()

allowClientCaching

public boolean allowClientCaching()

Returns:

true if client-side caching shall be allowed

isPageCachingDisabled

public boolean isPageCachingDisabled()

Returns:

true if disablePageCaching() has been called for this response

See Also:

DisablePageCachingKey

setUserInfoForKey

public void setUserInfoForKey(Object value,
                              String key)

WO 5.4 API Sets the value for key in the user info dictionary.

Overrides:

setUserInfoForKey in class com.webobjects.appserver.WOMessage

Parameters:

value - value to add to userInfo()

key - key to add value under

userInfoForKey

public Object userInfoForKey(String key)

WO 5.4 API

Overrides:

userInfoForKey in class com.webobjects.appserver.WOMessage

Parameters:

key - key to return value from userInfo() for

Returns:

value from WOMessage.userInfo() for key, or null if not available

isAttachment

public boolean isAttachment()

isHTML

public boolean isHTML()

Returns:

true if the content type of this response indicates HTML

contentDisposition

public String contentDisposition()

Returns:

header value for ContentDispositionHeaderKey

contentType

public String contentType()

Returns:

header value for ContentTypeHeaderKey

isIE

public boolean isIE()

Returns:

true if the Request this Response is for has a user agent that indicates and IE browser

setXHTML

public static void setXHTML(com.webobjects.appserver.WOResponse response,
                            boolean xhtml)

Sets whether the given response should turn on XHTML tag rendering.

Parameters:

response - the response to turn XHTML on for

xhtml - whether or not XHTML should be turned on

isXHTML

public static boolean isXHTML(com.webobjects.appserver.WOResponse response)

Returns whether or not XHTML is turned on for the given response.

Parameters:

response - the response to check XHTML for

Returns:

whether or not XHTML was turned on