1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.configuration2.io;
18
19 import java.net.URL;
20
21 /**
22 * A specialized implementation of {@code FileLocationStrategy} which checks whether a passed in {@link FileLocator}
23 * already has a defined URL.
24 * <p>
25 * {@link FileLocator} objects that have a URL already reference a file in an unambiguous way. Therefore, this strategy
26 * just returns the URL of the passed in {@code FileLocator}. It can be used as a first step of the file resolving
27 * process. If it fails, more sophisticated attempts for resolving the file can be made.
28 * </p>
29 * <p>
30 * See {@link AbstractFileLocationStrategy} learn how to grant an deny URL schemes and hosts.
31 * </p>
32 *
33 * @see AbstractFileLocationStrategy
34 * @since 2.0
35 */
36 public class ProvidedURLLocationStrategy extends AbstractFileLocationStrategy {
37
38 /**
39 * Builds new instances of {@link ProvidedURLLocationStrategy}.
40 *
41 * @return a new builder.
42 * @since 2.15.0
43 */
44 public static StrategyBuilder<ProvidedURLLocationStrategy> builder() {
45 return new StrategyBuilder<>(ProvidedURLLocationStrategy::new);
46 }
47
48 /**
49 * Constructs a new instance where URL resources are bound by {@link AbstractFileLocationStrategy.AbstractBuilder}.
50 */
51 public ProvidedURLLocationStrategy() {
52 }
53
54 /**
55 * Constructs a new instance where URL resources are bound by {@link AbstractFileLocationStrategy.AbstractBuilder}.
56 *
57 * @param builder How to build the instance.
58 * @since 2.15.0
59 */
60 public ProvidedURLLocationStrategy(final AbstractBuilder<?, ?> builder) {
61 super(builder);
62 }
63
64 /**
65 * {@inheritDoc} This implementation just returns the URL stored in the given {@code FileLocator}.
66 */
67 @Override
68 public URL locate(final FileSystem fileSystem, final FileLocator locator) {
69 return check(locator.getSourceURL());
70 }
71
72 }