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_NS
{
namespace spi
{
class Filter;
LOG4CXX_PTR_DEF(Filter);
 

class LOG4CXX_EXPORT Filter
#if LOG4CXX_ABI_VERSION <= 15
    : public virtual OptionHandler
#else
    : public OptionHandler
#endif
{
    protected:
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(FilterPrivate, m_priv)
 
    public:
        Filter();
        Filter(std::unique_ptr<FilterPrivate> priv);
        virtual ~Filter();
 
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(Filter)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(Filter)
        LOG4CXX_CAST_ENTRY(spi::OptionHandler)
        END_LOG4CXX_CAST_MAP()
 
        LOG4CXX_NS::spi::FilterPtr getNext() const;
        void setNext(const LOG4CXX_NS::spi::FilterPtr& newNext);
 
        enum FilterDecision
        {
            DENY = -1,
            NEUTRAL = 0,
            ACCEPT = 1
 
        };
 
        using OptionHandler::activateOptions;
        void activateOptions( LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS ) override;

        void setOption(const LogString& option, const LogString& value) override;

        virtual FilterDecision decide(const LoggingEventPtr& event) const = 0;
};
}
}
 
#endif //_LOG4CXX_SPI_FILTER_H