logger.h

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

        const String& formatString,
        const Formatter::Arg& arg0);

    /** Optimized two-argument form of put_l().
    */
    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);

    /** Optimized three-argument form of put_l().
    */
    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);

    /** 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,
        const Formatter::Arg& arg3,
        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);

    /** Optimized three-argument form of trace().
    */
    static void trace(
        LogFileType logFileType,
        const String& systemId,
        const Uint32 logComponent,
        const String& formatString);

    /** Optimized one-argument form of trace().
    */
    static void trace(
        LogFileType logFileType,
        const String& systemId,
        const Uint32 logComponent,
        const String& formatString,
        const Formatter::Arg& arg0);

    /** Optimized two-argument form of trace().
    */
    static void trace(
        LogFileType logFileType,
        const String& systemId,
        const Uint32 logComponent,
        const String& formatString,
        const Formatter::Arg& arg0,
        const Formatter::Arg& arg1);

    /** Optimized three-argument form of trace().
    */
    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);

    /** 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,
        const Formatter::Arg& arg1,
        const Formatter::Arg& arg2,
        const Formatter::Arg& arg3,
        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);

    /** Optimized zero-argument form of trace_l().
    */
    static void trace_l(
        LogFileType logFileType,
        const String& systemId,
        const Uint32 logComponent,
        const String& messageId,
        const String& formatString);

    /** Optimized one-argument form of trace_l().
    */
    static void trace_l(
        LogFileType logFileType,
        const String& systemId,
        const Uint32 logComponent,
        const String& messageId,
        const String& formatString,
        const Formatter::Arg& arg0);

    /** Optimized two-argument form of trace_l().
    */
    static void trace_l(
        LogFileType logFileType,
        const String& systemId,
        const Uint32 logComponent,
        const String& messageId,
        const String& formatString,
        const Formatter::Arg& arg0,
        const Formatter::Arg& arg1);

    /** Optimized three-argument form of trace_l().
    */
    static void trace_l(
        LogFileType logFileType,
        const String& systemId,
        const Uint32 logComponent,
        const String& messageId,
        const String& formatString,
        const Formatter::Arg& arg0,
        const Formatter::Arg& arg1,
        const Formatter::Arg& arg2);

    /** setHomeDirectory
    */
    static void setHomeDirectory(const String& homeDirectory);

    /** setlogLevelMask
    */
    static void setlogLevelMask(const String logLevelList);

    /** setLogWriteControlMask
    */
    static void setLogWriteControlMask(const Uint32);

    /** Returns true if the given string is one of the legal log levels.
    */
    static Boolean isValidlogLevel(const String logLevel);

    /** Tests if a log entry would be created by this call before
        the logger is called.  This function is intended to be used
        within the server for high usage log entries to avoid the
        overhead of doing the call when no log is created.
        @param logLevel Uint32 defining the level of the log to be
        executed.
        <p><b>Example:</b>
        <pre>
        if (Logger::wouldLog(Logger::TRACE))
        {
            Logger::put(Logger::STANDARD_LOG, System::CIMSERVER,
                Logger::TRACE, "HTTPMessage - HTTP header name: $0  "
                "HTTP header value: $1" ,name,value);
        }
        </pre>
    */
    static Boolean wouldLog(Uint32 logLevel)
    {
        return (_severityMask & logLevel) != 0;
    }

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,
        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

#endif /* Pegasus_Logger_h */