ariba.ui.aribaweb.core
Class AWRedirect

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWComponent
          ariba.ui.aribaweb.core.AWRedirect

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

Direct Known Subclasses:

AWUrlRedirect

public class AWRedirect
extends AWComponent
implements AWResponseGenerating.ResponseSubstitution

Nested Class Summary

static interface

AWRedirect.URLDecorator

Nested classes/interfaces inherited from class ariba.ui.aribaweb.core.AWComponent

AWComponent.RenderingFilter, AWComponent.RenderingListener

Nested classes/interfaces inherited from interface ariba.ui.aribaweb.core.AWResponseGenerating

AWResponseGenerating.ResponseSubstitution

Field Summary

static java.lang.String

PageName

Fields inherited from class ariba.ui.aribaweb.core.AWComponent

ClassObject, ComponentTemplateFileExtension

Fields inherited from class ariba.ui.aribaweb.util.AWBaseObject

AribaHashtableClass, AribaVectorClass, ClassClass, EmptyHashtable, EmptyMap, EmptyVector, False, IntegerClass, JavaHashtableClass, JavaMapClass, JavaVectorClass, LogHandling, NullObject, ObjectClass, StringClass, True, UndefinedObject, UndefinedString, UninitializedRealNumber

Constructor Summary

AWRedirect()

Method Summary

