# Deprecated API

## Contents

- Packages
- Interfaces
- Classes
- Annotation Types
- Fields
- Methods
- Constructors
- Enum Constants

- Deprecated Packages
  Package
  Description
  org.apache.tapestry5.services.templates
  Deprecated in 5.3

- Deprecated Interfaces
  Interface
  Description
  org.apache.tapestry5.commons.services.InvalidationListener
  In 5.4; use `InvalidationEventHub.addInvalidationCallback(Runnable)` instead
  org.apache.tapestry5.internal.services.ComponentResourcesOperation
  In Tapestry 5.4; use `MethodAdvice` and other parts of the new (in 5.3) plastic library.
  org.apache.tapestry5.internal.services.ResourceDigestManager
  Deprecated in 5.4 with no replacement; see release notes about classpath assets moving to /META-INF/assets/. To be removed in 5.5.
  org.apache.tapestry5.internal.structure.PageResetListener
  in 5.3.4
  org.apache.tapestry5.ioc.services.RegistryShutdownListener
  In Tapestry 5.3, to be removed in a later release.
  org.apache.tapestry5.ioc.services.ThreadCleanupListener
  Deprecated in 5.4, use `PerthreadManager.addThreadCleanupCallback(Runnable)` instead.
  org.apache.tapestry5.runtime.PageLifecycleListener
  in 5.3.4, replaced with `PageLifecycleCallbackHub`
  org.apache.tapestry5.services.ClasspathAssetAliasManager
  Deprecated in 5.4, with no replacement. This will no longer be used in Tapestry 5.5, as all classpath assets will need to be under the `META-INF/assets` folder (but may be maintained for compatibility reasons until 5.6).
  org.apache.tapestry5.services.ClientBehaviorSupport
  Deprecated in 5.4 with no replacement. Use `JavaScriptSupport` directly, instead.
  org.apache.tapestry5.services.LinkCreationListener
  Use `LinkCreationListener2` instead
  org.apache.tapestry5.services.ResourceDigestGenerator
  Deprecated in 5.4 with no replacement; see release notes about classpath assets moving to /META-INF/assets/, and content checksums inside asset URLs
  org.apache.tapestry5.services.templates.ComponentTemplateLocator
  Deprecated in 5.3, override or decorate `ComponentResourceSelector` instead.
  org.apache.tapestry5.services.ValidationDecoratorFactory
  Deprecated in 5.4 with no replacement, as `ValidationDecorator` is being phased out.
  org.apache.tapestry5.ValidationDecorator
  Deprecated in 5.4 with no replacement.

- Deprecated Classes
  Class
  Description
  org.apache.tapestry5.ajax.MultiZoneUpdate
  Deprecated in 5.3; use the `AjaxResponseRenderer` service instead of returning an instance of MultiZoneUpdate
  org.apache.tapestry5.corelib.mixins.FormFieldFocus
  As of release 5.4, replaced by `OverrideFieldFocus`
  org.apache.tapestry5.CSSClassConstants
  Deprecated in 5.4 with no replacement.
  org.apache.tapestry5.internal.services.ajax.MultiZoneUpdateEventResultProcessor
  Deprecated in 5.3
  org.apache.tapestry5.internal.services.EnumValueEncoderFactory
  this class is superseded by `TypeCoercedValueEncoderFactory` and scheduled to be removed in Tapestry 5.5
  org.apache.tapestry5.ioc.test.IOCTestCase
  In 5.4, with no replacement
  org.apache.tapestry5.runtime.PageLifecycleAdapter
  in 5.3.4, as `PageLifecycleListener` has been deprecated
  org.apache.tapestry5.services.AssetAlias
  Deprecated in 5.4 (see notes in `ClasspathAssetAliasManager`).
  org.apache.tapestry5.test.ioc.MockTester
  In 5.4, with no replacement
  org.apache.tapestry5.test.ioc.TestBase
  In 5.4, with no replacement
  org.apache.tapestry5.test.ioc.TestUtils
  In 5.4, with no replacement
  org.apache.tapestry5.test.Jetty7Runner
  please use `JettyRunner` instead
  org.apache.tapestry5.test.Tomcat6Runner
  Please use `TomcatRunner` instead

