Package org.apache.tapestry5.services
package org.apache.tapestry5.services
Core services
-
ClassDescriptionMarker annotation for services related to processing an Ajax request (rather than a traditional request).A contribution to the configuration of the
ApplicationStateManager
, identifying the strategy and creator for a particular Session State Object (SSO), identified by the SSO's class.Used byApplicationStateManager
andApplicationStatePersistenceStrategy
to create a Session State Object (SSO) on demand.Responsible for managing Session State Objects (SSO), objects which persist between requests but are not tied to any individual page or component.Used byApplicationStateManager
to manage a specific kind of Session State Object (SSO) persistence.Used to provide access toApplicationStatePersistenceStrategySource
instances via a logical name for the strategy, such as "session".Deprecated.Deprecated in 5.4 (see notes inClasspathAssetAliasManager
).Used byAssetSource
to create newAsset
s as needed.Class that represents the exception of an asset not being found.Converts the path (or URI) of an asset into a new format.Marker annotation used to specifically identify theDispatcher
used to dispatch asset requests (so thatAssetRequestHandler
s can be contributed).Used to find or create anAsset
with a given path.A contribution to theBeanBlockSource
service, defining a page name and block id (within the page) that can edit or display a particular type of property.Used to override the defaultBeanBlockSource
for a particular data type.A source ofBlock
s used to display the properties of a bean (used by theGrid
component), or to edit the properties of a bean (used by theBeanEditForm
component).Defines a context for editing a bean viaBeanEditor
.Creates a binding of a particular type.Used to acquire bindings for component parameters.Deprecated.Deprecated in 5.4, with no replacement.Chain-of-responsibility service which defines rules for blocking access to classpath resources based on their paths.A marker annotation used to select the correctAssetFactory
for injection.Deprecated.Deprecated in 5.4 with no replacement.A service used when a component or service needs to encode some amount of data on the client as a string.Allows binary object data to be encoded into a string.Resolves page names and component types to fully qualified class names.A service that can be injected into a component to provide common defaults for various types of parameters.Interface used withTransformationSupport.addEventHandler(String, int, String, ComponentEventHandler)
}.Responsible for creatingLink
s for page render requests and for component event requests, and for parsing incoming paths to identify requests that are component event or page render requests.Filter interface forComponentEventRequestHandler
.Handler interface for component event requests.Encapsulates all the information that may be provided in a component event request URL.Responsible for handling the return value provided by a component event handler method.Class that encapsulates information about a component library, going beyond what a library mapping provides.DefaultComponentLibraryInfo.SourceUrlResolver
implementation.Interface that provides the source URL for a givenComponentLibraryInfo
.Service that provides information about component libraries.Marker annotation used to inject the correctInvalidationEventHub
service responsible for validations when component message catalog (i.e., ".properties") files change.Service that allows replacing one component, page or mixin class by another without changing the sources.Filter interface forComponentRequestHandler
.A facade aroundComponentEventRequestHandler
andPageRenderRequestHandler
that allows for simplified filters that cover both types of requests.Used by classes that need to retrieve a component by its complete id, or a page by its logical page name or root component class.Marker annotation used to inject the correctInvalidationEventHub
service responsible for validations when component template files change.A service to provide utilities needed for event context encoding and decoding to and from (partial) URL paths.Marker annotation to select the correctAssetFactory
for injection.Used to convert values used in event contexts to client string representations and back.Used by other services to obtain cookie values for the current request, or to write cookie values as part of the request.Marker annotation for services that are provided by the Tapestry core module.Formatting utilities for dates; this is primarily used when communicating server-side dates to the clients in ISO-8601 format.Default object renderer as a catch all for classObject
.Class that wraps an Request, delegating all its methods.Contribution toBeanBlockSource
identifying a block that is used to display a property.Contribution toBeanBlockSource
identifying a block that is used to edit a property.Provides access to environment objects, which are almost always provided to enclosed components by enclosing components.Much likePropertyShadowBuilder
, except that instead of accessing a property of some other service, it accesses a value from within theEnvironment
service.Interface implemented by a page used for reporting exceptions.Used by the defaultExceptionReporter
implementation to convert an exception into a stream of text that can be stored to a file.For a particular field, generates the defaultFieldTranslator
for the field.For a particular field, generates the default validation for the field, in accordance with a number of factors and contributions.Used to createFieldValidator
s for a particularField
component.Services provided by an enclosing Form control component to the various form element components it encloses.Allows for deferred execution of logic, useful when trying to get multiple components to coordinate behavior.Provides some assistance in determining where to place a hidden field based on standard (X)HTML elements.Service related to Tapestry's support of HTML5 features.An event handler method may return an instance of this class to send an error response to the client.An event handler method may return an instance of this class to send an specific HTTP status code to the client.Filter contributed into theComponentRequestHandler
pipeline to set theactivePageName property
.Used to configure theComponentClassResolver
, to allow it to map library names to library root packages (the application namespace is a special case of this).A service that allows listeners to be registered to learn aboutLink
creation.Deprecated.UseLinkCreationListener2
insteadSets the thread's locale given a desired locale.An object which will perform rendering of a page (or portion of a page).Filter interface forMarkupRenderer
, which allows for code to execute before and/or after the main rendering process.Source forMarkupWriter
instances.Used to lookup meta data concerning a particular component.Captures the result of invoking a method.A source forNullFieldStrategy
instances based on a logical name.A strategy interface used for converting an object into markup that describes that object.Interface used to programatically render a page, forming aDocument
which can then be manipulated or streamed to a PrintWriter.A service that allows other services to create page render links.Filter interface forPageRenderRequestHandler
, which allows extra behaviors to be injected into the processing of a page render request.Handles a invocation related to rendering out a pages complete content.Used withPageRenderRequestHandler
andPageRenderRequestFilter
to define the logical page name and activation context for the request.Defines an Ajax-oriented partial page render, wherein a render of a portion of a page occurs, and the content is stored into a key ("content") of aJSONObject
, which is sent to the client side as the final response.A filter (the main interface beingPartialMarkupRenderer
) applied when performing a partial page render as part of an Ajax-oriented request.Service that provides methods that renderBlock
s (<t:block>
in the template), component instances andRenderCommand
s to aString
ororg.apache.tapestry5.dom.Document
in a programatic way.Central location for logic related to building client-side paths, taking into account the context path (if any), and theSymbolConstants.APPLICATION_FOLDER
(if any).Encapsulates persisted property information for an entire page.Represents a previously stored change to a persistent field, within the context of a particular page of the application.Defines how changes to fields (within components, within pages) may have their values persisted between requests.Manages the persistent locale stored in the browser (inside the URL).Defines a context for editing a property of a bean viaBeanEditor
.Provides context information needed when displaying a value.Used byHiddenFieldLocationRules
to identify where a hidden field may be placed relative to a particular element.Service invoked when an uncaught exception occurs.Deprecated.Deprecated in 5.4 with no replacement; see release notes about classpath assets moving to /META-INF/assets/, and content checksums inside asset URLsPublic facade around internal services related to rendering a markup response.Used to create anSelectModel
.Used byExceptionDisplay
to characterize each stack frame that is presented.CSS classes, from the default CSS stylesheet, used withStackTraceElementAnalyzer
.An event handler method may return an instance of this class to trigger the rendering of a particular page without causing a redirect to that page; the rendering takes place as part of the original component event request, thus forming the opposite of Tapestry's normal redirect-after-event behavior.Marker annotation for a service that should be used for traditional page oriented requests, as opposed to Ajax requests (that send ad-hoc or partial page markup responses.Constants used by implementationsComponentClassTransformWorker2
.Support code for generating code (used when transforming component classes).This service is used byTranslatorSource
to specifyTranslator
alternates: translators that are used when specified explicitly by name.A source forTranslator
s, either by name or by property type.Service used to encode or decode strings that are placed into URLs.Invoked to generate a list of validation constraint strings for a property.Deprecated.Deprecated in 5.4 with no replacement, asValidationDecorator
is being phased out.A source forValueEncoder
instances of a given type.A source for value encoders based on a property type.An object capable of providing a user-presentable label from a value.