| /* |
| * 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_FILTER_STRING_MATCH_FILTER_H |
| #define _LOG4CXX_FILTER_STRING_MATCH_FILTER_H |
| |
| #include <log4cxx/spi/filter.h> |
| |
| #if defined(_MSC_VER) |
| #pragma warning ( push ) |
| #pragma warning ( disable: 4251 ) |
| #endif |
| |
| namespace log4cxx |
| { |
| namespace filter |
| { |
| /** |
| This is a very simple filter based on string matching. |
| |
| <p>The filter admits two options <b>StringToMatch</b> and |
| <b>AcceptOnMatch</b>. If there is a match between the value of the |
| StringToMatch option and the message of the {@link spi::LoggingEvent |
| LoggingEvent}, then the #decide method returns |
| {@link log4cxx::spi::Filter#ACCEPT ACCEPT} if the <b>AcceptOnMatch</b> option |
| value is true, if it is false then {@link log4cxx::spi::Filter#DENY DENY} is |
| returned. If there is no match, {@link log4cxx::spi::Filter#NEUTRAL NEUTRAL} |
| is returned. |
| |
| <p>See configuration files <a |
| href="../xml/doc-files/test6.xml">test6.xml</a>, <a |
| href="../xml/doc-files/test7.xml">test7.xml</a>, <a |
| href="../xml/doc-files/test8.xml">test8.xml</a>, <a |
| href="../xml/doc-files/test9.xml">test9.xml</a>, and <a |
| href="../xml/doc-files/test10.xml">test10.xml</a> for examples of |
| seeting up a <code>StringMatchFilter</code>. |
| */ |
| |
| class LOG4CXX_EXPORT StringMatchFilter : public spi::Filter |
| { |
| private: |
| bool acceptOnMatch; |
| LogString stringToMatch; |
| |
| public: |
| typedef spi::Filter BASE_CLASS; |
| DECLARE_LOG4CXX_OBJECT(StringMatchFilter) |
| BEGIN_LOG4CXX_CAST_MAP() |
| LOG4CXX_CAST_ENTRY(StringMatchFilter) |
| LOG4CXX_CAST_ENTRY_CHAIN(BASE_CLASS) |
| END_LOG4CXX_CAST_MAP() |
| |
| StringMatchFilter(); |
| |
| /** |
| Set options |
| */ |
| virtual void setOption(const LogString& option, |
| const LogString& value); |
| |
| inline void setStringToMatch(const LogString& stringToMatch1) |
| { |
| this->stringToMatch.assign(stringToMatch1); |
| } |
| |
| inline const LogString& getStringToMatch() const |
| { |
| return stringToMatch; |
| } |
| |
| inline void setAcceptOnMatch(bool acceptOnMatch1) |
| { |
| this->acceptOnMatch = acceptOnMatch1; |
| } |
| |
| inline bool getAcceptOnMatch() const |
| { |
| return acceptOnMatch; |
| } |
| |
| /** |
| Returns {@link log4cxx::spi::Filter#NEUTRAL NEUTRAL} |
| is there is no string match. |
| */ |
| FilterDecision decide(const spi::LoggingEventPtr& event) const; |
| }; // class StringMatchFilter |
| LOG4CXX_PTR_DEF(StringMatchFilter); |
| } // namespace filter |
| } // namespace log4cxx |
| |
| #if defined(_MSC_VER) |
| #pragma warning (pop) |
| #endif |
| |
| #endif // _LOG4CXX_FILTER_STRING_MATCH_FILTER_H |