01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. The ASF licenses this file to You
04: * under the Apache License, Version 2.0 (the "License"); you may not
05: * use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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.business;
20:
21: import java.util.List;
22: import java.util.Map;
23: import org.apache.roller.pojos.WeblogEntryData;
24: import org.apache.roller.pojos.WebsiteData;
25: import org.apache.roller.ui.core.plugins.WeblogEntryEditor;
26:
27: /**
28: * Plugin management for business layer and more generally applied plugins.
29: */
30: public interface PluginManager {
31:
32: /**
33: * Returns true if plugins are present
34: */
35: public boolean hasPagePlugins();
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 getWeblogEntryPlugins(WebsiteData website);
44:
45: /**
46: * Apply a set of weblog entry plugins to the specified string and
47: * return the results. This method must *NOT* alter the contents of
48: * the original entry object.
49: *
50: * @param entry Original weblog entry
51: * @param plugins Map of plugins to apply
52: * @param str String to which to apply plugins
53: * @return the transformed text
54: */
55: public String applyWeblogEntryPlugins(Map pagePlugins,
56: WeblogEntryData entry, String str);
57:
58: /**
59: * Release all resources associated with Roller session.
60: */
61: public void release();
62:
63: }
|