01: /*
02: JSPWiki - a JSP-based WikiWiki clone.
03:
04: Copyright (C) 2001-2002 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.filters;
21:
22: import java.util.Properties;
23:
24: import com.ecyrd.jspwiki.WikiContext;
25: import com.ecyrd.jspwiki.WikiEngine;
26:
27: /**
28: * Provides a definition for a page filter. A page filter is a class
29: * that can be used to transform the WikiPage content being saved or
30: * being loaded at any given time.
31: * <p>
32: * Note that the WikiContext.getPage() method always returns the context
33: * in which text is rendered, i.e. the original request. Thus the content
34: * may actually be different content than what what the wikiContext.getPage()
35: * implies! This happens often if you are for example including multiple
36: * pages on the same page.
37: * <p>
38: * PageFilters must be thread-safe! There is only one instance of each PageFilter
39: * per each WikiEngine invocation. If you need to store data persistently, use
40: * VariableManager, or WikiContext.
41: * <p>
42: * As of 2.5.30, initialize() gains accesso to the WikiEngine.
43: *
44: * @author Janne Jalkanen
45: */
46: public interface PageFilter {
47: /**
48: * Is called whenever the a new PageFilter is instantiated and
49: * reset.
50: */
51: public void initialize(WikiEngine engine, Properties properties)
52: throws FilterException;
53:
54: /**
55: * This method is called whenever a page has been loaded from the provider,
56: * but not yet been sent through the TranslatorReader. Note that you cannot
57: * do HTML translation here, because TranslatorReader is likely to escape it.
58: *
59: * @param wikiContext The current wikicontext.
60: * @param content WikiMarkup.
61: */
62: public String preTranslate(WikiContext wikiContext, String content)
63: throws FilterException;
64:
65: /**
66: * This method is called after a page has been fed through the TranslatorReader,
67: * so anything you are seeing here is translated content. If you want to
68: * do any of your own WikiMarkup2HTML translation, do it here.
69: */
70: public String postTranslate(WikiContext wikiContext,
71: String htmlContent) throws FilterException;
72:
73: /**
74: * This method is called before the page has been saved to the PageProvider.
75: */
76: public String preSave(WikiContext wikiContext, String content)
77: throws FilterException;
78:
79: /**
80: * This method is called after the page has been successfully saved.
81: * If the saving fails for any reason, then this method will not
82: * be called.
83: * <p>
84: * Since the result is discarded from this method, this is only useful
85: * for things like counters, etc.
86: */
87: public void postSave(WikiContext wikiContext, String content)
88: throws FilterException;
89:
90: /**
91: * Called for every filter, e.g. on wiki eingine shutdown. Use this if you have to
92: * clean up or close global resources you allocated in the initialize() method.
93: *
94: * @since 2.5.36
95: */
96: public void destroy(WikiEngine engine);
97:
98: }
|