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.custom.dynamicResources;
20
21 import java.io.IOException;
22
23 import javax.faces.context.FacesContext;
24 import javax.faces.context.ResponseStream;
25
26 /**
27 * The ImageRenderer is used to render the binary data for a html img tag
28 * Implementions must have a default constructor
29 *
30 * @author Mathias Broekelmann
31 * @version $Revision: 673833 $ $Date: 2008-07-03 16:58:05 -0500 (Thu, 03 Jul 2008) $
32 */
33 public interface ResourceRenderer
34 {
35 /**
36 * This method will be called first, to set the contexts.
37 *
38 * @param facesContext the faces context
39 * @param imageContext the image context width aditional image parameters
40 */
41 void setContext(FacesContext facesContext, ResourceContext resourceContext) throws Exception;
42
43 /**
44 * The content length of the image to render.
45 * Set to a negative value if you don't want to set the response content length.
46 *
47 * @return the content length of the rendered image
48 */
49 int getContentLength();
50
51 /**
52 * The MimeType of the image. This is usally a value of
53 * image/jpeg, image/gif, image/png or anything else which can be
54 * used as an image for html
55 *
56 * @return the Mime-Type, not null
57 */
58 String getContentType();
59
60 /**
61 * Called to render the image to the given outputstream.
62 *
63 * @param out the outputstream which is used to write the binary data of the image
64 *
65 * @throws IOException
66 */
67 void renderResource(ResponseStream out) throws IOException;
68 }