WebMimicLogFormatter (Web API 2021)

java.lang.Object
- com.microstrategy.utils.log.Formatter
- - com.microstrategy.utils.log.WebMimicLogFormatter

```
public class WebMimicLogFormatter
extends Formatter
```
This formatter logs messages that are compatible with the Web Mimic transcript log specification. The Web Mimic transcript can be seen as a "recording" of client interactions with the IServer. These recordings can be played back against the Java XML API to simulate a multiuser session. The implementation of this formatter makes the following assumptions: -- This class only needs to support the Java XML API -- There are no in/out parameters in any method signature. -- Any output parameters in a given method signature occur after the last input parameter -- Any given output parameter is of a class whose toString method returns a useful representation of the object (ex: IntWrapper and StringWrapper) -- Primitives are passed to logging methods as Strings -- A logged classname has has its fully qualified path prepended to it -- Every interface we're interested in is implemented by only one class. -- The thread calling format() is the one that logged the message. -- A LoggerHelper.ENTER record includes any output parameters in its parameter array -- If methods are added to the Java XML API, this class will be updated.

Since:

MicroStrategy Web 7.3.1 or earlier

Constructor Summary

Constructors
Constructor Description

WebMimicLogFormatter()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`format(LogRecord record)`	Formats a relevant message for a Java XML API interface method (ENTRY, RETURN, PROPERTY or EXCEPTION) according to the Web Mimic transcript spec and returns the formatted string.
`static void`	`removeThreadLocal()`

Methods inherited from class com.microstrategy.utils.log.Formatter
formatMessage, getExceptionMessage, getHead, getStackTrace, getTail

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WebMimicLogFormatter
```
public WebMimicLogFormatter()
```
- Method Detail
  - removeThreadLocal
```
public static void removeThreadLocal()
```
  - format
```
public java.lang.String format(LogRecord record)
```
    Formats a relevant message for a Java XML API interface method (ENTRY, RETURN, PROPERTY or EXCEPTION) according to the Web Mimic transcript spec and returns the formatted string. Note that for PROPERTY messages we will call this method recursively twice to create ENTRY and RETURN strings, and then concatenate the results.
    
    Specified by:
    
    format in class Formatter
    
    Parameters:
    
    record - the LogRecord for the trace message to be formatted.
    
    Returns:
    
    the log record, formatted according to the Web Mimic spec.