org.dataone.cn.log

Class MetricLogEntry

java.lang.Object

org.dataone.cn.log.MetricLogEntry

public class MetricLogEntry
extends Object

Represents an metric log entry message. The entry will be serialized as a JSON message to a log file that is sent to a log analysis engine Minimally, the JSON structure will return the event and the date and time the event occurred. Currently, the message is serialized in the toString method. However, this class may easily be annotated for Jackson. There is also the Java API for JSON bindings in Java EE (but why do we want to install that?), and GSON Google's Json library.

Author:

waltz

Constructor Summary

Constructors

Constructor and Description
MetricLogEntry(MetricEvent event)
MetricLogEntry(MetricEvent event, org.dataone.service.types.v1.NodeReference nodeId)
MetricLogEntry(MetricEvent event, org.dataone.service.types.v1.NodeReference nodeId, org.dataone.service.types.v1.Identifier pid)
MetricLogEntry(MetricEvent event, org.dataone.service.types.v1.NodeReference nodeId, org.dataone.service.types.v1.Identifier pid, String message)
MetricLogEntry(MetricEvent event, org.dataone.service.types.v1.NodeReference nodeId, org.dataone.service.types.v1.Identifier pid, String message, Long timeToCompleteEventMS)
MetricLogEntry(MetricEvent event, String message, org.dataone.service.types.v1.NodeReference nodeId, org.dataone.service.types.v1.Identifier pid, Long timeToCompleteEventMS, Date dateLogged)

Method Summary

Methods

Modifier and Type	Method and Description
Date	getDateLogged()
MetricEvent	getEvent()
String	getMessage()
org.dataone.service.types.v1.NodeReference	getNodeId()
org.dataone.service.types.v1.Identifier	getPid()
Long	getTimeToCompleteEventMS()
void	setDateLogged(Date dateLogged)
void	setEvent(MetricEvent event)
void	setMessage(String message)
void	setNodeId(org.dataone.service.types.v1.NodeReference nodeId)
void	setPid(org.dataone.service.types.v1.Identifier pid)
void	setTimeToCompleteEventMS(Long timeToCompleteEventMS)
String	toString() Transform the object into JSON

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricLogEntry

public MetricLogEntry(MetricEvent event)

MetricLogEntry

public MetricLogEntry(MetricEvent event,
              org.dataone.service.types.v1.NodeReference nodeId)

MetricLogEntry

public MetricLogEntry(MetricEvent event,
              org.dataone.service.types.v1.NodeReference nodeId,
              org.dataone.service.types.v1.Identifier pid)

MetricLogEntry

public MetricLogEntry(MetricEvent event,
              org.dataone.service.types.v1.NodeReference nodeId,
              org.dataone.service.types.v1.Identifier pid,
              String message)

MetricLogEntry

public MetricLogEntry(MetricEvent event,
              org.dataone.service.types.v1.NodeReference nodeId,
              org.dataone.service.types.v1.Identifier pid,
              String message,
              Long timeToCompleteEventMS)

MetricLogEntry

public MetricLogEntry(MetricEvent event,
              String message,
              org.dataone.service.types.v1.NodeReference nodeId,
              org.dataone.service.types.v1.Identifier pid,
              Long timeToCompleteEventMS,
              Date dateLogged)

Method Detail

getPid

public org.dataone.service.types.v1.Identifier getPid()

setPid

public void setPid(org.dataone.service.types.v1.Identifier pid)

getNodeId

public org.dataone.service.types.v1.NodeReference getNodeId()

setNodeId

public void setNodeId(org.dataone.service.types.v1.NodeReference nodeId)

getEvent

public MetricEvent getEvent()

setEvent

public void setEvent(MetricEvent event)

getDateLogged

public Date getDateLogged()

setDateLogged

public void setDateLogged(Date dateLogged)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

getTimeToCompleteEventMS

public Long getTimeToCompleteEventMS()

setTimeToCompleteEventMS

public void setTimeToCompleteEventMS(Long timeToCompleteEventMS)

toString

public String toString()

Transform the object into JSON

Overrides:

toString in class Object

Returns:

String