com.microsoft.applicationinsights.internal.logger

Enum InternalLogger

java.lang.Object

java.lang.Enum<InternalLogger>

com.microsoft.applicationinsights.internal.logger.InternalLogger

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<InternalLogger>

public enum InternalLogger
extends java.lang.Enum<InternalLogger>

A first, very simple version of an internal logger Note: this class is for the SDK internal use only, and therefore should ONLY be used by SDK classes. By default the logger will not log messages since it will use the 'NullLoggerOutput' and LoggerLevel of 'OFF' which both deny the output Created by gupele on 1/13/2015.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalLogger.LoggerOutputType
static class	InternalLogger.LoggingLevel

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
void	error(java.lang.String message, java.lang.Object... args) The main method, will delegate the call to the output only if the logger is enabled for errors, will not allow any exception thrown
void	info(java.lang.String message, java.lang.Object... args) The main method, will delegate the call to the output only if the logger is enabled for info messages, will not allow any exception thrown
void	initialize(java.lang.String loggerOutputType, java.util.Map<java.lang.String,java.lang.String> loggerData) The method will first try to find the logger level and then the logger type.
boolean	isErrorEnabled()
boolean	isInfoEnabled()
boolean	isTraceEnabled()
boolean	isWarnEnabled()
void	logAlways(InternalLogger.LoggingLevel requestLevel, java.lang.String message, java.lang.Object... args) The method will log the message in any case.
void	stop() Closes the Internal Logger for messages.
void	trace(java.lang.String message, java.lang.Object... args) The main method, will delegate the call to the output only if the logger is enabled for at least trace level, will not allow any exception thrown
static InternalLogger	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static InternalLogger[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	warn(java.lang.String message, java.lang.Object... args) The main method, will delegate the call to the output only if the logger is enabled for warnings, will not allow any exception thrown

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final InternalLogger INSTANCE

Method Detail

values

public static InternalLogger[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InternalLogger c : InternalLogger.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InternalLogger valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

initialize

public void initialize(java.lang.String loggerOutputType,
                       java.util.Map<java.lang.String,java.lang.String> loggerData)

The method will first try to find the logger level and then the logger type. Note that if there are problems initializing the data the internal logger will move to its default state which is LoggerLevel.OFF and no logger output (loggerOutput = null).

Parameters:

loggerOutputType - The requested logger type

loggerData - The data for the internal logger

stop

public void stop()

Closes the Internal Logger for messages. This method should only be called when the internal logger is not needed which is currently prior to the process exits, i.e. prior to shutdown of the process

isTraceEnabled

public boolean isTraceEnabled()

isInfoEnabled

public boolean isInfoEnabled()

isWarnEnabled

public boolean isWarnEnabled()

isErrorEnabled

public boolean isErrorEnabled()

error

public void error(java.lang.String message,
                  java.lang.Object... args)

The main method, will delegate the call to the output only if the logger is enabled for errors, will not allow any exception thrown

Parameters:

message - The message to log with possible placeholders.

args - The arguments that should be formatted into the placeholders.

warn

public void warn(java.lang.String message,
                 java.lang.Object... args)

The main method, will delegate the call to the output only if the logger is enabled for warnings, will not allow any exception thrown

Parameters:

message - The message to log with possible placeholders.

args - The arguments that should be formatted into the placeholders.

info

public void info(java.lang.String message,
                 java.lang.Object... args)

The main method, will delegate the call to the output only if the logger is enabled for info messages, will not allow any exception thrown

Parameters:

message - The message to log with possible placeholders.

args - The arguments that should be formatted into the placeholders.

trace

public void trace(java.lang.String message,
                  java.lang.Object... args)

The main method, will delegate the call to the output only if the logger is enabled for at least trace level, will not allow any exception thrown

Parameters:

message - The message to log with possible placeholders.

args - The arguments that should be formatted into the placeholders.

logAlways

public void logAlways(InternalLogger.LoggingLevel requestLevel,
                      java.lang.String message,
                      java.lang.Object... args)

The method will log the message in any case. It the logger is not initialized it will print to the console Otherwise the method will use the current logger but will print the message regardless of the logging level. The method is needed for publishing messages when the logger initialization data is unknown Either, before reading the file, or when there was error reading that configuration file, use with care!

Parameters:

requestLevel - - The level of the message

message - - The message to print

args - - The arguments that are part of the message