er.extensions.appserver

Class ERXRedirect

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.appserver.ERXRedirect

All Implemented Interfaces:

WOActionResults, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable

public class ERXRedirect
extends 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. ERXRedirect は WORedirect と同様ですが、レダイレクトはコンポーネント・インスタンスへ実行できることです。 他にもレダイレクトに便利なメソッドもあります。 Ajax リクエストなどでとても有効です。例えば、全ページのリロード（普段はアクション・メソッドのコール）へポイントします。 リダイレクトが Ajax リクエストの場合にはスクリプト・タグの document.location.href で URL 生成されます。

See Also:

Serialized Form

Author:

mschrag

Nested Class Summary

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

WOComponent._EventLoggingEnabler, WOComponent.Event

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

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

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, 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

Constructors

Constructor and Description
ERXRedirect(WOContext context)

Method Summary

Modifier and Type	Method and Description
void	appendToResponse(WOResponse response, WOContext context)
protected NSDictionary<String,Object>	directActionQueryParameters()
protected String	queryParametersString() Returns the query parameters dictionary as a string.
void	setComponent(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(String directActionClass) Sets the direct action class to redirect to.
void	setDirectActionName(String directActionName) The direct action name to redirect to.
void	setIncludeSessionID(boolean includeSessionID) Sets whether or not a direct action URL should contain the session ID.
void	setQueryParameters(NSDictionary<String,? extends Object> queryParameters) Sets the query parameters for this redirect.
void	setRequestHandlerKey(String requestHandlerKey) Sets the request handler key to redirect to.
void	setRequestHandlerPath(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(String url) Sets the URL to redirect to.

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _awakeInContext, _childTemplate, _cleanUpStatelessComponent, _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, setVariableValueForName, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXRedirect

public ERXRedirect(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 生成される URL がセキュリティー URL であるかどうかをセットします URL を直接でセットする時には使用されません。

secure - - セキュリティー URL を生成するかどうか

setIncludeSessionID

public void setIncludeSessionID(boolean includeSessionID)

Sets whether or not a direct action URL should contain the session ID. This defaults to false to maintain backward compatibility.

Parameters:

includeSessionID - whether or not a sessionID should be included

setRequestHandlerKey

public void setRequestHandlerKey(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 リダイレクト先のリダイレクト・リクエスト・ハンドラーをセットします requestHandlerPath も同時にセットすること

requestHandlerKey - - リダイレクト・リクエスト・ハンドラー

setRequestHandlerPath

public void setRequestHandlerPath(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 リダイレクト先のリクエスト・ハンドラー・パスをセットします requestHandlerKey も同時にセットすること

requestHandlerPath - - リクエスト・ハンドラー・パス

setDirectActionClass

public void setDirectActionClass(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 リダイレクト先のダイレクトアクション・クラスをセットします directActionName も同時にセットすること

directActionClass - - ダイレクトアクション・クラス

setDirectActionName

public void setDirectActionName(String directActionName)

The direct action name to redirect to.

Parameters:

directActionName - the direct action name リダイレクト先のダイレクトアクション名をセットします

directActionName - - ダイレクトアクション名

setUrl

public void setUrl(String url)

Sets the URL to redirect to.

Parameters:

url - the URL to redirect to リダイレクト先の URL をセットします

url - - リダイレクト先の URL

setComponentToPage

public void setComponentToPage()

Sets the redirect component to be the original page that we were just on. 現時点にいるコンポーネントをリダイレクト先コンポーネントにすること

setComponent

public void setComponent(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 リダイレクト先のコンポーネント・インスタンスをセットします。 このコンポーネントはカレント・コンテクストのページとして置き換わり、 コンテクスト ID のリクエストがリダイレクトするコンポーネントを戻すカレント・コンテクストへの URL が生成されます。 リダイレクト・コンポーネントをセットすることでコンポーネントは一般ページ・キャシュ（Ajax ページ・キャシュではなく） に登録され、このリクエストでの Ajax キャシュは使用禁止されます。結果としてコンポーネントへのリダイレクトは （ハイパーリンクと同じく）バックトラック・キャシュを作成します。

component - - リダイレクト先のコンポーネント・インスタンス

setQueryParameters

public void setQueryParameters(NSDictionary<String,? extends Object> queryParameters)

Sets the query parameters for this redirect.

Parameters:

queryParameters - the query parameters for this redirect リダイレクトのクエリー・パラメータをセットします

queryParameters - - リダイレクトのクエリー・パラメータ

queryParametersString

protected String queryParametersString()

Returns the query parameters dictionary as a string.

Returns:

the query parameters as a string クエリー・パラメータ・ディクショナリーを文字列として戻します。

directActionQueryParameters

protected NSDictionary<String,Object> directActionQueryParameters()

appendToResponse

public void appendToResponse(WOResponse response,
                             WOContext context)

Overrides:

appendToResponse in class WOComponent