OW_LogAppender.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2004 Vintela, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_LOG_APPENDER_IFC_HPP_INCLUDE_GUARD_
#define OW_LOG_APPENDER_IFC_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_CommonFwd.hpp"
#include "OW_IntrusiveCountableBase.hpp"
#include "OW_SortedVectorSet.hpp"
#include "OW_LogLevel.hpp"
#include "OW_LogMessagePatternFormatter.hpp"


namespace OW_NAMESPACE
{

#ifdef OW_WIN32
template class OW_COMMON_API Array<String>;
template class OW_COMMON_API SortedVectorSet<String>;
#endif

class OW_COMMON_API LogAppender : public IntrusiveCountableBase
{
public:

   virtual ~LogAppender();

   void logMessage(const LogMessage& message) const;

   bool categoryIsEnabled(const String& category) const;
   bool componentAndCategoryAreEnabled(const String& component, const String& category) const;

   ELogLevel getLogLevel() const;

   typedef SortedVectorMap<String, String> ConfigMap;

   static LogAppenderRef createLogAppender(
      const String& name,
      const StringArray& components,
      const StringArray& categories,
      const String& messageFormat,
      const String& type,
      const ConfigMap& configItems);

   static const StringArray ALL_COMPONENTS;
   static const StringArray ALL_CATEGORIES;
   static const String STR_TTCC_MESSAGE_FORMAT;
   static const String TYPE_SYSLOG;
   static const String TYPE_STDERR;
   static const String TYPE_FILE;
   static const String TYPE_NULL;

protected:

   LogAppender(const StringArray& components, const StringArray& categories, const String& pattern);

private:
   virtual void doProcessLogMessage(const String& formattedMessage, const LogMessage& message) const = 0;

private: // data
   SortedVectorSet<String> m_components;
   bool m_allComponents;
   SortedVectorSet<String> m_categories;
   bool m_allCategories;

   LogMessagePatternFormatter m_formatter;

};
OW_EXPORT_TEMPLATE(OW_COMMON_API, IntrusiveReference, LogAppender);

} // end namespace OW_NAMESPACE

#endif

---