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.catalina.webresources;
18
19 import java.util.jar.JarEntry;
20 import java.util.jar.Manifest;
21
22 import org.apache.catalina.WebResource;
23 import org.apache.catalina.WebResourceRoot;
24
25 /**
26  * Represents a {@link org.apache.catalina.WebResourceSet} based on a WAR file.
27  */
28 public class WarResourceSet extends AbstractSingleArchiveResourceSet {
29
30     /**
31      * A no argument constructor is required for this to work with the digester.
32      */
33     public WarResourceSet() {
34     }
35
36
37     /**
38      * Creates a new {@link org.apache.catalina.WebResourceSet} based on a WAR
39      * file.
40      *
41      * @param root          The {@link WebResourceRoot} this new
42      *                          {@link org.apache.catalina.WebResourceSet} will
43      *                          be added to.
44      * @param webAppMount   The path within the web application at which this
45      *                          {@link org.apache.catalina.WebResourceSet} will
46      *                          be mounted.
47      * @param base          The absolute path to the WAR file on the file system
48      *                          from which the resources will be served.
49      *
50      * @throws IllegalArgumentException if the webAppMount is not valid (valid
51      *         paths must start with '/')
52      */
53     public WarResourceSet(WebResourceRoot root, String webAppMount, String base)
54             throws IllegalArgumentException {
55         super(root, webAppMount, base, "/");
56     }
57
58
59     @Override
60     protected WebResource createArchiveResource(JarEntry jarEntry,
61             String webAppPath, Manifest manifest) {
62         return new WarResource(this, webAppPath, getBaseUrlString(), jarEntry);
63     }
64 }
65