- Deprecated Annotation Types
  Annotation Type
  Description
  org.apache.tapestry5.annotations.Retain
  This rarely used annotation is likely to cause threading issues starting in Tapestry 5.2 (which no longer pools pages but uses shared instances with externalized mutable state)
  org.apache.tapestry5.ioc.annotations.InjectResource
  Deprecated in Tapestry 5.3, to be removed in a later release. Use `Inject` instead.
  org.apache.tapestry5.ioc.annotations.SubModule
  Deprecated in 5.4, use `ImportModule` instead.

- Deprecated Fields
  Field
  Description
  org.apache.tapestry5.alerts.Severity.cssClass
  Deprecated in Tapestry 5.4 with no replacement (beyond the name of the value itself).
  org.apache.tapestry5.ComponentParameterConstants.FORMINJECTOR_INSERT_POSITION
  Deprecated in 5.4 with no replacement.
  org.apache.tapestry5.ComponentParameterConstants.FORMINJECTOR_SHOW_FUNCTION
  Deprecated in 5.4 with no replacement.
  org.apache.tapestry5.ComponentParameterConstants.ZONE_SHOW_METHOD
  Deprecated in 5.4 with no replacement.
  org.apache.tapestry5.ComponentParameterConstants.ZONE_UPDATE_METHOD
  Deprecated in 5.4 with no replacement.
  org.apache.tapestry5.CSSClassConstants.ERROR
  Deprecated in 5.4 with no replacement; decoration of fields with validation errors has moved to the client.
  org.apache.tapestry5.CSSClassConstants.ERROR_SINGLE
  Deprecated in 5.4 with no replacement; decoration of fields with validation errors has moved to the client.
  org.apache.tapestry5.CSSClassConstants.INVISIBLE
  Removed in Tapestry 5.4 with no replacement.
  org.apache.tapestry5.grid.GridConstants.COLUMNS_ASCENDING
  Deprecated in 5.4 with no replacement.
  org.apache.tapestry5.grid.GridConstants.COLUMNS_DESCENDING
  Deprecated in 5.4 with no replacement.
  org.apache.tapestry5.grid.GridConstants.COLUMNS_SORTABLE
  Deprecated in 5.4 with no replacement.
  org.apache.tapestry5.grid.GridConstants.FIRST_CLASS
  Deprecated in 5.4 with no replacement.
  org.apache.tapestry5.grid.GridConstants.LAST_CLASS
  Deprecated in 5.4 with no replacement.
  org.apache.tapestry5.grid.GridConstants.SORT_ASCENDING_CLASS
  Deprecated in 5.4 with no replacement.
  org.apache.tapestry5.grid.GridConstants.SORT_DESCENDING_CLASS
  Deprecated in 5.4 with no replacement.
  org.apache.tapestry5.hibernate.HibernateConstants.DEFAULT_CONFIGURATION
  Use `HibernateSymbols.DEFAULT_CONFIGURATION` instead
  org.apache.tapestry5.hibernate.HibernateConstants.PROVIDE_ENTITY_VALUE_ENCODERS_SYMBOL
  Use `HibernateSymbols.PROVIDE_ENTITY_VALUE_ENCODERS` instead.
  org.apache.tapestry5.http.TapestryHttpConstants.TAPESTRY_VERSION
  use `TapestryHttpSymbolConstants.TAPESTRY_VERSION` instead.
  org.apache.tapestry5.internal.InternalConstants.CHARSET_CONTENT_TYPE_PARAMETER
  Use `TapestryHttpInternalConstants.CHARSET_CONTENT_TYPE_PARAMETER` instead
  org.apache.tapestry5.internal.InternalConstants.CONTENT_ENCODING_HEADER
  Use `TapestryHttpInternalConstants.CONTENT_ENCODING_HEADER` instead
  org.apache.tapestry5.internal.InternalConstants.DISABLE_DEFAULT_MODULES_PARAM
  Use `TapestryHttpInternalConstants.DISABLE_DEFAULT_MODULES_PARAM` instead
  org.apache.tapestry5.internal.InternalConstants.EMPTY_STRING_ARRAY
  Use `CommonsUtils.EMPTY_STRING_ARRAY` instead
  org.apache.tapestry5.internal.InternalConstants.GZIP_CONTENT_ENCODING
  Use `TapestryHttpInternalConstants.GZIP_CONTENT_ENCODING` instead
  org.apache.tapestry5.internal.InternalConstants.TAPESTRY_APP_PACKAGE_PARAM
  Use `TapestryHttpInternalConstants.TAPESTRY_APP_PACKAGE_PARAM` instead
  org.apache.tapestry5.MarkupConstants.ONCLICK
  Deprecated in Tapestry 5.4 with no replacement. Do not use.
  org.apache.tapestry5.MarkupConstants.WAIT_FOR_PAGE
  Deprecated in Tapestry 5.4 with no replacement. Do not use.
  org.apache.tapestry5.test.SeleniumTestCase.selenium

