INTEGRATION: CWS sdblogging (1.1.2); FILE ADDED
2007/05/22 19:14:03 fs 1.1.2.3: #i76119# implement changes suggested by API review: initialize components by generic ctor, not by component context values 2007/05/20 13:33:18 fs 1.1.2.2: #i10000# 2007/04/05 07:34:32 fs 1.1.2.1: #i76119# initial implementation of the new logging API
This commit is contained in:
Jens-Heiner Rechtien
parent
ae0b239036
commit
62437cce5c
1 changed files with 168 additions and 0 deletions
168
extensions/source/logging/loghandler.hxx
Normal file
168
extensions/source/logging/loghandler.hxx
Normal file
|
|
@ -0,0 +1,168 @@
|
|||
/*************************************************************************
|
||||
*
|
||||
* OpenOffice.org - a multi-platform office productivity suite
|
||||
*
|
||||
* $RCSfile: loghandler.hxx,v $
|
||||
*
|
||||
* $Revision: 1.2 $
|
||||
*
|
||||
* last change: $Author: hr $ $Date: 2007-06-27 14:59:22 $
|
||||
*
|
||||
* The Contents of this file are made available subject to
|
||||
* the terms of GNU Lesser General Public License Version 2.1.
|
||||
*
|
||||
*
|
||||
* GNU Lesser General Public License Version 2.1
|
||||
* =============================================
|
||||
* Copyright 2005 by Sun Microsystems, Inc.
|
||||
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
* License version 2.1, as published by the Free Software Foundation.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* License along with this library; if not, write to the Free Software
|
||||
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
||||
* MA 02111-1307 USA
|
||||
*
|
||||
************************************************************************/
|
||||
|
||||
#ifndef LOGHANDLER_HXX
|
||||
#define LOGHANDLER_HXX
|
||||
|
||||
/** === begin UNO includes === **/
|
||||
#ifndef _COM_SUN_STAR_LOGGING_XLOGFORMATTER_HPP_
|
||||
#include <com/sun/star/logging/XLogFormatter.hpp>
|
||||
#endif
|
||||
#ifndef _COM_SUN_STAR_UNO_XCOMPONENTCONTEXT_HPP_
|
||||
#include <com/sun/star/uno/XComponentContext.hpp>
|
||||
#endif
|
||||
#ifndef _COM_SUN_STAR_LOGGING_LOGRECORD_HPP_
|
||||
#include <com/sun/star/logging/LogRecord.hpp>
|
||||
#endif
|
||||
/** === end UNO includes === **/
|
||||
|
||||
#include <comphelper/namedvaluecollection.hxx>
|
||||
#include <cppuhelper/interfacecontainer.hxx>
|
||||
#include <rtl/string.hxx>
|
||||
|
||||
//........................................................................
|
||||
namespace logging
|
||||
{
|
||||
//........................................................................
|
||||
|
||||
//====================================================================
|
||||
//=
|
||||
//====================================================================
|
||||
class LogHandlerHelper
|
||||
{
|
||||
private:
|
||||
// <attributes>
|
||||
rtl_TextEncoding m_eEncoding;
|
||||
sal_Int32 m_nLevel;
|
||||
::com::sun::star::uno::Reference< ::com::sun::star::logging::XLogFormatter >
|
||||
m_xFormatter;
|
||||
// <//attributes>
|
||||
|
||||
::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
|
||||
m_xContext;
|
||||
::osl::Mutex& m_rMutex;
|
||||
::cppu::OBroadcastHelper& m_rBHelper;
|
||||
bool m_bInitialized;
|
||||
|
||||
public:
|
||||
LogHandlerHelper(
|
||||
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext,
|
||||
::osl::Mutex& _rMutex,
|
||||
::cppu::OBroadcastHelper& _rBHelper
|
||||
);
|
||||
|
||||
public:
|
||||
bool getIsInitialized() const { return m_bInitialized; }
|
||||
void setIsInitialized() { m_bInitialized = true; }
|
||||
|
||||
bool getEncoding( ::rtl::OUString& _out_rEncoding ) const;
|
||||
bool setEncoding( const ::rtl::OUString& _rEncoding );
|
||||
|
||||
inline rtl_TextEncoding
|
||||
getTextEncoding() const { return m_eEncoding; }
|
||||
|
||||
inline ::com::sun::star::uno::Reference< ::com::sun::star::logging::XLogFormatter >
|
||||
getFormatter() const { return m_xFormatter; }
|
||||
inline void
|
||||
setFormatter( const ::com::sun::star::uno::Reference< ::com::sun::star::logging::XLogFormatter >& _rxFormatter )
|
||||
{
|
||||
m_xFormatter = _rxFormatter;
|
||||
}
|
||||
|
||||
inline sal_Int32
|
||||
getLevel() const { return m_nLevel; }
|
||||
inline void
|
||||
setLevel( const sal_Int32 _nLevel )
|
||||
{
|
||||
m_nLevel = _nLevel;
|
||||
}
|
||||
|
||||
/** prepares implementation of an public accessible method of a log handler
|
||||
|
||||
<code>enterMethod</code> does the following things:
|
||||
<ul><li>It acquires the mutex given in the constructor.</li>
|
||||
<li>It checks whether the component is already initialized, and throws an exception if not os.</li>
|
||||
<li>It checks whether the component is already disposed, and throws an exception if not os.</li>
|
||||
<li>It creates a default formatter (PlainTextFormatter), if no formatter exists at this time.</li>
|
||||
</ul>
|
||||
*/
|
||||
void enterMethod();
|
||||
|
||||
/** formats a record for publishing it
|
||||
|
||||
The method first checks whether the records log level is greater or equal our own
|
||||
log level. If not, <FALSE/> is returned.
|
||||
|
||||
Second, our formatter is used to create a unicode string from the log record. If an error occurs
|
||||
during this, e.g. if the formatter is <NULL/> or throws an exception during formatting,
|
||||
<FALSE/> is returned.
|
||||
|
||||
Finally, the unicode string is encoded into a byte string, using our encoding setting. Then,
|
||||
<TRUE/> is returned.
|
||||
*/
|
||||
bool formatForPublishing( const ::com::sun::star::logging::LogRecord& _rRecord, ::rtl::OString& _out_rEntry ) const;
|
||||
|
||||
/** retrieves our formatter's heading, encoded with our encoding
|
||||
|
||||
@return <TRUE/> in case of success, <FALSE/> if any error occured
|
||||
*/
|
||||
bool getEncodedHead( ::rtl::OString& _out_rHead ) const;
|
||||
|
||||
/** retrieves our formatter's tail, encoded with our encoding
|
||||
|
||||
@return <TRUE/> in case of success, <FALSE/> if any error occured
|
||||
*/
|
||||
bool getEncodedTail( ::rtl::OString& _out_rTail ) const;
|
||||
|
||||
/** initializes the instance from a collection of named settings
|
||||
|
||||
The recognized named settings are <code>Encoding</code>, <code>Formatter</code>, and <code>Level</code>,
|
||||
which initialize the respective attributes.
|
||||
|
||||
Settings which are recognized are remove from the given collection. This allows
|
||||
the caller to determine whether or not the collection contained any unsupported
|
||||
items, and react appropriately.
|
||||
|
||||
@throws IllegalArgumentException
|
||||
if one of the values in the collection is of wrong type.
|
||||
*/
|
||||
void initFromSettings( const ::comphelper::NamedValueCollection& _rSettings );
|
||||
};
|
||||
|
||||
//........................................................................
|
||||
} // namespace logging
|
||||
//........................................................................
|
||||
|
||||
#endif // LOGHANDLER_HXX
|
||||
Loading…
Reference in a new issue