filter.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _LOG4CXX_SPI_FILTER_H
#define _LOG4CXX_SPI_FILTER_H

#include <log4cxx/helpers/object.h>
#include <log4cxx/spi/optionhandler.h>
#include <log4cxx/spi/loggingevent.h>

namespace log4cxx
{
namespace spi
{
class Filter;
LOG4CXX_PTR_DEF(Filter);


class LOG4CXX_EXPORT Filter : public virtual OptionHandler,
    public virtual helpers::Object
{
        FilterPtr next;
    public:
        Filter();

        DECLARE_ABSTRACT_LOG4CXX_OBJECT(Filter)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(Filter)
        LOG4CXX_CAST_ENTRY(spi::OptionHandler)
        END_LOG4CXX_CAST_MAP()

        log4cxx::spi::FilterPtr getNext() const;
        void setNext(const log4cxx::spi::FilterPtr& newNext);

        enum FilterDecision
        {
            DENY = -1,
            NEUTRAL = 0,
            ACCEPT = 1

        };


        void activateOptions(log4cxx::helpers::Pool& p);
        void setOption(const LogString& option, const LogString& value);

        virtual FilterDecision decide(const LoggingEventPtr& event) const = 0;
};
}
}

#endif //_LOG4CXX_SPI_FILTER_H