//

// Licensed under the Apache License, Version 2.0 (the "License");

// you may not use this file except in compliance with the License.

// You may obtain a copy of the License at

//

// http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software

// distributed under the License is distributed on an "AS IS" BASIS,

// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

// See the License for the specific language governing permissions and

// limitations under the License.

* The root module for Tapestry.

*/

{ "JavaDoc" })

    private final PipelineBuilder pipelineBuilder;

    private final ApplicationGlobals applicationGlobals;

    private final PropertyShadowBuilder shadowBuilder;

    private final Environment environment;

    private final StrategyBuilder strategyBuilder;

    private final PropertyAccess propertyAccess;

    private final ChainBuilder chainBuilder;

    private final Request request;

    private final Response response;

    private final RequestGlobals requestGlobals;

    private final EnvironmentalShadowBuilder environmentalBuilder;

    private final EndOfRequestEventHub endOfRequestEventHub;

    /**

     * We inject all sorts of common dependencies (including builders) into the

     * module itself (note: even though some of

     * these service are defined by the module itself, that's ok because

     * services are always lazy proxies). This isn't

     * about efficiency (it may be slightly more efficient, but not in any

     * noticable way), it's about eliminating the

     * need to keep injecting these dependencies into individual service builder

     * and contribution methods.

     */

    public TapestryModule(PipelineBuilder pipelineBuilder,

    PropertyShadowBuilder shadowBuilder,

    RequestGlobals requestGlobals,

    ApplicationGlobals applicationGlobals,

    ChainBuilder chainBuilder,

    Environment environment,

    StrategyBuilder strategyBuilder,

    PropertyAccess propertyAccess,

    Request request,

    Response response,

    EnvironmentalShadowBuilder environmentalBuilder,

    EndOfRequestEventHub endOfRequestEventHub)

    {

        this.pipelineBuilder = pipelineBuilder;

        this.shadowBuilder = shadowBuilder;

        this.requestGlobals = requestGlobals;

        this.applicationGlobals = applicationGlobals;

        this.chainBuilder = chainBuilder;

        this.environment = environment;

        this.strategyBuilder = strategyBuilder;

        this.propertyAccess = propertyAccess;

        this.request = request;

        this.response = response;

        this.environmentalBuilder = environmentalBuilder;

        this.endOfRequestEventHub = endOfRequestEventHub;

    }

    // A bunch of classes "promoted" from inline inner class to nested classes,

    // just so that the stack trace would be more readable. Most of these

    // are teminators for pipeline services.

    /**

     * @since 5.1.0.0

     */

    private class ApplicationInitializerTerminator implements ApplicationInitializer

    {

        public void initializeApplication(Context context)

        {

            applicationGlobals.storeContext(context);

        }

    }

    /**

     * @since 5.1.0.0

     */

    private class HttpServletRequestHandlerTerminator implements HttpServletRequestHandler

    {

        private final RequestHandler handler;

        private final String applicationCharset;

        private final SessionPersistedObjectAnalyzer analyzer;

        public HttpServletRequestHandlerTerminator(RequestHandler handler, String applicationCharset,

                SessionPersistedObjectAnalyzer analyzer)

        {

            this.handler = handler;

            this.applicationCharset = applicationCharset;

            this.analyzer = analyzer;

        }

        public boolean service(HttpServletRequest servletRequest, HttpServletResponse servletResponse)

                throws IOException

        {

            requestGlobals.storeServletRequestResponse(servletRequest, servletResponse);

            Request request = new RequestImpl(servletRequest, applicationCharset, analyzer);

            Response response = new ResponseImpl(servletRequest, servletResponse);

            // TAP5-257: Make sure that the "initial guess" for request/response

            // is available, even if

            // some filter in the RequestHandler pipeline replaces them.

            requestGlobals.storeRequestResponse(request, response);

            // Transition from the Servlet API-based pipeline, to the

            // Tapestry-based pipeline.

            return handler.service(request, response);

        }

    }

    /**

     * @since 5.1.0.0

     */

    private class ServletApplicationInitializerTerminator implements ServletApplicationInitializer

    {

        private final ApplicationInitializer initializer;

        public ServletApplicationInitializerTerminator(ApplicationInitializer initializer)

        {

            this.initializer = initializer;

        }

        public void initializeApplication(ServletContext servletContext)

        {

            applicationGlobals.storeServletContext(servletContext);

            // And now, down the (Web) ApplicationInitializer pipeline ...

            ContextImpl context = new ContextImpl(servletContext);

            applicationGlobals.storeContext(context);

            initializer.initializeApplication(context);

        }

    }

     * @since 5.1.0.0

     */

    private class RequestHandlerTerminator implements RequestHandler

    {

        private final Dispatcher masterDispatcher;

        public RequestHandlerTerminator(Dispatcher masterDispatcher)

        {

            this.masterDispatcher = masterDispatcher;

        }

        public boolean service(Request request, Response response) throws IOException

        {

            // Update RequestGlobals with the current request/response (in case

            // some filter replaced the

            // normal set).

            requestGlobals.storeRequestResponse(request, response);

            return masterDispatcher.dispatch(request, response);

        }

    }

    public static void bind(ServiceBinder binder)

    {

        binder.bind(ClasspathAssetAliasManager.class, ClasspathAssetAliasManagerImpl.class);

        binder.bind(PersistentLocale.class, PersistentLocaleImpl.class);

        binder.bind(ApplicationStateManager.class, ApplicationStateManagerImpl.class);

        binder.bind(ApplicationStatePersistenceStrategySource.class,

                ApplicationStatePersistenceStrategySourceImpl.class);

        binder.bind(BindingSource.class, BindingSourceImpl.class);

        binder.bind(FieldValidatorSource.class, FieldValidatorSourceImpl.class);

        binder.bind(ApplicationGlobals.class, ApplicationGlobalsImpl.class);

        binder.bind(AssetSource.class, AssetSourceImpl.class);

        binder.bind(Cookies.class, CookiesImpl.class);

        binder.bind(FieldValidatorDefaultSource.class, FieldValidatorDefaultSourceImpl.class);

        binder.bind(RequestGlobals.class, RequestGlobalsImpl.class);

        binder.bind(ResourceDigestGenerator.class, ResourceDigestGeneratorImpl.class);

        binder.bind(ValidationConstraintGenerator.class, ValidationConstraintGeneratorImpl.class);

        binder.bind(EnvironmentalShadowBuilder.class, EnvironmentalShadowBuilderImpl.class);

        binder.bind(ComponentSource.class, ComponentSourceImpl.class);

        binder.bind(BeanModelSource.class, BeanModelSourceImpl.class);

        binder.bind(BeanBlockSource.class, BeanBlockSourceImpl.class);

        binder.bind(ComponentDefaultProvider.class, ComponentDefaultProviderImpl.class);

        binder.bind(MarkupWriterFactory.class, MarkupWriterFactoryImpl.class);

        binder.bind(FieldValidationSupport.class, FieldValidationSupportImpl.class);

        binder.bind(ObjectRenderer.class, LocationRenderer.class).withId("LocationRenderer");

        binder.bind(ObjectProvider.class, AssetObjectProvider.class).withId("AssetObjectProvider");

        binder.bind(RequestExceptionHandler.class, DefaultRequestExceptionHandler.class);

        binder.bind(ComponentEventResultProcessor.class, ComponentInstanceResultProcessor.class).withId(

                "ComponentInstanceResultProcessor");

        binder.bind(NullFieldStrategySource.class, NullFieldStrategySourceImpl.class);

        binder.bind(HttpServletRequestFilter.class, IgnoredPathsFilter.class).withId("IgnoredPathsFilter");

        binder.bind(ContextValueEncoder.class, ContextValueEncoderImpl.class);

        binder.bind(BaseURLSource.class, BaseURLSourceImpl.class);

        binder.bind(BeanBlockOverrideSource.class, BeanBlockOverrideSourceImpl.class);

        binder.bind(AliasManager.class, AliasManagerImpl.class).withId("AliasOverrides");

        binder.bind(HiddenFieldLocationRules.class, HiddenFieldLocationRulesImpl.class);

        binder.bind(PageDocumentGenerator.class, PageDocumentGeneratorImpl.class);

        binder.bind(ResponseRenderer.class, ResponseRendererImpl.class);

        binder.bind(FieldTranslatorSource.class, FieldTranslatorSourceImpl.class);

        binder.bind(BindingFactory.class, MessageBindingFactory.class).withId("MessageBindingFactory");

        binder.bind(BindingFactory.class, ValidateBindingFactory.class).withId("ValidateBindingFactory");

        binder.bind(BindingFactory.class, TranslateBindingFactory.class).withId("TranslateBindingFactory");

        binder.bind(BindingFactory.class, AssetBindingFactory.class).withId("AssetBindingFactory");

        binder.bind(BindingFactory.class, ContextBindingFactory.class).withId("ContextBindingFactory");

        binder.bind(BindingFactory.class, NullFieldStrategyBindingFactory.class).withId(

                "NullFieldStrategyBindingFactory");

        binder.bind(BindingFactory.class, SymbolBindingFactory.class).withId("SymbolBindingFactory");

        binder.bind(URLEncoder.class, URLEncoderImpl.class);

        binder.bind(ContextPathEncoder.class, ContextPathEncoderImpl.class);

        binder.bind(ApplicationStatePersistenceStrategy.class, SessionApplicationStatePersistenceStrategy.class)

                .withId("SessionApplicationStatePersistenceStrategy");

        binder.bind(AssetPathConverter.class, IdentityAssetPathConverter.class);

        binder.bind(NumericTranslatorSupport.class);

        binder.bind(ClientDataEncoder.class, ClientDataEncoderImpl.class);

        binder.bind(ComponentEventLinkEncoder.class, ComponentEventLinkEncoderImpl.class);

        binder.bind(PageRenderLinkSource.class, PageRenderLinkSourceImpl.class);

        binder.bind(ClientInfrastructure.class, ClientInfrastructureImpl.class);

        binder.bind(URLRewriter.class, URLRewriterImpl.class);

        binder.bind(ValidatorMacro.class, ValidatorMacroImpl.class);

        binder.bind(PropertiesFileParser.class, PropertiesFileParserImpl.class);

        binder.bind(PageActivator.class, PageActivatorImpl.class);

        binder.bind(Dispatcher.class, AssetDispatcher.class).withId("AssetDispatcher");

        binder.bind(AssetPathConstructor.class, AssetPathConstructorImpl.class);

        binder.bind(JavaScriptStackSource.class, JavaScriptStackSourceImpl.class);

        binder.bind(TranslatorAlternatesSource.class, TranslatorAlternatesSourceImpl.class);

        binder.bind(MetaWorker.class, MetaWorkerImpl.class);

        binder.bind(LinkTransformer.class, LinkTransformerImpl.class);

        binder.bind(SelectModelFactory.class, SelectModelFactoryImpl.class);

    }

    // ========================================================================

    //

    // Service Builder Methods (static)

    //

    // ========================================================================

    @PreventServiceDecoration

    public static Alias buildAlias(Logger logger,

    @Symbol(InternalSymbols.ALIAS_MODE)

    String mode,

    @InjectService("AliasOverrides")

    AliasManager overridesManager,

    Collection<AliasContribution> configuration)

    {

        AliasManager manager = new AliasManagerImpl(logger, configuration);

        return new AliasImpl(manager, mode, overridesManager);

    }

    // ========================================================================

    //

    // Service Contribution Methods (static)

    //

    // ========================================================================

    /**

     * Contributes the factory for serveral built-in binding prefixes ("asset",

     * "block", "component", "literal", prop",

     * "nullfieldstrategy", "message", "validate", "translate", "var").

     */

    public static void contributeBindingSource(MappedConfiguration<String, BindingFactory> configuration,

    @InjectService("PropBindingFactory")

    BindingFactory propBindingFactory,

    @InjectService("MessageBindingFactory")

    BindingFactory messageBindingFactory,

    @InjectService("ValidateBindingFactory")

    BindingFactory validateBindingFactory,

    @InjectService("TranslateBindingFactory")

    BindingFactory translateBindingFactory,

    @InjectService("AssetBindingFactory")

    BindingFactory assetBindingFactory,

    @InjectService("NullFieldStrategyBindingFactory")

    BindingFactory nullFieldStrategyBindingFactory,

    @InjectService("ContextBindingFactory")

    BindingFactory contextBindingFactory,

    @InjectService("SymbolBindingFactory")

    BindingFactory symbolBindingFactory)

    {

        configuration.add(BindingConstants.LITERAL, new LiteralBindingFactory());

        configuration.add(BindingConstants.COMPONENT, new ComponentBindingFactory());

        configuration.add(BindingConstants.VAR, new RenderVariableBindingFactory());

        configuration.add(BindingConstants.BLOCK, new BlockBindingFactory());

        configuration.add(BindingConstants.PROP, propBindingFactory);

        configuration.add(BindingConstants.MESSAGE, messageBindingFactory);

        configuration.add(BindingConstants.VALIDATE, validateBindingFactory);

        configuration.add(BindingConstants.TRANSLATE, translateBindingFactory);

        configuration.add(BindingConstants.ASSET, assetBindingFactory);

        configuration.add(BindingConstants.NULLFIELDSTRATEGY, nullFieldStrategyBindingFactory);

        configuration.add(BindingConstants.CONTEXT, contextBindingFactory);

        configuration.add(BindingConstants.SYMBOL, symbolBindingFactory);

    }

    public static void contributeClasspathAssetAliasManager(MappedConfiguration<String, String> configuration,

    @Symbol(SymbolConstants.APPLICATION_VERSION)

    String applicationVersion,

    @Symbol(InternalConstants.TAPESTRY_APP_PACKAGE_PARAM)

    String appPackage,

    ComponentClassResolver resolver)

    {

        configuration.add("tapestry", "org/apache/tapestry5");

        configuration.add("app", toPackagePath(appPackage));

        // Each library gets a mapping or its folder automatically

        Map<String, String> folderToPackageMapping = resolver.getFolderToPackageMapping();

        for (String folder : folderToPackageMapping.keySet())

        {

            configuration.add(folder, toPackagePath(folderToPackageMapping.get(folder)));

        }

    }

    /**

     * Contributes an handler for each mapped classpath alias, as well handlers for context assets

     * and stack assets (combined {@link JavaScriptStack} files).

     */

    public static void contributeAssetDispatcher(MappedConfiguration<String, AssetRequestHandler> configuration,

    @ContextProvider

    AssetFactory contextAssetFactory,

    @Autobuild

    StackAssetRequestHandler stackAssetRequestHandler,

    ResourceCache resourceCache,

    ClasspathAssetAliasManager classpathAssetAliasManager, ResourceStreamer streamer,

            AssetResourceLocator assetResourceLocator)

    {

        resourceCache.addInvalidationListener(stackAssetRequestHandler);

        Map<String, String> mappings = classpathAssetAliasManager.getMappings();

        for (String folder : mappings.keySet())

        {

            String path = mappings.get(folder);

            configuration.add(folder, new ClasspathAssetRequestHandler(streamer, assetResourceLocator, path));

        }

        configuration.add(RequestConstants.CONTEXT_FOLDER,

                new ContextAssetRequestHandler(streamer, contextAssetFactory.getRootResource()));

        configuration.add(RequestConstants.STACK_FOLDER, stackAssetRequestHandler);

    }

    private static String toPackagePath(String packageName)

    {

        return packageName.replace('.', '/');

    }

    public static void contributeComponentClassResolver(Configuration<LibraryMapping> configuration)

    {

        configuration.add(new LibraryMapping("core", "org.apache.tapestry5.corelib"));

    }

    /**

     * Adds a number of standard component class transform workers:

     * <dl>

     * <dt>Retain</dt>

     * <dd>Allows fields to retain their values between requests</dd>

     * <dt>Persist</dt>

     * <dd>Allows fields to store their their value persistently between requests</dd>

     * <dt>Parameter</dt>

     * <dd>Identifies parameters based on the {@link org.apache.tapestry5.annotations.Parameter} annotation</dd>

     * <dt>Component</dt>

     * <dd>Defines embedded components based on the {@link org.apache.tapestry5.annotations.Component} annotation</dd>

     * <dt>Mixin</dt>

     * <dd>Adds a mixin as part of a component's implementation</dd>

     * <dt>Environment</dt>

     * <dd>Allows fields to contain values extracted from the {@link org.apache.tapestry5.services.Environment} service</dd>

     * <dt>Inject</dt>

     * <dd>Used with the {@link org.apache.tapestry5.ioc.annotations.Inject} annotation, when a value is supplied</dd>

     * <dt>InjectService</dt>

     * <dd>Handles the {@link org.apache.tapestry5.ioc.annotations.InjectService} annotation</dd>

     * <dt>InjectPage</dt>

     * <dd>Adds code to allow access to other pages via the {@link org.apache.tapestry5.annotations.InjectPage} field

     * annotation</dd>

     * <dt>InjectBlock</dt>

     * <dd>Allows a block from the template to be injected into a field</dd>

     * <dt>IncludeStylesheet</dt>

     * <dd>Supports the {@link org.apache.tapestry5.annotations.IncludeStylesheet} annotation</dd>

     * <dt>IncludeJavaScriptLibrary</dt>

     * <dd>Supports the {@link org.apache.tapestry5.annotations.IncludeJavaScriptLibrary} annotation</dd>

     * <dt>Import</dt>

     * <dd>Supports the {@link Import} annotation</dd>

     * <dt>SupportsInformalParameters</dt>

     * <dd>Checks for the annotation</dd>

     * <dt>Meta</dt>

     * <dd>Checks for meta data annotations and adds it to the component model</dd>

     * <dt>ApplicationState</dt>

     * <dd>Converts fields that reference application state objects

     * <dt>UnclaimedField</dt>

     * <dd>Identifies unclaimed fields and resets them to null/0/false at the end of the request</dd>

     * <dt>RenderCommand</dt>