SystemEvent (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.sdk.event.SystemEvent

All Implemented Interfaces:

UseDefaultConverter, Serializable, Cloneable, Comparable<SystemEvent>, Iterable<Map.Entry<String,String>>
```
public class SystemEvent
extends Object
implements Comparable<SystemEvent>, Iterable<Map.Entry<String,String>>, Serializable, UseDefaultConverter, Cloneable
```
A significant event in the system.
A series of events may be linked to each other using correlationIds. The first event in the series should have its correlationState set to SystemEvent.CorrelationState.START. The last event in the series should have its correlationState set to SystemEvent.CorrelationState.END. Any correlated events in between the start and end should have their correlationState set to SystemEvent.CorrelationState.INTERMEDIATE. All events in the series must share the same correlationId. The system does not enforce any of these conventions. Correlation IDs must be 255 characters or less.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SystemEvent.Acknowledgement

static class SystemEvent.CorrelationState

static class SystemEvent.Severity

Nested Classes
Modifier and Type	Class and Description
`static class`	`SystemEvent.Acknowledgement`
`static class`	`SystemEvent.CorrelationState`
`static class`	`SystemEvent.Severity`

Constructor Summary

Constructors
Constructor and Description
`SystemEvent()` Default constructor that sets the id to a random GUID, the date to `System.currentTimeMillis()`, and severity to `SystemEvent.Severity.SYS_INFO`
`SystemEvent(SystemEvent.Severity severity, String subsystem, String description)` Constructor, date set to `System.currentTimeMillis()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SystemEvent`	`addMetadata(String key, boolean value)` Returns this event.
`SystemEvent`	`addMetadata(String key, double value)` Returns this event.
`SystemEvent`	`addMetadata(String key, float value)` Returns this event.
`SystemEvent`	`addMetadata(String key, int value)` Returns this event.
`SystemEvent`	`addMetadata(String key, long value)` Returns this event.
`SystemEvent`	`addMetadata(String key, String value)` Returns this event.
`SystemEvent`	`addMetadata(String key, Throwable t)` Adds the Exception's messages and all messages of all causes to the event in the form:
`SystemEvent`	`clone()`
`int`	`compareTo(SystemEvent other)`
`boolean`	`containsMetadata(String key)` True if the specified metdata key has a value in this event.
`boolean`	`equals(Object obj)`
`SystemEvent.Acknowledgement`	`getAcknowledgement()`
`String`	`getCorrelationId()`
`SystemEvent.CorrelationState`	`getCorrelationState()`
`long`	`getDate()` Date of the event.
`String`	`getDescription()`
`long`	`getId()`
`BaseTypesMap<String,String>`	`getMetadata()`
`String`	`getMetadata(String key)` Returns the value of the metadata key or null if it does not exist.
`boolean`	`getMetadata(String key, boolean defaultValue)` Returns the value of the metadata key or null if it does not exist.
`double`	`getMetadata(String key, double defaultValue)` Returns the value of the metadata key or null if it does not exist.
`float`	`getMetadata(String key, float defaultValue)` Returns the value of the metadata key or null if it does not exist.
`int`	`getMetadata(String key, int defaultValue)` Returns the value of the metadata key or null if it does not exist.
`long`	`getMetadata(String key, long defaultValue)` Returns the value of the metadata key or null if it does not exist.
`String`	`getMetadata(String key, String defaultValue)` Returns the value of the metadata key or null if it does not exist.
`String`	`getNodeset()` The name of the nodeset that produced the event.
`SystemEvent.Severity`	`getSeverity()`
`String`	`getSubsystem()` The AIE subsytem that caused the event.
`int`	`hashCode()`
`Iterator<Map.Entry<String,String>>`	`iterator()` metadata about the event.
`void`	`setAcknowledgement(SystemEvent.Acknowledgement acknowledgement)`
`void`	`setCorrelationId(String correlationId)`
`void`	`setCorrelationState(SystemEvent.CorrelationState correlationState)`
`void`	`setDate(long date)`
`void`	`setDescription(String message)`
`void`	`setId(long id)`
`void`	`setMetadata(BaseTypesMap<String,String> metadata)`
`void`	`setNodeset(String nodeset)`
`void`	`setSeverity(SystemEvent.Severity severity)`
`void`	`setSubsystem(String subsystem)`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Constructor Detail
- SystemEvent
```
public SystemEvent()
```
  Default constructor that sets the id to a random GUID, the date to System.currentTimeMillis(), and severity to SystemEvent.Severity.SYS_INFO
- SystemEvent
```
public SystemEvent(SystemEvent.Severity severity,
                   String subsystem,
                   String description)
```
  Constructor, date set to System.currentTimeMillis()

Method Detail

getId
```
public long getId()
```

setId
```
public void setId(long id)
```

getSubsystem
```
public String getSubsystem()
```
The AIE subsytem that caused the event. This can be used by snmp filters for easily classifying events String (as opposed to enum) to allow for new event types by modules and/or customers.

setSubsystem

public void setSubsystem(String subsystem)

getMetadata

public BaseTypesMap<String,String> getMetadata()

setMetadata

public void setMetadata(BaseTypesMap<String,String> metadata)

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String message)

getSeverity

public SystemEvent.Severity getSeverity()

setSeverity

public void setSeverity(SystemEvent.Severity severity)

getDate
```
public long getDate()
```
Date of the event. Defaulted by the framework to System.currentTimeMillis() but settable by code. (for GC case)

setDate
```
public void setDate(long date)
```

getCorrelationId
```
public String getCorrelationId()
```

setCorrelationId

public void setCorrelationId(String correlationId)

getCorrelationState

public SystemEvent.CorrelationState getCorrelationState()

setCorrelationState

public void setCorrelationState(SystemEvent.CorrelationState correlationState)

addMetadata

public SystemEvent addMetadata(String key,
                               String value)

Returns this event.

addMetadata

public SystemEvent addMetadata(String key,
                               int value)

Returns this event.

addMetadata

public SystemEvent addMetadata(String key,
                               long value)

Returns this event.

addMetadata

public SystemEvent addMetadata(String key,
                               double value)

Returns this event.

addMetadata

public SystemEvent addMetadata(String key,
                               boolean value)

Returns this event.

addMetadata

public SystemEvent addMetadata(String key,
                               float value)

Returns this event.

addMetadata

public SystemEvent addMetadata(String key,
                               Throwable t)

Adds the Exception's messages and all messages of all causes to the event in the form:

 key.message.0 = top level exception message
 key.message.1 = cause of top level message
 key.message.2 = cause of first caused exception
 key.message.n = root cause message

containsMetadata
```
public boolean containsMetadata(String key)
```
True if the specified metdata key has a value in this event.

getMetadata
```
public String getMetadata(String key)
```
Returns the value of the metadata key or null if it does not exist.