filterbasedtriggeringpolicy.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.
 */

#if !defined(_LOG4CXX_ROLLING_FILTER_BASED_TRIGGERING_POLICY_H)
#define _LOG4CXX_ROLLING_FILTER_BASED_TRIGGERING_POLICY_H

#include <log4cxx/rolling/triggeringpolicy.h>
#include <log4cxx/spi/filter.h>

namespace log4cxx
{

class File;

namespace helpers
{
class Pool;
}


namespace rolling
{


class LOG4CXX_EXPORT FilterBasedTriggeringPolicy : public TriggeringPolicy
{

        DECLARE_LOG4CXX_OBJECT(FilterBasedTriggeringPolicy)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(FilterBasedTriggeringPolicy)
        LOG4CXX_CAST_ENTRY_CHAIN(TriggeringPolicy)
        END_LOG4CXX_CAST_MAP()

        
        log4cxx::spi::FilterPtr headFilter;

        log4cxx::spi::FilterPtr tailFilter;

    public:
        FilterBasedTriggeringPolicy();
        virtual ~FilterBasedTriggeringPolicy();

        virtual bool isTriggeringEvent(
            Appender* appender,
            const log4cxx::spi::LoggingEventPtr& event,
            const LogString& filename,
            size_t fileLength);

        void addFilter(const log4cxx::spi::FilterPtr& newFilter);

        void clearFilters();

        log4cxx::spi::FilterPtr& getFilter();

        void activateOptions(log4cxx::helpers::Pool&);

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

LOG4CXX_PTR_DEF(FilterBasedTriggeringPolicy);

}
}

#endif