Author: markt
Date: Tue Sep 29 12:42:27 2015
New Revision: 1705848
URL: http://svn.apache.org/viewvc?rev=1705848&view=rev
Log:
Preparatory work for fixing https://bz.apache.org/bugzilla/show_bug.cgi?id=56777
Add a utility class that will provide an input stream using a provided
'location' string. The location can be a URL, an absolute file path or a
relative file path.
Added:
tomcat/trunk/java/org/apache/tomcat/util/file/ConfigFileLoader.java (with
props)
tomcat/trunk/test/org/apache/tomcat/util/file/TestConfigFileLoader.java
(with props)
Added: tomcat/trunk/java/org/apache/tomcat/util/file/ConfigFileLoader.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/file/ConfigFileLoader.java?rev=1705848&view=auto
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/file/ConfigFileLoader.java (added)
+++ tomcat/trunk/java/org/apache/tomcat/util/file/ConfigFileLoader.java Tue Sep
29 12:42:27 2015
@@ -0,0 +1,68 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package org.apache.tomcat.util.file;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URI;
+import java.net.URL;
+
+/**
+ * This class is used to obtain {@link InputStream}s for configuration files
+ * from a given location String. This allows greater flexibility than these
+ * files having to be loaded directly from a file system.
+ */
+public class ConfigFileLoader {
+
+ private static final URI CATALINA_BASE_URI;
+
+ static {
+ File catalinaBase = new File("");
+ CATALINA_BASE_URI = catalinaBase.toURI();
+ }
+
+ private ConfigFileLoader() {
+ // Utility class. Hide the default constructor.
+ }
+
+
+ /**
+ * Load the resource from the specified location.
+ *
+ * @param location The location for the resource of interest. The location
+ * may be a URL or a file path. Relative paths will be
+ * resolved against CATALINA_BASE.
+ *
+ * @return The InputStream for the given resource. The caller is
responsible
+ * for closing this stream when it is no longer used.
+ *
+ * @throws IOException If an InputStream cannot be created using the
+ * provided location
+ */
+ public static InputStream getInputStream(String location) throws
IOException {
+
+ // Absolute URIs will be left alone
+ // Relative files will be resolved relative to catalina base
+ // Absolute files will be converted to URIs
+ URI uri = CATALINA_BASE_URI.resolve(location);
+ URL url = uri.toURL();
+
+ return url.openConnection().getInputStream();
+ }
+}
Propchange: tomcat/trunk/java/org/apache/tomcat/util/file/ConfigFileLoader.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: tomcat/trunk/test/org/apache/tomcat/util/file/TestConfigFileLoader.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/test/org/apache/tomcat/util/file/TestConfigFileLoader.java?rev=1705848&view=auto
==============================================================================
--- tomcat/trunk/test/org/apache/tomcat/util/file/TestConfigFileLoader.java
(added)
+++ tomcat/trunk/test/org/apache/tomcat/util/file/TestConfigFileLoader.java Tue
Sep 29 12:42:27 2015
@@ -0,0 +1,64 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package org.apache.tomcat.util.file;
+
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.junit.Assert;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+import org.apache.catalina.startup.TomcatBaseTest;
+import org.apache.catalina.webresources.TomcatURLStreamHandlerFactory;
+
+public class TestConfigFileLoader {
+
+ @BeforeClass
+ public static void setup() {
+ TomcatURLStreamHandlerFactory.getInstance();
+
System.setProperty("catalina.base",TomcatBaseTest.getBuildDirectory().getAbsolutePath());
+ }
+
+ @Test
+ public void test01() throws IOException {
+ doTest("classpath:org/apache/catalina/mbeans-descriptors.xml");
+ }
+
+ @Test(expected=FileNotFoundException.class)
+ public void test02() throws IOException {
+ doTest("classpath:org/apache/catalina/foo");
+ }
+
+ @Test
+ public void test03() throws IOException {
+ doTest("test/webresources/dir1");
+ }
+
+ @Test(expected=FileNotFoundException.class)
+ public void test04() throws IOException {
+ doTest("test/webresources/unknown");
+ }
+
+ private void doTest(String path) throws IOException {
+ try (InputStream is = ConfigFileLoader.getInputStream(path)) {
+ Assert.assertNotNull(is);
+ }
+ }
+}
Propchange:
tomcat/trunk/test/org/apache/tomcat/util/file/TestConfigFileLoader.java
------------------------------------------------------------------------------
svn:eol-style = native
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
