Package org.apache.tapestry5.internal.services
[INTERNAL USE ONLY] internal service classes; API subject to change
-
Interface Summary Interface Description AjaxPartialResponseRenderer Used to render portions of a page as part of an Ajax request.ClassNameHolder Interface that defines types who provide a class name for URLChangeTracker purposes.ClientPersistentFieldStorage Describes an object that can storePersistentFieldChanges, and manage a query parameter stored into aLinkto maining this data across requests.ComponentClassCache A cache for converting between class names and component (or other) classes.ComponentDependencyGraphvizGenerator Service that generates a Graphviz DOT description file for a given component's dependency graph or for the whole set of dependencies of all components.ComponentDependencyRegistry Internal service that registers direct dependencies between components (including components, pages and base classes).ComponentInstantiatorSource CreatesInstantiators for components, based on component class name.ComponentModelSource Access to component models (as provided viaComponentInstantiatorSource).ComponentResourcesOperation Deprecated. In Tapestry 5.4; useMethodAdviceand other parts of the new (in 5.3) plastic library.ComponentTemplateSource Provides access to cachedComponentTemplates.CookieSink You can write cookies to it.CookieSource Provides the cookies from the browser.DocumentLinker Responsible for injecting script and style links into the <head> and <body> element of the rendered HTML document.EndOfRequestEventHub Manages request notifications for theEndOfRequestListenerinterface.ForceReload Forces a reload of all caches and invalidates the component class cache.FormControlNameManager Service providing methods related to names that shouldn't be used as form control element names or ids.Instantiator An object that can instantiate a component.InternalComponentInvalidationEventHub Split-out implementation ofInvalidationEventHubthat separates it fromComponentInstantiatorSource.InternalRequestGlobals Stores global per-request data internal to the framework.LinkSource A source forLinkobjects.MessagesBundle Represents a bundle of properties files that can be used to collect properties that are eventually used to form aMessages.MessagesSource PageActivationContextCollector Fires theEventConstants.PASSIVATEevent on a page, and collects the result, converting it to an array of objects.PageActivator Responsible for firing the EventConstants.ACTIVATE event on the page.PageContentTypeAnalyzer PageElementFactory Used by thePageLoaderto create partialar page elements.PageLoader Instantiates a fully loaded, configured instance of a Tapestry page.PageMarkupRenderer Service used to render page markup using a MarkupWriter.PageRenderQueue A wrapper aroundRenderQueue, but referencable as a (per-thread) service.PageResponseRenderer Service responsible for writing a full page markup response.PageSource Access to localized page instances (which are now shared singletons, starting in release 5.2).PersistentFieldManager Handle persistent property changes.ReloadHelper Forces a reload of all caches and invalidates the component class cache.RequestEncodingInitializer Determines the reuest encoding for the given page and applies that to the request, so that parameters may be properly decoded.RequestPageCache Per-thread service that caches page instances for the duration of the request, and is also responsible for tracking the active page (the page which will ultimately render the response).RequestSecurityManager Used to manage the relationship between the security of a request and the security of a page.ResourceDigestManager Deprecated. Deprecated in 5.4 with no replacement; see release notes about classpath assets moving to /META-INF/assets/.ResourceStreamer Responsible for streaming the contents of a resource to the client.StringProvider Interface used when assembling an attribute value that contains expansions.TemplateParser Parses a resource into aComponentTemplate.UnknownActivationContextHandler Responsible for handling the response for a page called with an unknown activation context when the check itself is enabled. -
Class Summary Class Description AbstractAsset Base class for assets.AbstractAssetFactory AbstractSessionPersistentFieldStrategy Base class for strategies that store their values as keys in the session.AjaxComponentEventRequestHandler Similar toComponentEventRequestHandlerImpl, but built around the Ajax request cycle, where the action request sends back an immediate JSON response containing the new content.AjaxComponentInstanceEventResultProcessor Performs a partial page render based on a root component.AjaxFilter A filter that intercepts Ajax-oriented requests, thos that originate on the client-side using XmlHttpRequest.AjaxLinkComponentEventResultProcessor HandlesLinkresult types by building a JSON response with key "redirectURL".AjaxPageClassComponentEventResultProcessor Processes a Class result by converting the Class to a logical page name, then processing that.AjaxPageNameComponentEventResultProcessor AComponentEventResultProcessor, used for Ajax requests, for a String value that is interpreted as a logical page name.AjaxPartialResponseRendererImpl AjaxURLComponentEventResultProcessor HandlesURLresult types by building a JSON response with key "redirectURL".ApplicationMessageCatalogObjectProvider Allows for injection of the global application message catalog into services.ApplicationStackTraceElementAnalyzer Identifies frames for application classes.ApplicationStateManagerImpl ApplicationStatePersistenceStrategySourceImpl ArrayEventContext Simple implementation ofEventContext.AssetDispatcher Recognizes requests where the path begins with "/asset/" (actually, as defined by theSymbolConstants.ASSET_PATH_PREFIXsymbol), and delivers the content therein as a bytestream.AssetInjectionProvider Performs injection of assets, based on the presence of thePathannotation.AssetObjectProvider Exposes assets (in the current locale).AssetSourceImpl AttributeExpansionBinding Wraps aStringProvideras a read-onlyBinding.AttributeInfo Tracks the qualified name and value of an attribute within a start element XMLToken.BeanBlockOverrideSourceImpl BeanBlockSourceImpl BindingSourceImpl BlockInjectionProvider CheckForUpdatesFilter Implements a barrier that periodically asks theUpdateListenerHubto check for updates to files.ClasspathAssetAliasManagerImpl ClasspathAssetFactory Generates Assets for files on the classpath.ClassResultProcessor Used when a component event handler returns a class value.ClientBehaviorSupportImpl ClientDataEncoderImpl ClientDataSinkImpl ClientPersistentFieldStorageImpl Manages client-persistent values on behalf of aClientPersistentFieldStorageImpl.ClientPersistentFieldStrategy Implements simple client-persistent properties.CommonResourcesInjectionProvider Allows for a number of anonymous injections based on the type of field that is to be injected.ComponentClassCacheImpl ComponentClassResolverImpl ComponentDefaultProviderImpl ComponentDependencyGraphvizGeneratorImpl ComponentDependencyRegistryImpl ComponentEventDispatcher Processes component action events sent as requests from the client.ComponentEventImpl ComponentEventLinkEncoderImpl ComponentEventRequestHandlerImpl ComponentInstanceResultProcessor ComponentInstantiatorSourceImpl A wrapper around aPlasticManagerthat allows certain classes to be modified as they are loaded.ComponentMessagesSourceImpl ComponentModelSourceImpl ComponentRequestHandlerTerminator Terminator for theComponentRequestHandlerpipeline, that feeds out into theComponentEventRequestHandlerandPageRenderRequestHandlerpipelines.ComponentResultProcessorWrapper A wrapper aroundComponentEventResultProcessorthat encapsulates capturing the exception.ComponentSourceImpl ComponentTemplateSourceImpl Service implementation that manages a cache of parsed component templates.CompositeFieldValidator Aggregates together a number of field validator instances as a single unit.ContextAssetFactory Implementation ofAssetFactoryfor assets that are part of the web application context.ContextPathEncoderImpl ContextResource A resource stored with in the web application context.ContextValueEncoderImpl CookiesImpl Implementation of theCookiesservice interface.DateUtilitiesImpl DefaultInjectionProvider Worker for theInjectannotation that delegates out to the masterMasterObjectProviderto access the value.DefaultRequestExceptionHandler Default implementation ofRequestExceptionHandlerthat displays the standard ExceptionReport page.DeferredResponseRenderer After processing the component event request (including Ajax requests), or the page render request, checks for theTapestryConstants.RESPONSE_RENDERERrequest attribute, and invokes it to render the deferred response.DocumentLinkerImpl DTDData A capturing of the data fromLexicalHandler.startDTD(String, String, String).EndOfRequestEventHubImpl EnumValueEncoderFactory<E extends java.lang.Enum<E>> Deprecated. this class is superseded byTypeCoercedValueEncoderFactoryand scheduled to be removed in Tapestry 5.5EnumValueLabelProvider<T extends java.lang.Enum> Provides a label from enum.EnvironmentalShadowBuilderImpl EnvironmentImpl A non-threadsafe implementation (expects to use the "perthread" service lifecyle).EventImpl ExternalUrlAssetFactory FieldTranslatorImpl<T> FieldTranslatorSourceImpl FieldValidationSupportImpl FieldValidatorDefaultSourceImpl FieldValidatorImpl FieldValidatorSourceImpl FlashPersistentFieldStrategy The "flash" strategy stores data inside thesession, just likeSessionPersistentFieldStrategy, but also removes the values from the session on first use.FormControlNameManagerImpl GenericValueEncoderFactory<V> An implementation ofValueEncoderFactorythat returns a pre-wired instance ofValueEncoder.HeartbeatImpl HiddenFieldLocationRulesImpl Html5SupportImpl HttpErrorComponentEventResultProcessor HandlesHttpErrorby invokingResponse.sendError(int, String).HttpStatusComponentEventResultProcessor HandlesHttpStatus.values returned by event handler methods.IdentityAssetPathConverter Returns the default asset path unchanged.IgnoredPathsFilter InternalComponentInvalidationEventHubImpl InternalRequestGlobalsImpl JSONCollectionEventResultProcessor JSONObjectEventResultProcessor Implementation ofComponentEventResultProcessorforJSONObject, allowing a component event handler to return a JSONObject that will be sent directly to the client as the reply.LinkDecorationListener A defaultLinkCreationListener2that triggers theEventConstants.DECORATE_COMPONENT_EVENT_LINKandEventConstants.DECORATE_PAGE_RENDER_LINKevents as links are generated.LinkImpl LinkSourceImpl LocalizationSetterImpl Given a set of supported locales, for a specified desired locale, sets the current thread's locale to a supported locale that is closest to the desired.MapMessages Implementation ofMessagesbased on a simple Map (of string keys and values).MarkupRendererTerminator Terminator for the [@link MarkupRenderer} pipeline, which exists to invokePageRenderQueue.render(org.apache.tapestry5.MarkupWriter).MarkupWriterFactoryImpl MarkupWriterImpl MavenComponentLibraryInfoSource ComponentLibraryInfoSourceimplementation based on the pom.xml and pom.properties files Maven places in the /META-INF/maven/[groupId]/[artifactId] folder.MessagesSourceImpl A utility class that encapsulates all the logic for reading properties files and assemblingMessagesfrom them, in accordance with extension rules and locale.MessagesTrackingInfo Class that holds information about a messages properties file for tracking.MetaDataLocatorImpl MethodInvocationFailResult Implementation ofMethodInvocationResultfor failed invocations (where a checked exception was thrown).MethodInvocationSuccessfulResult Implementation ofMethodInvocationResultfor successful method invocations.ModuleInitsManager NullFieldStrategySourceImpl ObjectComponentEventResultProcessor A catch-all for type Object that reports the return value as an error.OpenApiDescriptionDispatcher Recognizes requests where the path matches the value ofSymbolConstants.OPENAPI_DESCRIPTION_PATH(/openapi.jsonby default).PageActivationContextCollectorImpl PageActivatorImpl PageContentTypeAnalyzerImpl PageDocumentGeneratorImpl PageElementFactoryImpl PageMarkupRendererImpl PageNameComponentEventResultProcessor Used when a component event handler returns a string value.PageNameMetaInjector Injects a<meta/>element into the<head/>to identify the Tapestry page name.PageRenderDispatcher Dispatches incoming requests for render requests.PageRenderLinkSourceImpl PageRenderQueueImpl This services keeps track of the page being rendered and the root command for the partial render, it is therefore request/thread scoped.PageRenderRequestHandlerImpl Handles a page render request by activating and then rendering the page.PageResponseRendererImpl PageSourceImpl PartialMarkupDocumentLinker PartialMarkupRendererTerminator Terminator for thePartialMarkupRendererpipeline, which ultimately invokesPageRenderQueue.renderPartial(org.apache.tapestry5.MarkupWriter, org.apache.tapestry5.json.JSONObject).PartialTemplateRendererImpl PathConstructorImpl PersistentFieldBundleImpl PersistentFieldChangeImpl PersistentFieldManagerImpl PersistentLocaleImpl PrefixCheckStackTraceElementAnalyzer Checks to see if a class has a given prefix to its class name.ProductionModeUnknownComponentFilter A filter, used only in production mode, that does a "pre-flight check" that the indicated component actually exists.PropertyValueLabelProvider Provides a label from a property of the passed object.ProxiesStackTraceElementAnalyzer Identifies frames for various proxy classes (class name starts with a '$' and there's no line number.RegexpStackTraceElementAnalyzer Uses a regular expression to identify which CSS class to apply to a frame.ReloadHelperImpl RenderCommandComponentEventResultProcessor Processor for objects that implementRenderCommand(such asBlockImpl), used with an Ajax component event.RenderQueueImpl RequestConstants Constants used when processing requests from the client web browser.RequestErrorFilter Filter for theRequestHandlerpipeline used to intercept and report exceptions.RequestOperationTracker UsesOperationTrackerto add an operation generally describing each request.RequestPageCacheImpl In Tapestry 5.1, the implementation of this worked with the page pool (a pool of page instances, reserved to individual requests/threads).RequestSecurityManagerImpl ResourceDigestGeneratorImpl Gutted implementation; will be removed in Tapestry 5.5.ResourceDigestManagerImpl ResourceStreamerImpl ResponseRendererImpl RestoreDirtySessionObjects A listener that invokesSession.restoreDirtyObjects().RootPathDispatcher Recognizes a request for the application root (i.e., "/") and handles this the same as a render request for the "Start" page.SaxTemplateParser SAX-based template parser logic, taking aResourceto a Tapestry template file and returning aComponentTemplate.SelectModelFactoryImpl ServiceAnnotationObjectProvider Adds support for theServiceannotation (which can be applied to fields or parameters), which is used to disambiguate injection when multiple services implement the same service interface.ServiceInjectionProvider A very late worker related to theInjectannotation that, when all other forms of injection have failed, matches the field type to a service interface.SessionApplicationStatePersistenceStrategy Stores ASOs in theSession, which will be created as necessary.SessionPersistentFieldStrategy A strategy for storing persistent page properties into thesession.StaticFilesFilter Identifies requests that are for actual resource files in the context.StreamPageContentResultProcessor Used to trigger the rendering of a particular page without causing a redirect to that page.StreamResponseResultProcessor StringValueEncoder Passes the string value from the server to the client and vice-versa without any translation.SyntheticStackTraceElementAnalyzer Identifies any code associated with line 1 as omitted (i.e., it's a synthetic method related to an inner class).TapestryAOPStackFrameAnalyzer Encapsulates a number of tests for identifying stack frames that are a side-effect of various Tapestry Aspect Oriented Programming and other code generation behaviors.TemplateParserImpl Parses Tapestry XML template files intoComponentTemplateinstances.TemplateTrackingInfo Class that holds information about a template for tracking.TranslatorAlternatesSourceImpl TranslatorSourceImpl TypeCoercedValueEncoderFactory ProvidesValueEncoderinstances that are backed by theTypeCoercerservice.UnknownActivationContextHandlerImpl Default implementation forUnknownActivationContextHandlerwhich answer with a 404 NOT FOUND error.UrlAsset URLEncoderImpl UrlResource ValidationConstraintGeneratorImpl ValidationDecoratorFactoryImpl ValidatorSpecification Validator type and constraint values parsed from a validator specification.ValueEncoderSourceImpl XMLTokenStream Parses a document as a stream of XML tokens. -
Enum Summary Enum Description ComponentDependencyRegistry.DependencyType Enum class defining the types of dependency components, pages and mixins can have among them.ResourceStreamer.Options Used to customize the behavior ofResourceStreamer.streamResource(org.apache.tapestry5.commons.Resource, java.lang.String, java.util.Set).XMLTokenType Identifies type ofXMLToken. -
Exception Summary Exception Description MethodCompileException Exception thrown when a method body fails to compile; this will allow the method body to be displayed to the user on the request failure page.RenderQueueException Exception used when rendering, to capture the stack of active components (for propery reporting in the exception page).RestEndpointNotFoundException Exception used when a request is made to a page with REST endpoint event handlers but doesn't match any of them. -
Annotation Types Summary Annotation Type Description ComponentInstanceProcessor Marker forComponentEventResultProcessorto identify the particular implementation used for handlingComponentinstances (i.e., pages).