pegasus/src/Pegasus/Common/Logger.h - diff

Return to Logger.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/Logger.h between version 1.1 and 1.18.4.1

version 1.1, 2001/03/23 01:00:46

version 1.18.4.1, 2004/12/01 03:23:47

Line 1

//BEGIN_LICENSE

//%2004////////////////////////////////////////////////////////////////////////

// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// Permission is hereby granted, free of charge, to any person obtaining a

// Permission is hereby granted, free of charge, to any person obtaining a copy

// copy of this software and associated documentation files (the "Software"),

// of this software and associated documentation files (the "Software"), to

// to deal in the Software without restriction, including without limitation

// deal in the Software without restriction, including without limitation the

// the rights to use, copy, modify, merge, publish, distribute, sublicense,

// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

// and/or sell copies of the Software, and to permit persons to whom the

// sell copies of the Software, and to permit persons to whom the Software is

// Software is furnished to do so, subject to the following conditions:

// furnished to do so, subject to the following conditions:

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED

// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

// DEALINGS IN THE SOFTWARE.

// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

//END_LICENSE

//==============================================================================

//BEGIN_HISTORY

// Author: Mike Brasher

// Author: Mike Brasher (mbrasher@bmc.com)

// $Log$

// Modified By: Dave Rosckes (rosckes@us.ibm.com)

// Revision 1.1 2001/03/23 01:00:46 mike

// More logging capabilities.

//%/////////////////////////////////////////////////////////////////////////////

//END_HISTORY

#ifndef Pegasus_Logger_h

#define Pegasus_Logger_h

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Formatter.h>

#include <Pegasus/Common/Linkage.h>

#include <Pegasus/Common/System.h>

#include <Pegasus/Common/MessageLoader.h> // l10n

PEGASUS_NAMESPACE_BEGIN

class LoggerRep;

// REVIEW: is this still used? Are there other mechanisms?

/**

class PEGASUS_COMMON_LINKAGE Logger

{

public:

Line 50

Line 58

{

TRACE_LOG,

STANDARD_LOG,

ERROR_LOG

ERROR_LOG,

DEBUG_LOG

};

enum { NUM_LOGS = 4 };

enum { NUM_LOGS = 3 };

/** Log file Level - Defines the loglevel of the

log entry irrespective of which log file it goes into. This is

actually a bit mask as defined in logger.cpp. Thus, it serves both

as a level of indication of the seriousness and possibly as a mask

to select what is logged.

ATTN: The selection test has not been done.

static const Uint32 TRACE;

static const Uint32 INFORMATIVE;

static const Uint32 INFORMATION;

static const Uint32 WARNING;

static const Uint32 SEVERE;

static const Uint32 FATAL;

/** put - Puts a message to the defined log file

@param logFileType - Type of log file (Trace, etc.)

@param systemId - ID of the system generating the log entry within

Pegasus. This is user defined but generally breaks down into major

Pegasus components.

@param level logLevel of the log entry. To be used both t0

mark the log entry and tested against a mask to determine if log

entry should be written.

@param formatString Format definition string for the Log. See the

Formatter for details.

@param Arg0 - Arg 9 - Up to 9 arguments representing the variables

that go into the log entry.

<pre>

Logger::put(Logger::TRACE_LOG, "CIMServer", Logger::WARNING,

"X=$0, Y=$1, Z=$2", 88, "Hello World", 7.5);

</pre>

#if 1

static void put(

LogFileType logFileType,

const String& systemId,

Uint32 logLevel,

const String& formatString,

const Formatter::Arg& arg0,

const Formatter::Arg& arg1,

const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg3 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG);

#endif

static void put(

LogFileType logFileType,

const String& systemId,

Uint32 logLevel,

const String& formatString);

static void put(

LogFileType logFileType,

const String& systemId,

Uint32 level,

Uint32 logLevel,

const String& formatString,

const Formatter::Arg& arg0);

// l10n

#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES

/** put_l - Puts a localized message to the defined log file

@param logFileType - Type of log file (Trace, etc.)

@param systemId - ID of the system generating the log entry within

Pegasus. This is user defined but generally breaks down into major

Pegasus components.

@param level logLevel of the log entry. To be used both t0

mark the log entry and tested against a mask to determine if log

entry should be written.

@param messageId Message ID of the format string to load from

the resource bundle.

@param formatString Default format definition string. See the

Formatter for details. This will be used as the default format string

in case the resource bundle cannot be found.

@param Arg0 - Arg 9 - Up to 9 arguments representing the variables

that go into the log entry.

<pre>

Logger::put(Logger::TRACE_LOG, "CIMServer", Logger::WARNING,

"X=$0, Y=$1, Z=$2", 88, "Hello World", 7.5);

</pre>

#if 1

static void put_l(

LogFileType logFileType,

const String& systemId,

Uint32 logLevel,

const String& messageId,

const String& formatString,

const Formatter::Arg& arg0,

const Formatter::Arg& arg1,

const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg3 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG);

#endif

static void put_l(

LogFileType logFileType,

const String& systemId,

Uint32 logLevel,

const String& messageId,

const String& formatString);

static void put_l(

LogFileType logFileType,

const String& systemId,

Uint32 logLevel,

const String& messageId,

const String& formatString,

const Formatter::Arg& arg0);

#endif

// _trace - puts a message to the define log. Should only be used

// for trace type logs

static void trace(

LogFileType logFileType,

const String& systemId,

const Uint32 logComponent,

const String& formatString,

const Formatter::Arg& arg0,

const Formatter::Arg& arg1,

const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg3 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG);

// l10n

#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES

// trace - puts a localized message to the log. Should only be used

// for trace type logs

static void trace_l(

LogFileType logFileType,

const String& systemId,

const Uint32 logComponent,

const String& messageId,

const String& formatString,

const Formatter::Arg& arg0 = Formatter::Arg(),

const Formatter::Arg& arg0 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg1 = Formatter::Arg(),

const Formatter::Arg& arg1 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg2 = Formatter::Arg(),

const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg3 = Formatter::Arg(),

const Formatter::Arg& arg3 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg4 = Formatter::Arg(),

const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg5 = Formatter::Arg(),

const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg6 = Formatter::Arg(),

const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg7 = Formatter::Arg(),

const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg8 = Formatter::Arg(),

const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg9 = Formatter::Arg());

const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG);

#endif

/** setHomeDirectory

static void setHomeDirectory(const String& homeDirectory);

/** setlogLevelMask

static void setlogLevelMask(const String logLevelList);

/** setLogWriteControlMask

static void setLogWriteControlMask(const Uint32);

static Boolean isValidlogLevel(const String logLevel);

private:

static LoggerRep* _rep;

static String _homeDirectory;

static Uint32 _severityMask;

static Uint32 _writeControlMask;

static const char _SEPARATOR;

static const Uint32 _NUM_LOGLEVEL;

static const Boolean _SUCCESS;

static const Boolean _FAILURE;

static void _putInternal(

LogFileType logFileType,

const String& systemId,

const Uint32 logComponent,

Uint32 logLevel,

const String& formatString,

const String& messageId, // l10n

const Formatter::Arg& arg0 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg1 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg3 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG);

};

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.1
changed lines
	Added in v.1.18.4.1

No CVS admin address has been configured