View Javadoc

1   /*
2    * $Id$
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  package org.apache.struts2.dispatcher;
22  
23  import java.io.IOException;
24  
25  import javax.servlet.http.HttpServletRequest;
26  import javax.servlet.http.HttpServletResponse;
27  
28  import org.apache.struts2.dispatcher.ng.HostConfig;
29  
30  /***
31   * Interface for loading static resources, based on a path
32   */
33  public interface StaticContentLoader {
34  
35      /***
36       * @param path Requested resource path
37       * @return true if this loader is able to load this type of resource, false otherwise
38       */
39      public boolean canHandle(String path);
40  
41      /***
42       * @param filterConfig The filter configuration
43       */
44      public abstract void setHostConfig(HostConfig filterConfig);
45  
46      /***
47       * Locate a static resource and copy directly to the response, setting the
48       * appropriate caching headers.
49       *
50       * @param path     The resource name
51       * @param request  The request
52       * @param response The response
53       * @throws IOException If anything goes wrong
54       */
55      public abstract void findStaticResource(String path, HttpServletRequest request, HttpServletResponse response)
56              throws IOException;
57  
58  }