1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.myfaces.renderkit.html.util;
20
21 import java.io.IOException;
22
23 import javax.servlet.ServletContext;
24 import javax.servlet.http.HttpServletRequest;
25 import javax.servlet.http.HttpServletResponse;
26
27 /**
28 * A class which can interpret the URI generated by a corresponding ResourceHandler
29 * implementation, locate that resource and write it to the servlet response stream.
30 *
31 * @author Mathias Broekelmann (latest modification by $Author: skitching $)
32 * @version $Revision: 673833 $ $Date: 2008-07-03 16:58:05 -0500 (Thu, 03 Jul 2008) $
33 */
34 public interface ResourceLoader
35 {
36 /**
37 * Define an exception for reporting when a client requests a resource, but
38 * then closes its socket before we finish sending it. In this case, the normal
39 * behaviour is to not report an error; there is nothing wrong on this end.
40 */
41 public static class ClosedSocketException extends IOException
42 {
43 }
44
45 /**
46 * Called by AddResource to render external resource data
47 * @param context TODO
48 * @param request the request
49 * @param response the response to write the resource content to
50 * @param resourceUri contains the uri part after the uri which
51 * is used to identify the resource loader
52 *
53 * @throws IOException
54 */
55 public void serveResource(ServletContext context, HttpServletRequest request,
56 HttpServletResponse response, String resourceUri) throws IOException;
57 }