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 * http://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.resolver;
18
19 import java.net.URL;
20 import java.util.Map;
21
22 /**
23 * Interface used for registering and retrieving PUBLICID to URL mappings.
24 *
25 * @since 1.7
26 */
27 public interface EntityRegistry {
28 /**
29 * Gets a map with the entity IDs that have been registered using the {@code registerEntityId()} method.
30 *
31 * @return a map with the registered entity IDs
32 */
33 Map<String, URL> getRegisteredEntities();
34
35 /**
36 * <p>
37 * Registers the specified URL for the specified public identifier.
38 * </p>
39 * <p>
40 * This implementation maps {@code PUBLICID}'s to URLs (from which the resource will be loaded). A common use case for
41 * this method is to register local URLs (possibly computed at runtime by a class loader) for DTDs and Schemas. This
42 * allows the performance advantage of using a local version without having to ensure every {@code SYSTEM} URI on every
43 * processed XML document is local. This implementation provides only basic functionality. If more sophisticated
44 * features are required, either calling {@code XMLConfiguration.setDocumentBuilder(DocumentBuilder)} to set a custom
45 * {@code DocumentBuilder} (which also can be initialized with a custom {@code EntityResolver}) or creating a custom
46 * entity resolver and registering it with the XMLConfiguration is recommended.
47 * </p>
48 *
49 * @param publicId Public identifier of the Entity to be resolved
50 * @param entityURL The URL to use for reading this Entity
51 * @throws IllegalArgumentException if the public ID is undefined
52 */
53 void registerEntityId(String publicId, URL entityURL);
54 }