com.yahoo.bard.webservice.logging

Class LogBlock

java.lang.Object

com.yahoo.bard.webservice.logging.LogBlock

public class LogBlock
extends Object

Represents the information that is written in a single log line per http request. Information is progressively appended to this context according to the handling path of the request. Finally, the LogBlock is exported as JSON string and written to the appropriate output via the logging framework.

Field Summary

Fields

Modifier and Type	Field and Description
String	uuid

Constructor Summary

Constructors

Constructor and Description
LogBlock(String uuid) Given a universally unique identifier as string construct a logging context.

Method Summary

Modifier and Type	Method and Description
protected void	add(Class<? extends LogInfo> phaseClass) Add an entry of given class in this LogBlock that holds no information.
void	add(LogInfo phase) Append a part of logging information defined in this LogBlock.
Map<String,LogInfo>	any() JSON serialization-focused getter that will "un wrap" the map, making it's entries appear to be those of the parent class.
LogInfo	get(String name) Return a part of logging information in this LogBlock.
LogBlock	withUuid(String uuid) Create a new LogBlock with the same body but updated uuid.

Methods inherited from class java.lang.Object

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

Field Detail

uuid

public final String uuid

Constructor Detail

LogBlock

public LogBlock(String uuid)

Given a universally unique identifier as string construct a logging context.

Parameters:

uuid - A string identifier that is meant to be unique across the logfile.

Method Detail

add

public void add(LogInfo phase)

Append a part of logging information defined in this LogBlock.

Parameters:

phase - A LogInfo object including the information to be logged.

get

public LogInfo get(String name)

Return a part of logging information in this LogBlock.

Parameters:

name - Name of a LogInfo object to be returned

Returns:

a part of logging information in this LogBlock

withUuid

public LogBlock withUuid(String uuid)

Create a new LogBlock with the same body but updated uuid.

Parameters:

uuid - New uuid.

Returns:

New LogBlock with updated uuid.

add

protected void add(Class<? extends LogInfo> phaseClass)

Add an entry of given class in this LogBlock that holds no information. It is meant to be used only to define the order of LogInfo parts inside a LogBlock.

Parameters:

phaseClass - A string to identify the class that will hold the logs passed as arguments.

any

public Map<String,LogInfo> any()

JSON serialization-focused getter that will "un wrap" the map, making it's entries appear to be those of the parent class.

Returns:

The map to unwrap