001// Copyright 2013 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007// http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5.internal.services.assets;
016
017import org.apache.tapestry5.services.assets.StreamableResource;
018
019import java.io.IOException;
020
021/**
022 * Assembles the individual assets of a {@link org.apache.tapestry5.services.javascript.JavaScriptStack} into
023 * a single resource; this is needed to generate a checksum for the aggregated assets, and also to service the
024 * aggregated stack content.
025 *
026 * @see org.apache.tapestry5.SymbolConstants#COMBINE_SCRIPTS
027 * @since 5.4
028 */
029public interface JavaScriptStackAssembler
030{
031    /**
032     * Obtains the {@link org.apache.tapestry5.services.javascript.JavaScriptStack} by name, and then
033     * uses the {@link org.apache.tapestry5.services.assets.StreamableResourceSource} service to
034     * obtain the assets, which are combined together.
035     * <p/>
036     * Expects the {@linkplain org.apache.tapestry5.services.LocalizationSetter#setNonPersistentLocaleFromLocaleName(String) non-persistent locale} to be set before invoking!
037     */
038    StreamableResource assembleJavaScriptResourceForStack(String stackName, boolean compress) throws IOException;
039}