/* 
    P/P   *  Method: org.apache.roller.weblogger.business.plugins.PluginManager__static_init
          */
     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.weblogger.business.plugins;
    20  
    21  import java.util.List;
    22  import java.util.Map;
    23  import org.apache.roller.weblogger.business.plugins.comment.WeblogEntryCommentPlugin;
    24  import org.apache.roller.weblogger.pojos.WeblogEntry;
    25  import org.apache.roller.weblogger.pojos.Weblog;
    26  import org.apache.roller.weblogger.pojos.WeblogEntryComment;
    27  
    28  
    29  /**
    30   * Plugin management for business layer and more generally applied plugins.
    31   */
    32  public interface PluginManager {
    33      
    34      /**
    35       * Returns true if plugins are present
    36       */
    37      public boolean hasPagePlugins();
    38      
    39      
    40      /**
    41       * Returns a list of all registered weblog entry plugins initialized for
    42       * use with the specified weblog.
    43       *
    44       * @param website        Website being processed
    45       */
    46      public Map getWeblogEntryPlugins(Weblog website);
    47      
    48      
    49      /**
    50       * Apply a set of weblog entry plugins to the specified string and
    51       * return the results.  This method must *NOT* alter the contents of
    52       * the original entry object.
    53       *
    54       * @param entry       Original weblog entry
    55       * @param plugins     Map of plugins to apply
    56       * @param str         String to which to apply plugins
    57       * @return        the transformed text
    58       */
    59      public String applyWeblogEntryPlugins(Map pagePlugins,WeblogEntry entry, String str);
    60      
    61      
    62      /**
    63       * Get the list of WeblogEntryCommentPlugin classes configured.
    64       *
    65       * This lists the set of plugins which are available to the system, not the
    66       * set of plugins which are enabled.
    67       *
    68       * Should return an empty list if no plugins are configured.
    69       */
    70      public List<WeblogEntryCommentPlugin> getCommentPlugins();
    71      
    72      
    73      /**
    74       * Apply comment plugins.
    75       *
    76       * @param comment The comment to apply plugins for.
    77       * @param text The text to apply the plugins to.
    78       * @return String The transformed comment text.
    79       */
    80      public String applyCommentPlugins(WeblogEntryComment comment, String text);
    81      
    82      
    83      /**
    84       * Release all resources associated with Roller session.
    85       */
    86      public void release();
    87      
    88  }