filter.h

Go to the documentation of this file.

// -*- C++ -*-
// Module:  Log4CPLUS
// File:    filter.h
// Created: 5/2003
// Author:  Tad E. Smith
//
//
// Copyright 1999-2017 Tad E. Smith
//
// Licensed 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 LOG4CPLUS_SPI_FILTER_HEADER_
#define LOG4CPLUS_SPI_FILTER_HEADER_
 
#include <log4cplus/config.hxx>
 
#if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
#pragma once
#endif
 
#include <functional>
 
#include <log4cplus/helpers/pointer.h>
#include <log4cplus/loglevel.h>
 
 
namespace log4cplus {
 
    namespace helpers
    {
 
        class Properties;
 
    }
 
    namespace spi {
 
 
        enum FilterResult { DENY, 
                            NEUTRAL, 
                            ACCEPT 
                          };
 
        // Forward Declarations
        class Filter;
        class InternalLoggingEvent;
 
 
        LOG4CPLUS_EXPORT FilterResult checkFilter(const Filter* filter,
                                                  const InternalLoggingEvent& event);
 
        typedef helpers::SharedObjectPtr<Filter> FilterPtr;
 
 
        class LOG4CPLUS_EXPORT Filter
            : public virtual log4cplus::helpers::SharedObject
        {
        public:
          // ctor and dtor
            Filter();
            virtual ~Filter();
 
          // Methods
            void appendFilter(FilterPtr filter);
 
            virtual FilterResult decide(const InternalLoggingEvent& event) const = 0;
 
          // Data
            FilterPtr next;
        };
 
 
 
        class LOG4CPLUS_EXPORT DenyAllFilter : public Filter {
        public:
            DenyAllFilter ();
            DenyAllFilter (const log4cplus::helpers::Properties&);
 
            virtual FilterResult decide(const InternalLoggingEvent& event) const;
        };
 
 
        class LOG4CPLUS_EXPORT LogLevelMatchFilter : public Filter {
        public:
            LogLevelMatchFilter();
            LogLevelMatchFilter(const log4cplus::helpers::Properties& p);
 
            virtual FilterResult decide(const InternalLoggingEvent& event) const;
 
        private:
          // Methods
            LOG4CPLUS_PRIVATE void init();
 
          // Data
            bool acceptOnMatch;
            LogLevel logLevelToMatch;
        };
 
 
 
        class LOG4CPLUS_EXPORT LogLevelRangeFilter : public Filter {
        public:
          // ctors
            LogLevelRangeFilter();
            LogLevelRangeFilter(const log4cplus::helpers::Properties& p);
 
            virtual FilterResult decide(const InternalLoggingEvent& event) const;
 
        private:
          // Methods
            LOG4CPLUS_PRIVATE void init();
 
          // Data
            bool acceptOnMatch;
            LogLevel logLevelMin;
            LogLevel logLevelMax;
        };
 
 
 
        class LOG4CPLUS_EXPORT StringMatchFilter : public Filter {
        public:
          // ctors
            StringMatchFilter();
            StringMatchFilter(const log4cplus::helpers::Properties& p);
 
            virtual FilterResult decide(const InternalLoggingEvent& event) const;
 
        private:
          // Methods
            LOG4CPLUS_PRIVATE void init();
 
          // Data
            bool acceptOnMatch;
            log4cplus::tstring stringToMatch;
        };
 
        class LOG4CPLUS_EXPORT FunctionFilter
            : public Filter
        {
        public:
            typedef std::function<FilterResult (const InternalLoggingEvent &)>
                Function;
 
            FunctionFilter (Function);
 
            virtual FilterResult decide(const InternalLoggingEvent&) const;
 
        private:
            Function function;
        };
 
        class LOG4CPLUS_EXPORT NDCMatchFilter : public Filter
        {
            public:
              // ctors
                NDCMatchFilter();
                NDCMatchFilter(const log4cplus::helpers::Properties& p);
 
                virtual FilterResult decide(const InternalLoggingEvent& event) const;
 
            private:
              // Methods
                LOG4CPLUS_PRIVATE void init();
 
              // Data
                bool acceptOnMatch;
                bool neutralOnEmpty;
                log4cplus::tstring ndcToMatch;
        };
 
        class LOG4CPLUS_EXPORT MDCMatchFilter : public Filter
        {
            public:
              // ctors
                MDCMatchFilter();
                MDCMatchFilter(const log4cplus::helpers::Properties& p);
 
                virtual FilterResult decide(const InternalLoggingEvent& event) const;
 
            private:
              // Methods
                LOG4CPLUS_PRIVATE void init();
 
              // Data
                bool acceptOnMatch;
                bool neutralOnEmpty;
                log4cplus::tstring mdcKeyToMatch;
                log4cplus::tstring mdcValueToMatch;
        };
 
    } // end namespace spi
} // end namespace log4cplus
 
#endif /* LOG4CPLUS_SPI_FILTER_HEADER_ */