(file) Return to Logger.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Common

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

version 1.11, 2002/07/26 20:01:19 version 1.18.4.1, 2004/12/01 03:23:47
Line 1 
Line 1 
 //%/////////////////////////////////////////////////////////////////////////////  //%2004////////////////////////////////////////////////////////////////////////
 // //
 // Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM,  // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
 // The Open Group, Tivoli Systems  // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
   // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
   // IBM Corp.; EMC Corporation, The Open Group.
   // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
   // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
 // //
 // Permission is hereby granted, free of charge, to any person obtaining a copy // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to // of this software and associated documentation files (the "Software"), to
Line 23 
Line 27 
 // //
 // Author: Mike Brasher (mbrasher@bmc.com) // Author: Mike Brasher (mbrasher@bmc.com)
 // //
 // Modified By:  // Modified By: Dave Rosckes (rosckes@us.ibm.com)
 // //
 //%///////////////////////////////////////////////////////////////////////////// //%/////////////////////////////////////////////////////////////////////////////
  
Line 33 
Line 37 
 #include <Pegasus/Common/Config.h> #include <Pegasus/Common/Config.h>
 #include <Pegasus/Common/Formatter.h> #include <Pegasus/Common/Formatter.h>
 #include <Pegasus/Common/Linkage.h> #include <Pegasus/Common/Linkage.h>
   #include <Pegasus/Common/System.h>
   #include <Pegasus/Common/MessageLoader.h>  // l10n
  
 PEGASUS_NAMESPACE_BEGIN PEGASUS_NAMESPACE_BEGIN
  
Line 43 
Line 49 
 /** /**
  
 */ */
   
 class PEGASUS_COMMON_LINKAGE Logger class PEGASUS_COMMON_LINKAGE Logger
 { {
 public: public:
Line 56 
Line 63 
     };     };
     enum { NUM_LOGS = 4 };     enum { NUM_LOGS = 4 };
  
     /** Log file Level - Defines the level of severity of the      /** Log file Level - Defines the loglevel of the
         log entry irrespective of which log file it goes into. This is         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         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         as a level of indication of the seriousness and possibly as a mask
Line 70 
Line 77 
     static const Uint32 SEVERE;     static const Uint32 SEVERE;
     static const Uint32 FATAL;     static const Uint32 FATAL;
  
   
     /** put - Puts a message to the defined log file     /** put - Puts a message to the defined log file
         @param logFileType - Type of log file (Trace, etc.)         @param logFileType - Type of log file (Trace, etc.)
         @param systemId  - ID of the system generating the log entry within         @param systemId  - ID of the system generating the log entry within
         Pegasus. This is user defined but generally breaks down into major         Pegasus. This is user defined but generally breaks down into major
         Pegasus components.         Pegasus components.
         @param level Level of severity of the log entry. To be used both t0          @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         mark the log entry and tested against a mask to determine if log
         entry should be written.         entry should be written.
         @param formatString     Format definition string for the Log. See the         @param formatString     Format definition string for the Log. See the
Line 87 
Line 95 
         "X=$0, Y=$1, Z=$2", 88,  "Hello World", 7.5);         "X=$0, Y=$1, Z=$2", 88,  "Hello World", 7.5);
     </pre>     </pre>
     */     */
   #if 1
     static void put(     static void put(
         LogFileType logFileType,         LogFileType logFileType,
         const String& systemId,         const String& systemId,
         Uint32 severity,                  Uint32 logLevel,
         const String& formatString,         const String& formatString,
         const Formatter::Arg& arg0 = Formatter::Arg(),                  const Formatter::Arg& arg0,
         const Formatter::Arg& arg1 = Formatter::Arg(),                  const Formatter::Arg& arg1,
         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 put(
                   LogFileType logFileType,
                   const String& systemId,
                   Uint32 logLevel,
                   const String& formatString);
   
       static void put(
                   LogFileType logFileType,
                   const String& systemId,
                   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>
     */     */
     static void setHomeDirectory(const String& homeDirectory);  #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
  
     /* clean - Cleans the logger files.  
     @param directory Defines the directory that the logs are in      // _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::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);
   #endif
   
   
       /** setHomeDirectory
     */     */
     static void clean(const String& directory);      static void setHomeDirectory(const String& homeDirectory);
  
     /** setSeverityMask      /** setlogLevelMask
     */     */
     static void setSeverityMask(const Uint32);      static void setlogLevelMask(const String logLevelList);
  
     /** setLogWriteControlMask     /** setLogWriteControlMask
     */     */
     static void setLogWriteControlMask(const Uint32);     static void setLogWriteControlMask(const Uint32);
  
       static Boolean isValidlogLevel(const String logLevel);
 private: private:
  
   
     static LoggerRep* _rep;     static LoggerRep* _rep;
     static String _homeDirectory;     static String _homeDirectory;
     static Uint32 _severityMask;     static Uint32 _severityMask;
     static Uint32 _writeControlMask;     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 PEGASUS_NAMESPACE_END


Legend:
Removed from v.1.11  
changed lines
  Added in v.1.18.4.1

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2