WarResourceSet.java

  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. import java.util.jar.JarEntry;
  19. import java.util.jar.Manifest;

  20. import org.apache.catalina.WebResource;
  21. import org.apache.catalina.WebResourceRoot;

  22. /**
  23.  * Represents a {@link org.apache.catalina.WebResourceSet} based on a WAR file.
  24.  */
  25. public class WarResourceSet extends AbstractSingleArchiveResourceSet {

  26.     /**
  27.      * A no argument constructor is required for this to work with the digester.
  28.      */
  29.     public WarResourceSet() {
  30.     }


  31.     /**
  32.      * Creates a new {@link org.apache.catalina.WebResourceSet} based on a WAR file.
  33.      *
  34.      * @param root        The {@link WebResourceRoot} this new {@link org.apache.catalina.WebResourceSet} will be added
  35.      *                        to.
  36.      * @param webAppMount The path within the web application at which this {@link org.apache.catalina.WebResourceSet}
  37.      *                        will be mounted.
  38.      * @param base        The absolute path to the WAR file on the file system from which the resources will be served.
  39.      *
  40.      * @throws IllegalArgumentException if the webAppMount is not valid (valid paths must start with '/')
  41.      */
  42.     public WarResourceSet(WebResourceRoot root, String webAppMount, String base) throws IllegalArgumentException {
  43.         super(root, webAppMount, base, "/");
  44.     }


  45.     @Override
  46.     protected WebResource createArchiveResource(JarEntry jarEntry, String webAppPath, Manifest manifest) {
  47.         return new WarResource(this, webAppPath, getBaseUrlString(), jarEntry);
  48.     }
  49. }