001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017package org.apache.wicket.resource; 018 019import java.net.URI; 020import java.nio.file.Path; 021import java.util.Map; 022 023/** 024 * Gets the actual path for a specific file system. Have a look into 025 * {@link org.apache.wicket.resource.FileSystemJarPathService} to find a reference implementation. 026 * 027 * @see org.apache.wicket.resource.FileSystemJarPathService 028 * @author Tobias Soloschenko 029 * 030 */ 031public interface FileSystemPathService 032{ 033 /** 034 * Gets the actual path for a specific file system to work on 035 * 036 * @param uri 037 * the uri to get the path from 038 * @param env 039 * environment variables to be applied to the file system 040 * @return the actual path or null if the implementation is not responsible 041 * 042 */ 043 Path getPath(URI uri, Map<String, String> env); 044 045 /** 046 * Checks if the file system path service is responsible to handle the given URI 047 * 048 * @param uri 049 * the URI to detect if the file system path service is responsible 050 * @return if the file system path service is responsible to handle the given URI 051 */ 052 boolean isResponsible(URI uri); 053}