001/* 
002    Licensed to the Apache Software Foundation (ASF) under one
003    or more contributor license agreements.  See the NOTICE file
004    distributed with this work for additional information
005    regarding copyright ownership.  The ASF licenses this file
006    to you under the Apache License, Version 2.0 (the
007    "License"); you may not use this file except in compliance
008    with the License.  You may obtain a copy of the License at
009
010       http://www.apache.org/licenses/LICENSE-2.0
011
012    Unless required by applicable law or agreed to in writing,
013    software distributed under the License is distributed on an
014    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015    KIND, either express or implied.  See the License for the
016    specific language governing permissions and limitations
017    under the License.  
018 */
019package org.apache.wiki.api.plugin;
020
021import org.apache.logging.log4j.LogManager;
022import org.apache.wiki.WikiContext;
023import org.apache.wiki.api.core.Context;
024import org.apache.wiki.api.exceptions.PluginException;
025
026import java.util.Map;
027
028
029/**
030 * Defines an interface for plugins.  Any instance of a wiki plugin should implement this interface.
031 *
032 * @deprecated use {@link Plugin} instead
033 * @see Plugin
034 */
035@Deprecated
036public interface WikiPlugin extends Plugin {
037
038    /** {@inheritDoc} */
039    @Override
040    default String execute( final Context context, final Map< String, String > params ) throws PluginException {
041        LogManager.getLogger( WikiPlugin.class ).warn( this.getClass().getName() + " implements deprecated org.apache.wiki.api.plugin.WikiPlugin" );
042        LogManager.getLogger( WikiPlugin.class ).warn( "Please contact the plugin's author so there can be a new release of the plugin " +
043                                                      "implementing the new org.apache.wiki.api.plugin.Plugin interface" );
044        return execute( ( WikiContext )context, params );
045    }
046
047    String execute( WikiContext context, Map< String, String > params ) throws PluginException;
048    
049}