com.microsoft.identity.client

Class Logger

java.lang.Object

com.microsoft.identity.client.Logger

public final class Logger
extends java.lang.Object

MSAL Logger for diagnostic purpose. The sdk generates logs with both logcat logging or the external logger. By default, the sdk enables logging with logcat. To turn off logging:

 
     Logger.getInstance().setEnableLogcatLog(false);
 
 

To enable the custom logger, set the external logger implementing ILoggerCallback.

 
     Logger.getInstance().setExternalLogger(new Logger.ILoggerCallback() {
     @Override
     public void log(String tag, Logger.LogLevel logLevel, String message,
         boolean containsPII) { }
     });
 
 

Loglevel can be specified at Logger.LogLevel.ERROR, Logger.LogLevel.WARNING, Logger.LogLevel.INFO and Logger.LogLevel.VERBOSE. The sdk enables the verbose level logging by default, to set different level logging:

 
     Logger.getInstance().setLogLevel(Loglevel)
 
 

By default, the sdk doesn't send any log messages that contain PII (personal identifiable information) info. To enable PII logging:

 
     Logger.getInstance().setEnablePII(true);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Logger.LogLevel Enum class for LogLevel that the sdk recognizes.

Constructor Summary

Constructors

Constructor and Description
Logger()

Method Summary

Modifier and Type	Method and Description
static void	error(java.lang.String tag, com.microsoft.identity.client.RequestContext requestContext, java.lang.String errorMessage, java.lang.Throwable exception) Deprecated. use com.microsoft.identity.common.internal.logging.Logger#error(String, String, String, Throwable) instead.
static void	errorPII(java.lang.String tag, com.microsoft.identity.client.RequestContext requestContext, java.lang.String errorMessage, java.lang.Throwable exception) Deprecated. use com.microsoft.identity.common.internal.logging.Logger#errorPII(String, String, String, Throwable) instead.
static Logger	getInstance()
void	setEnableLogcatLog(boolean enableLogcatLog) Enable/Disable the Android logcat logging.
void	setEnablePII(boolean enablePII) Enable log message with PII (personal identifiable information) info.
void	setExternalLogger(ILoggerCallback externalLogger) Set the custom logger.
void	setLogLevel(Logger.LogLevel logLevel) Set the log level for diagnostic purpose.
static void	warning(java.lang.String tag, com.microsoft.identity.client.RequestContext requestContext, java.lang.String message) Deprecated. use com.microsoft.identity.common.internal.logging.Logger#warn(String, String, String) instead.
static void	warningPII(java.lang.String tag, com.microsoft.identity.client.RequestContext requestContext, java.lang.String message) Deprecated. use com.microsoft.identity.common.internal.logging.Logger#warnPII(String, String, String) instead.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Logger

public Logger()

Method Detail

getInstance

public static Logger getInstance()

Returns:

The single instance of Logger.

setLogLevel

public void setLogLevel(Logger.LogLevel logLevel)

Set the log level for diagnostic purpose. By default, the sdk enables the verbose level logging.

Parameters:

logLevel - The Logger.LogLevel to be enabled for the diagnostic logging.

setExternalLogger

public void setExternalLogger(ILoggerCallback externalLogger)

Set the custom logger. Configures external logging to configure a callback that the sdk will use to pass each log message. Overriding the logger callback is not allowed.

Parameters:

externalLogger - The reference to the ILoggerCallback that can output the logs to the designated places.

Throws:

java.lang.IllegalStateException - if external logger is already set, and the caller is trying to set it again.

setEnableLogcatLog

public void setEnableLogcatLog(boolean enableLogcatLog)

Enable/Disable the Android logcat logging. By default, the sdk enables it.

Parameters:

enableLogcatLog - True if enabling the logcat logging, false otherwise.

setEnablePII

public void setEnablePII(boolean enablePII)

Enable log message with PII (personal identifiable information) info. By default, MSAL doesn't log any PII.

Parameters:

enablePII - True if enabling PII info to be logged, false otherwise.

error

@Deprecated
public static void error(java.lang.String tag,
                                      com.microsoft.identity.client.RequestContext requestContext,
                                      java.lang.String errorMessage,
                                      java.lang.Throwable exception)

Deprecated. use com.microsoft.identity.common.internal.logging.Logger#error(String, String, String, Throwable) instead.

Send a Logger.LogLevel.ERROR log message without PII.

errorPII

@Deprecated
public static void errorPII(java.lang.String tag,
                                         com.microsoft.identity.client.RequestContext requestContext,
                                         java.lang.String errorMessage,
                                         java.lang.Throwable exception)

Deprecated. use com.microsoft.identity.common.internal.logging.Logger#errorPII(String, String, String, Throwable) instead.

Send a Logger.LogLevel.ERROR log message with PII.

warning

@Deprecated
public static void warning(java.lang.String tag,
                                        com.microsoft.identity.client.RequestContext requestContext,
                                        java.lang.String message)

Deprecated. use com.microsoft.identity.common.internal.logging.Logger#warn(String, String, String) instead.

Send a Logger.LogLevel.WARNING log message without PII.

warningPII

@Deprecated
public static void warningPII(java.lang.String tag,
                                           com.microsoft.identity.client.RequestContext requestContext,
                                           java.lang.String message)

Deprecated. use com.microsoft.identity.common.internal.logging.Logger#warnPII(String, String, String) instead.

Send a Logger.LogLevel.WARNING log message with PII.