001 // Copyright 2010, 2011 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
015 package org.apache.tapestry5.services.assets;
016
017 /**
018 * Encapsulates the logic or creating the path portion of an asset URL, including
019 * the application version.
020 *
021 * @since 5.2.0
022 */
023 public interface AssetPathConstructor
024 {
025 /**
026 * Constructs an asset URL path from the virtual folder and path (within the virtual folder).
027 *
028 * @param virtualFolder
029 * corresponds to a {@link AssetRequestHandler} contributed to the AssetDispatcher service
030 * @param path
031 * within the virtual folder (should <em>not</em> start with a slash)
032 * @return path portion of asset URL, including the context path, the /assets/ virtual folder, the application
033 * version number,
034 * the virtual folder, and the path extension
035 */
036 String constructAssetPath(String virtualFolder, String path);
037 }