void	applyValues(AWRequestContext requestContext, AWComponent component) The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().
static void	browserBack(AWResponse response)
static java.lang.String	decorateUrl(java.lang.String originalUrl, boolean isLocal)
static void	disallowInternalDispatch(AWRequestContext requestContext)
boolean	doesAllowInternalDispatch()
static java.lang.String	escapeJavascript(java.lang.String receiver)
static AWRedirect	getRedirect(AWRequestContext requestContext, java.lang.String sUrl)
void	init()
void	initFromRequestContext()
static void	initiateRedirect(AWRequestContext requestContext, java.lang.String url)
AWResponseGenerating	invokeAction(AWRequestContext requestContext, AWComponent component) The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.
boolean	isStateless() Overridden by AWComponent subclasses to indicate whether component instances should be preserved with the page/session (i.e.
static void	registerDecorator(AWRedirect.URLDecorator decorator)
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
AWResponseGenerating	replacementResponse()
void	setAllowInternalDispatch(boolean allowInternalDispatch)
void	setSelfRedirect(boolean flag)
static void	setupHeaders(AWResponse response, java.lang.String unsafeUrlLocation)
static void	setupHeaders(javax.servlet.http.HttpServletResponse httpServletResponse, java.lang.String urlLocation)
void	setUrl(java.lang.String url)
boolean	shouldCachePage()
java.lang.String	url()

Methods inherited from class ariba.ui.aribaweb.core.AWComponent

_topLevelApplyValues, _topLevelInvokeAction, _topLevelRenderResponse, allowEmbeddedKeyPaths, allowsWhitespaceCompression, application, awcyclePageAndLog, bindingForName, bindingForName, bindings, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browserMaxWidth, browserMinWidth, characterEncoding, clearValidationError, clientTimeZone, componentConfiguration, componentDefinition, componentPath, componentReference, createPageWithName, defaultTemplateParser, determineInstance, determineInstance, dict, dict, dict, doubleValueForBinding, doubleValueForBinding, doubleValueForBinding, encodedStringValueForBinding, encodedStringValueForBinding, ensureAwake, ensureFieldValuesClear, env, errorManager, escapeAttribute, escapeString, escapeUnsafeString, extendedFields, formValueManager, generateResponse, generateResponse, generateResponse, generateStringContents, getAWParameter, getDrivingBusinessObject, getFoldInSituOnWindowSizeParam, getPageRenderVersion, getThis, hasBinding, hasBinding, hasContentForTagName, hasContentNamed, hasMultipleTemplates, hasSubTemplateNamed, httpSession, init, initTemplateResourceManager, intValueForBinding, intValueForBinding, intValueForBinding, isBidirectional, isBrowserMicrosoft, isClientPanel, isMacintosh, isRenderAW5, isStrictTagNaming, isUserCommunityEnabled, isValidationEnabled, languageDirection, languageLeft, languageRight, loadTemplate, localizedJavaString, markBacktrackState, name, namePath, notifyChange, otherBindings, otherBindingsValues, page, pageComponent, pageWithClass, pageWithClass, pageWithName, pageWithName, parent, postTakeValueActions, preferredLocale, recordBacktrackState, recordBacktrackState, recordValidationError, recordValidationError, recordValidationError, recordValidationErrors, recordValidationWarning, redirectToPage, registerRenderingListener, registerXmlNodeWithName, removeBacktrackState, request, requestContext, requiresPreGlidCompatibility, resourceClassName, resourceManager, response, restoreFromBacktrackState, session, session, setCharacterEncoding, setClientPanel, setClientTimeZone, setComponentConfiguration, setDefaultTemplateParser, setEnv, setPerfDestinationInfo, setPreferredLocale, setResourceManager, setTemplateParser, setupForNextCycle, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, shouldCloseElements, strings, stringValueForBinding, stringValueForBinding, stringValueForBinding, supportedBindingNames, template, templateName, templateParser, templateResource, templateResourceManager, truncateBacktrackState, truncateBacktrackState, urlForResourceNamed, urlForResourceNamed, urlForResourceNamed, useXmlEscaping, valueForBinding, valueForBinding, valueForBinding, xml

Methods inherited from class ariba.ui.aribaweb.util.AWBaseObject

debugString, getFieldValue, isKindOfClass, localizedJavaString, logString, logWarning, setFieldValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ariba.ui.aribaweb.util.AWObject

getFieldValue, isKindOfClass, setFieldValue

Field Detail

PageName

public static final java.lang.String PageName

See Also:

Constant Field Values

Constructor Detail

AWRedirect

public AWRedirect()

Method Detail

isStateless

public boolean isStateless()

Description copied from class: AWComponent

Overridden by AWComponent subclasses to indicate whether component instances should be preserved with the page/session (i.e. are "stateful") or can be pooled and reused for each phase of request processing (i.e. are stateless) Default is to be stateless unless the component is used as the top-level (page) component.

Overrides:

isStateless in class AWComponent

init

public void init()

Specified by:

init in interface AWObject

Overrides:

init in class AWComponent

shouldCachePage

public boolean shouldCachePage()

Overrides:

shouldCachePage in class AWComponent

url

public java.lang.String url()

setUrl

public void setUrl(java.lang.String url)

applyValues

public void applyValues(AWRequestContext requestContext,
                        AWComponent component)

Description copied from interface: AWCycleable

The receiver should take any form values (or query string parameters) that it owns from the AWRequestContext.request().

Specified by:

applyValues in interface AWCycleable

Overrides:

applyValues in class AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

invokeAction

public AWResponseGenerating invokeAction(AWRequestContext requestContext,
                                         AWComponent component)

Description copied from interface: AWCycleable

The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.

Specified by:

invokeAction in interface AWCycleable

Overrides:

invokeAction in class AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

Returns:

the response for the action

setSelfRedirect

public void setSelfRedirect(boolean flag)

doesAllowInternalDispatch

public boolean doesAllowInternalDispatch()

setAllowInternalDispatch

public void setAllowInternalDispatch(boolean allowInternalDispatch)

replacementResponse

public AWResponseGenerating replacementResponse()

Specified by:

replacementResponse in interface AWResponseGenerating.ResponseSubstitution

Overrides:

replacementResponse in class AWComponent

initiateRedirect

public static void initiateRedirect(AWRequestContext requestContext,
                                    java.lang.String url)

disallowInternalDispatch

public static void disallowInternalDispatch(AWRequestContext requestContext)

initFromRequestContext

public void initFromRequestContext()

browserBack

public static void browserBack(AWResponse response)

renderResponse

public void renderResponse(AWRequestContext requestContext,
                           AWComponent component)

Description copied from interface: AWCycleable

The receiver should render its content to the AWRequestContext.response()

Specified by:

renderResponse in interface AWCycleable

Overrides:

renderResponse in class AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

setupHeaders

public static void setupHeaders(AWResponse response,
                                java.lang.String unsafeUrlLocation)

setupHeaders

public static void setupHeaders(javax.servlet.http.HttpServletResponse httpServletResponse,
                                java.lang.String urlLocation)

getRedirect

public static AWRedirect getRedirect(AWRequestContext requestContext,
                                     java.lang.String sUrl)

escapeJavascript

public static java.lang.String escapeJavascript(java.lang.String receiver)

registerDecorator

public static void registerDecorator(AWRedirect.URLDecorator decorator)

decorateUrl

public static java.lang.String decorateUrl(java.lang.String originalUrl,
                                           boolean isLocal)