01: /*
02: JSPWiki - a JSP-based WikiWiki clone.
03:
04: Copyright (C) 2001-2007 Janne Jalkanen (Janne.Jalkanen@iki.fi)
05:
06: This program is free software; you can redistribute it and/or modify
07: it under the terms of the GNU Lesser General Public License as published by
08: the Free Software Foundation; either version 2.1 of the License, or
09: (at your option) any later version.
10:
11: This program is distributed in the hope that it will be useful,
12: but WITHOUT ANY WARRANTY; without even the implied warranty of
13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: GNU Lesser General Public License for more details.
15:
16: You should have received a copy of the GNU Lesser General Public License
17: along with this program; if not, write to the Free Software
18: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19: */
20: package com.ecyrd.jspwiki.attachment;
21:
22: import java.io.IOException;
23: import java.io.InputStream;
24:
25: import com.ecyrd.jspwiki.WikiContext;
26: import com.ecyrd.jspwiki.providers.ProviderException;
27:
28: /**
29: * Provides the data for an attachment. Please note that there will
30: * be a strong reference retained for the provider for each Attachment
31: * it provides, so do try to keep the object light. Also, reuse objects
32: * if possible.
33: * <p>
34: * The Provider needs to be thread-safe.
35: *
36: * @author Janne Jalkanen
37: * @since 2.5.34
38: */
39: public interface DynamicAttachmentProvider {
40: /**
41: * Returns a stream of data for this attachment. The stream will be
42: * closed by AttachmentServlet.
43: *
44: * @param context A Wiki Context
45: * @param att The Attachment for which the data should be received.
46: * @return InputStream for the data.
47: * @throws ProviderException If something goes wrong internally
48: * @throws IOException If something goes wrong when reading the data
49: */
50: public InputStream getAttachmentData(WikiContext context,
51: Attachment att) throws ProviderException, IOException;
52: }
|