001/*
002 * Copyright 2002-2016 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.core.io;
018
019/**
020 * A resolution strategy for protocol-specific resource handles.
021 *
022 * <p>Used as an SPI for {@link DefaultResourceLoader}, allowing for
023 * custom protocols to be handled without subclassing the loader
024 * implementation (or application context implementation).
025 *
026 * @author Juergen Hoeller
027 * @since 4.3
028 * @see DefaultResourceLoader#addProtocolResolver
029 */
030public interface ProtocolResolver {
031
032        /**
033         * Resolve the given location against the given resource loader
034         * if this implementation's protocol matches.
035         * @param location the user-specified resource location
036         * @param resourceLoader the associated resource loader
037         * @return a corresponding {@code Resource} handle if the given location
038         * matches this resolver's protocol, or {@code null} otherwise
039         */
040        Resource resolve(String location, ResourceLoader resourceLoader);
041
042}