Class NetloggerEvent
- java.lang.Object
-
- edu.isi.pegasus.common.logging.format.NetloggerEvent
-
-
Field Summary
Fields Modifier and Type Field Description private LogEvent
mLogEvent
The current event object.private EventLogMessage
mMessage
The current log event message.private java.lang.String
mProgram
The name of the program.
-
Constructor Summary
Constructors Constructor Description NetloggerEvent()
The default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Event
add(java.lang.String key, java.lang.String value)
Add to the log message.java.lang.String
createEntityHierarchyMessage(java.lang.String parentType, java.lang.String parentID, java.lang.String childIdType, java.util.Collection<java.lang.String> childIDs)
Creates a log message that connects the parent entities with the children.java.lang.String
createLogMessage()
Creates a log message with the contents of the internal log buffer.java.lang.String
createLogMessageAndReset()
Creates a log message with the contents of the internal log buffer.java.lang.String
getEndEventMessage()
Creates the end message for the event.java.lang.String
getEventName()
Returns the name of event that is currently associated with the log messages.java.lang.String
getProgramName(java.lang.String name)
Returns the program name for the software whose log statement are logged.java.lang.String
getStartEventMessage()
Creates the start message for the event.void
reset()
Reset the internal log message buffer associated with the eventvoid
setEvent(java.lang.String name, java.lang.String entityName, java.lang.String entityID)
Set the event that is to be associated with the log messages.void
setEvent(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> map)
Adds the event that is to be associated with the log messages onto an internal stackvoid
setProgramName(java.lang.String name)
Sets the program name for the software whose log statement are logged.
-
-
-
Field Detail
-
mProgram
private java.lang.String mProgram
The name of the program.
-
mLogEvent
private LogEvent mLogEvent
The current event object.
-
mMessage
private EventLogMessage mMessage
The current log event message.
-
-
Method Detail
-
setProgramName
public void setProgramName(java.lang.String name)
Sets the program name for the software whose log statement are logged.- Specified by:
setProgramName
in interfaceEvent
- Parameters:
name
-
-
getProgramName
public java.lang.String getProgramName(java.lang.String name)
Returns the program name for the software whose log statement are logged.- Specified by:
getProgramName
in interfaceEvent
- Parameters:
name
-- Returns:
- the name of the program
-
setEvent
public void setEvent(java.lang.String name, java.lang.String entityName, java.lang.String entityID)
Set the event that is to be associated with the log messages.
-
setEvent
public void setEvent(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> map)
Adds the event that is to be associated with the log messages onto an internal stack
-
getEventName
public java.lang.String getEventName()
Returns the name of event that is currently associated with the log messages.- Specified by:
getEventName
in interfaceEvent
- Returns:
- the event to be associated
-
getStartEventMessage
public java.lang.String getStartEventMessage()
Creates the start message for the event.- Specified by:
getStartEventMessage
in interfaceEvent
- Returns:
- start event message
-
getEndEventMessage
public java.lang.String getEndEventMessage()
Creates the end message for the event.- Specified by:
getEndEventMessage
in interfaceEvent
- Returns:
- end event message
-
reset
public void reset()
Reset the internal log message buffer associated with the event
-
add
public Event add(java.lang.String key, java.lang.String value)
Add to the log message.
-
createLogMessage
public java.lang.String createLogMessage()
Creates a log message with the contents of the internal log buffer.- Specified by:
createLogMessage
in interfaceEvent
- Returns:
- the log message
-
createLogMessageAndReset
public java.lang.String createLogMessageAndReset()
Creates a log message with the contents of the internal log buffer. It then resets the buffer before returning the log message- Specified by:
createLogMessageAndReset
in interfaceEvent
- Returns:
- the log message
-
createEntityHierarchyMessage
public java.lang.String createEntityHierarchyMessage(java.lang.String parentType, java.lang.String parentID, java.lang.String childIdType, java.util.Collection<java.lang.String> childIDs)
Creates a log message that connects the parent entities with the children. For e.g. can we use to create the log messages connecting the jobs with the workflow they are part of.- Specified by:
createEntityHierarchyMessage
in interfaceEvent
- Parameters:
parentType
- the type of parent entityparentID
- the id of the parent entitychildIdType
- the type of children entitieschildIDs
- Collection of children id's- Returns:
- entity hierarch message.
-
-