KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > roller > model > PluginManager


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. The ASF licenses this file to You
4  * under the Apache License, Version 2.0 (the "License"); you may not
5  * use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License. For additional information regarding
15  * copyright in this work, please see the NOTICE file in the top level
16  * directory of this distribution.
17  */
18
19 package org.apache.roller.model;
20
21 import java.util.Map JavaDoc;
22 import org.apache.roller.pojos.WeblogEntryData;
23 import org.apache.roller.pojos.WebsiteData;
24
25
26 /**
27  * Manages Roller plugins.
28  */
29 public interface PluginManager {
30     
31     /**
32      * Returns true if plugins are present
33      */
34     public boolean hasPagePlugins();
35     
36     
37     /**
38      * Returns a list of all registered weblog entry plugins initialized for
39      * use with the specified weblog.
40      *
41      * @param website Website being processed
42      */
43     public Map JavaDoc getWeblogEntryPlugins(WebsiteData website);
44     
45     
46     /**
47      * Apply a set of weblog entry plugins to the specified string and
48      * return the results. This method must *NOT* alter the contents of
49      * the original entry object.
50      *
51      * @param entry Original weblog entry
52      * @param plugins Map of plugins to apply
53      * @param str String to which to apply plugins
54      * @return the transformed text
55      */
56     public String JavaDoc applyWeblogEntryPlugins(Map JavaDoc pagePlugins, WeblogEntryData entry, String JavaDoc str);
57     
58     
59     /**
60      * Release all resources associated with Roller session.
61      */
62     public void release();
63     
64 }
65
Popular Tags