001    // Copyright 2009 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.internal.services;
016    
017    import org.apache.tapestry5.ioc.Resource;
018    
019    import java.io.IOException;
020    
021    /**
022     * Responsible for converting a path (from {@link org.apache.tapestry5.internal.services.AssetDispatcher} into a {@link
023     * org.apache.tapestry5.ioc.Resource} that can be {@linkplain org.apache.tapestry5.internal.services.ResourceStreamer
024     * streamed to the client}.
025     *
026     * @since 5.1.0.2
027     */
028    public interface AssetResourceLocator
029    {
030        /**
031         * Analyzes the path and identifies the underying Asset Resource for that path. Handles context resources and
032         * checking for a digest.
033         *
034         * @param path to translate
035         * @return resource corresponding to path (may be for a non-existent resource), or null if path is invalid (i.e.,
036         *         incorrect digest)
037         */
038        Resource findResourceForPath(String path) throws IOException;
039    }