- Deprecated Methods
  Method
  Description
  org.apache.tapestry5.beanmodel.services.BeanModelSource.create(Class<T>, boolean, Messages)
  use `BeanModelSource.createDisplayModel(Class, org.apache.tapestry5.commons.Messages)` or `BeanModelSource.createEditModel(Class, org.apache.tapestry5.commons.Messages)`
  org.apache.tapestry5.commons.services.InvalidationEventHub.addInvalidationListener(InvalidationListener)
  in 5.4, use `InvalidationEventHub.addInvalidationCallback(Runnable)` instead}
  org.apache.tapestry5.ComponentResources.addPageLifecycleListener(PageLifecycleListener)
  In 5.3.4, use `ComponentResources.getPageLifecycleCallbackHub()` instead
  org.apache.tapestry5.ComponentResources.removePageLifecycleListener(PageLifecycleListener)
  in 5.3.4, not necessary with `PageLifecycleCallbackHub.addPageLoadedCallback(Runnable)`.
  org.apache.tapestry5.corelib.components.Form.setDefaultTracker(ValidationTracker)
  In 5.4; previously used only for testing
  org.apache.tapestry5.dom.Element.addClassName(String...)
  Deprecated in 5.4, as this is now special behavior for the "class" attribute.
  org.apache.tapestry5.http.services.Request.getContextPath()
  in 5.4, inject the value for symbol `SymbolConstants.CONTEXT_PATH` instead
  org.apache.tapestry5.internal.structure.Page.addLifecycleListener(PageLifecycleListener)
  in 5.3.4; use `PageLifecycleCallbackHub.addPageLoadedCallback(Runnable)`, `PageLifecycleCallbackHub.addPageAttachedCallback(Runnable)`, or `PageLifecycleCallbackHub.addPageDetachedCallback(Runnable)` instead
  org.apache.tapestry5.internal.structure.Page.addResetListener(PageResetListener)
  in 5.3.4,
  org.apache.tapestry5.internal.structure.Page.removeLifecycleListener(PageLifecycleListener)
  in 5.3.4, due to introduction of `PageLifecycleCallbackHub.addPageLoadedCallback(Runnable)`
  org.apache.tapestry5.ioc.internal.services.cron.CronExpression.clone()
  org.apache.tapestry5.ioc.internal.util.InternalUtils.toMessage(Throwable)
  Deprecated in 5.4; use `ExceptionUtils.toMessage(Throwable)` instead.
  org.apache.tapestry5.ioc.services.PerthreadManager.addThreadCleanupListener(ThreadCleanupListener)
  Deprecated in 5.4, use `PerthreadManager.addThreadCleanupCallback(Runnable)` instead.
  org.apache.tapestry5.json.JSONArray.length()
  Use `JSONArray.size()` instead.
  org.apache.tapestry5.json.JSONArray.put(Object)
  The use of `JSONArray.add(Object)` is encouraged.
  org.apache.tapestry5.json.JSONObject.has(String)
  use `JSONObject.containsKey(Object)` instead
  org.apache.tapestry5.json.JSONObject.length()
  Use `JSONObject.size()` instead.
  org.apache.tapestry5.model.MutableComponentModel.addParameter(String, boolean, boolean, String)
  Use `MutableComponentModel.addParameter(String, boolean, boolean, String, boolean)` instead.
  org.apache.tapestry5.runtime.PageLifecycleListener.containingPageDidAttach()
  In Tapestry 5.3, use `PageLifecycleCallbackHub.addPageAttachedCallback(Runnable)` instead.
  org.apache.tapestry5.runtime.PageLifecycleListener.containingPageDidDetach()
  In Tapestry 5.3, use `PageLifecycleCallbackHub.addPageDetachedCallback(Runnable)` instead.
  org.apache.tapestry5.runtime.PageLifecycleListener.containingPageDidLoad()
  in 5.3.4, use `PageLifecycleCallbackHub.addPageLoadedCallback(Runnable)` instead
  org.apache.tapestry5.runtime.PageLifecycleListener.restoreStateBeforePageAttach()
  In Tapestry 5.3, with no replacement (persisted fields now lazily restore their state)
  org.apache.tapestry5.services.ClientBehaviorSupport.addFormFragment(String, boolean, String, String)
  Use `ClientBehaviorSupport.addFormFragment(String, boolean, String, String, String)` instead
  org.apache.tapestry5.services.ClientBehaviorSupport.addFormFragment(String, boolean, String, String, String)
  In 5.4; use the `core/form-fragment` module instead.
  org.apache.tapestry5.services.ClientBehaviorSupport.addFormFragment(String, String, String)
  Use `ClientBehaviorSupport.addFormFragment(String, boolean, String, String, String)` instead
  org.apache.tapestry5.services.ComponentDefaultProvider.defaultTranslator(String, ComponentResources)
  Use `ComponentDefaultProvider.defaultTranslatorBinding(String, org.apache.tapestry5.ComponentResources)` instead
  org.apache.tapestry5.services.ComponentDefaultProvider.defaultValidator(String, ComponentResources)
  Use `ComponentDefaultProvider.defaultValidatorBinding(String, org.apache.tapestry5.ComponentResources)` instead
  org.apache.tapestry5.services.Cookies.writeCookieValue(String, String)
  Use the `CookieBuilder` API, obtained with `Cookies.getBuilder(String, String)`, instead.
  org.apache.tapestry5.services.Cookies.writeCookieValue(String, String, int)
  Use the `CookieBuilder` API, obtained with `Cookies.getBuilder(String, String)`, instead.
  org.apache.tapestry5.services.Cookies.writeCookieValue(String, String, String)
  Use the `CookieBuilder` API, obtained with `Cookies.getBuilder(String, String)`, instead.
  org.apache.tapestry5.services.Cookies.writeCookieValue(String, String, String, String)
  Use the `CookieBuilder` API, obtained with `Cookies.getBuilder(String, String)`, instead.
  org.apache.tapestry5.services.Cookies.writeDomainCookieValue(String, String, String)
  Use the `CookieBuilder` API, obtained with `Cookies.getBuilder(String, String)`, instead.
  org.apache.tapestry5.services.Cookies.writeDomainCookieValue(String, String, String, int)
  Use the `CookieBuilder` API, obtained with `Cookies.getBuilder(String, String)`, instead.
  org.apache.tapestry5.services.Environment.cloak()
  Deprecated in 5.4 with no replacement; not longer used by Tapestry.
  org.apache.tapestry5.services.Environment.decloak()
  Deprecated in 5.4 with no replacement; not longer used by Tapestry.
  org.apache.tapestry5.services.FormSupport.addValidation(Field, String, String, Object)
  Deprecated in 5.4 with no exact replacement; this default implementation now does nothing. Invoke `FormSupport.isClientValidationEnabled()`, and (if true), use `JavaScriptSupport` to add necessary modules, and add triggering and configuring attributes to the field's `Element`.
  org.apache.tapestry5.services.javascript.JavaScriptStack.getInitialization()
  Deprecated in Tapestry 5.4; may be removed in a future release. Implementations may return null.
  org.apache.tapestry5.services.javascript.JavaScriptSupport.addInitializerCall(String, String)
  Deprecated in 5.4; refactor to use JavaScript modules instead
  org.apache.tapestry5.services.javascript.JavaScriptSupport.addInitializerCall(String, JSONArray)
  Deprecated in 5.4; refactor to use JavaScript modules instead
  org.apache.tapestry5.services.javascript.JavaScriptSupport.addInitializerCall(String, JSONObject)
  Deprecated in 5.4; refactor to use JavaScript modules instead
  org.apache.tapestry5.services.javascript.JavaScriptSupport.addInitializerCall(InitializationPriority, String, String)
  Deprecated in 5.4; refactor to use JavaScript modules instead
  org.apache.tapestry5.services.javascript.JavaScriptSupport.addInitializerCall(InitializationPriority, String, JSONArray)
  Deprecated in 5.4; refactor to use JavaScript modules instead
  org.apache.tapestry5.services.javascript.JavaScriptSupport.addInitializerCall(InitializationPriority, String, JSONObject)
  Deprecated in 5.4; refactor to use JavaScript modules instead
  org.apache.tapestry5.services.javascript.JavaScriptSupport.addScript(String, Object...)
  Deprecated in 5.4; refactor to use JavaScript modules instead
  org.apache.tapestry5.services.javascript.JavaScriptSupport.addScript(InitializationPriority, String, Object...)
  Deprecated in 5.4; refactor to use JavaScript modules instead
  org.apache.tapestry5.services.LibraryMapping.getPathPrefix()
  In 5.4, use `LibraryMapping.libraryName` instead.
  org.apache.tapestry5.services.MarkupWriterFactory.newMarkupWriter(ContentType)
  use `MarkupWriterFactory.newMarkupWriter(Page)` instead which doesn't rely on the content type alone.
  org.apache.tapestry5.services.MarkupWriterFactory.newPartialMarkupWriter(ContentType)
  use `MarkupWriterFactory.newPartialMarkupWriter(Page)` instead which doesn't rely on the content type alone.
  org.apache.tapestry5.services.messages.ComponentMessagesSource.getMessages(ComponentModel, Locale)
  Deprecated in 5.3; use `ComponentMessagesSource.getMessages(ComponentModel, ComponentResourceSelector)` instead.
  org.apache.tapestry5.test.SeleniumTestCase.waitForAjaxRequestsToComplete(String)
  Deprecated in 5.4 in favor of the version without a timeout
  org.apache.tapestry5.test.SeleniumTestCase.waitForElementToDisappear(String)
  Deprecated in 5.4 with no replacement
  org.apache.tapestry5.test.TapestryTestCase.train_toClientURL(Asset, String)
  Deprecated in 5.4 with no replacement.

- Deprecated Constructors
  Constructor
  Description
  org.apache.tapestry5.services.javascript.StylesheetOptions(String, String)
  In 5.3, may be removed in a later release. Use `StylesheetOptions(String)` and `StylesheetOptions.withCondition(String)`} instead.
  org.apache.tapestry5.services.PageRenderRequestParameters(String, EventContext)
  Use `PageRenderRequestParameters(String, EventContext, boolean)`.

- Deprecated Enum Constants
  Enum Constant
  Description
  org.apache.tapestry5.corelib.ClientValidation.BLUR
  Deprecated in 5.4, and no longer supported.
  org.apache.tapestry5.services.javascript.InitializationPriority.IMMEDIATE
  Deprecated in 5.4; this is now treated as "earlier than early".
  org.apache.tapestry5.services.javascript.StackExtensionType.INITIALIZATION
  Deprecated in 5.4 with no replacement; initialization may be removed in the future.