er.extensions.appserver
Class ERXRedirect

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          er.extensions.appserver.ERXRedirect

All Implemented Interfaces:

com.webobjects.appserver.WOActionResults, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, com.webobjects.foundation.NSValidation, java.io.Serializable, java.lang.Cloneable

public class ERXRedirect
extends com.webobjects.appserver.WOComponent

ERXRedirect is like a WORedirect except that you can give it a component instance to redirect to (as well as several other convenient methods of redirecting). This is useful for situations like in an Ajax request where you want to do a full page reload that points to the component that you would normally return from your action method. If your redirect is in an Ajax request, this will generate a script tag that reassigns document.location.href to the generated url.

See Also:

Serialized Form

Author:

mschrag

Nested Class Summary

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

com.webobjects.appserver.WOComponent._EventLoggingEnabler, com.webobjects.appserver.WOComponent.Event

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.Null, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

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

com.webobjects.foundation.NSValidation._MethodBinding, com.webobjects.foundation.NSValidation._ValidationBinding, com.webobjects.foundation.NSValidation.DefaultImplementation, com.webobjects.foundation.NSValidation.Utility, com.webobjects.foundation.NSValidation.ValidationException

Field Summary

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

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

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

ERXRedirect(com.webobjects.appserver.WOContext context)

Method Summary

void	appendToResponse(com.webobjects.appserver.WOResponse response, com.webobjects.appserver.WOContext context)
protected java.lang.String	queryParametersString() Returns the query parameters dictionary as a string.
void	setComponent(com.webobjects.appserver.WOComponent component) Sets the component instance to redirect to.
void	setComponentToPage() Sets the redirect component to be the original page that we were just on.
void	setDirectActionClass(java.lang.String directActionClass) Sets the direct action class to redirect to.
void	setDirectActionName(java.lang.String directActionName) The direct action name to redirect to.
void	setQueryParameters(com.webobjects.foundation.NSDictionary<java.lang.String,? extends java.lang.Object> queryParameters) Sets the query parameters for this redirect.
void	setRequestHandlerKey(java.lang.String requestHandlerKey) Sets the request handler key to redirect to.
void	setRequestHandlerPath(java.lang.String requestHandlerPath) Sets the request handler path to redirect to.
void	setSecure(boolean secure) Sets whether or not a secure URL should be generated.
void	setUrl(java.lang.String url) Sets the URL to redirect to.

Methods inherited from class com.webobjects.appserver.WOComponent

_associationWithName, _awakeInContext, _childTemplate, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, invokeAction, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXRedirect

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

Method Detail

setSecure

public void setSecure(boolean secure)

Sets whether or not a secure URL should be generated. This does not apply if you set a URL directly.

Parameters:

secure - whether or not a secure URL should be generated

setRequestHandlerKey

public void setRequestHandlerKey(java.lang.String requestHandlerKey)

Sets the request handler key to redirect to. You typically want to also set requestHandlerPath if you set this.

Parameters:

requestHandlerKey - the redirected request handler key

setRequestHandlerPath

public void setRequestHandlerPath(java.lang.String requestHandlerPath)

Sets the request handler path to redirect to. This requires that you also set requestHandlerKey.

Parameters:

requestHandlerPath - the request handler path to redirect to

setDirectActionClass

public void setDirectActionClass(java.lang.String directActionClass)

Sets the direct action class to redirect to. You typically want to also set directActionName if you set this.

Parameters:

directActionClass - the direct action class to redirect to

setDirectActionName

public void setDirectActionName(java.lang.String directActionName)

The direct action name to redirect to.

Parameters:

directActionName - the direct action name

setUrl

public void setUrl(java.lang.String url)

Sets the URL to redirect to.

Parameters:

url - the URL to redirect to

setComponentToPage

public void setComponentToPage()

Sets the redirect component to be the original page that we were just on.

setComponent

public void setComponent(com.webobjects.appserver.WOComponent component)

Sets the component instance to redirect to. This component gets replaced as the page in the current context, and a URL is generated to the current context, which causes the request for that context ID to return the component you are redirecting to. When you set a redirect component, the component is also put into the normal page cache (rather than the ajax page cache), and the ajax cache is disabled for this request. As a result, redirecting to a component WILL burn a backtrack cache entry (just like a normal hyperlink).

Parameters:

component - the component instance to redirect to

setQueryParameters

public void setQueryParameters(com.webobjects.foundation.NSDictionary<java.lang.String,? extends java.lang.Object> queryParameters)

Sets the query parameters for this redirect.

Parameters:

queryParameters - the query parameters for this redirect

queryParametersString

protected java.lang.String queryParametersString()

Returns the query parameters dictionary as a string.

Returns:

the query parameters as a string

appendToResponse

public void appendToResponse(com.webobjects.appserver.WOResponse response,
                             com.webobjects.appserver.WOContext context)

Overrides:

appendToResponse in class com.webobjects.appserver.WOComponent