    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.filters;
    020
    021import org.apache.wiki.api.core.Engine;
    022import org.apache.wiki.api.exceptions.FilterException;
    023
    024import java.lang.reflect.Method;
    025import java.util.Properties;
    026
    027import static org.apache.wiki.api.filters.FilterSupportOperations.executePageFilterPhase;
    028import static org.apache.wiki.api.filters.FilterSupportOperations.methodOfNonPublicAPI;
    029
    030
    031/**
    032 * Provides a base implementation of a PageFilter.  None of the callbacks do anything, so it is a good idea for you to extend from this
    033 * class and implement only methods that you need.
    034 */
    035public class BasePageFilter implements PageFilter {
    036
    037    protected Engine m_engine;
    038
    039    /**
    040     * If you override this, you should call super.initialize() first.
    041     *
    042     * {@inheritDoc}
    043     */
    044    @Override
    045    public void initialize( final Engine engine, final Properties properties ) throws FilterException {
    046        m_engine = engine;
    047        final Method m = methodOfNonPublicAPI( this, "initialize", "org.apache.wiki.WikiEngine", "java.util.Properties" );
    048        executePageFilterPhase( () -> null, m, this, engine, properties );
    049    }
    050
    051}