com.serotonin.mango.rt.event.type

Class AuditEventType

java.lang.Object

com.serotonin.mango.rt.event.type.EventType

com.serotonin.mango.rt.event.type.AuditEventType

All Implemented Interfaces:

com.serotonin.json.JsonSerializable

public class AuditEventType
extends EventType

Nested Class Summary

Nested classes/interfaces inherited from class com.serotonin.mango.rt.event.type.EventType

EventType.DuplicateHandling, EventType.EventSources

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	AUDIT_SETTINGS_PREFIX
private int	auditEventTypeId
private static java.util.List<EventTypeVO>	auditEventTypes
private static org.apache.commons.logging.Log	log
private User	raisingUser
private int	referenceId
private static ExportCodes	TYPE_CODES
static int	TYPE_COMPOUND_EVENT_DETECTOR
static int	TYPE_DATA_POINT
static int	TYPE_DATA_SOURCE
static int	TYPE_EVENT_HANDLER
static int	TYPE_MAINTENANCE_EVENT
static int	TYPE_POINT_EVENT_DETECTOR
static int	TYPE_POINT_LINK
static int	TYPE_SCHEDULED_EVENT

Fields inherited from class com.serotonin.mango.rt.event.type.EventType

SOURCE_CODES

Constructor Summary

Constructors

Constructor and Description
AuditEventType()
AuditEventType(int auditEventTypeId, int referenceId)

Method Summary

Modifier and Type	Method and Description
static void	addDataTypeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, int dataTypeId)
private static void	addEventTypeVO(int type, java.lang.String key)
static void	addExportCodeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, ExportCodes codes, int id)
static void	addPeriodMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, int periodType, int period)
static void	addPropertyChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, java.lang.Object fromValue, java.lang.Object toValue)
static void	addPropertyMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, boolean propertyValue)
static void	addPropertyMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, java.lang.Object propertyValue)
boolean	equals(java.lang.Object obj)
boolean	excludeUser(User user) Determines if the notification of this event to the given user should be suppressed.
int	getAuditEventTypeId()
static java.util.List<EventTypeVO>	getAuditEventTypes()
private static com.serotonin.web.i18n.LocalizableMessage	getBooleanMessage(boolean value)
int	getDuplicateHandling() Determines whether an event type that, once raised, will always first be deactivated or whether overriding events can be raised.
int	getEventSourceId()
static EventTypeVO	getEventType(int type)
private static com.serotonin.web.i18n.LocalizableMessage	getExportCodeMessage(ExportCodes exportCodes, int id)
int	getReferenceId1()
int	getReferenceId2()
int	hashCode()
void	jsonDeserialize(com.serotonin.json.JsonReader reader, com.serotonin.json.JsonObject json)
void	jsonSerialize(java.util.Map<java.lang.String,java.lang.Object> map)
static void	maybeAddAlarmLevelChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, int fromAlarmLevel, int toAlarmLevel)
static void	maybeAddDataTypeChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, int fromDataTypeId, int toDataTypeId)
static void	maybeAddExportCodeChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, ExportCodes exportCodes, int fromId, int toId)
static void	maybeAddPeriodChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, int fromPeriodType, int fromPeriod, int toPeriodType, int toPeriod)
static void	maybeAddPropertyChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, boolean fromValue, boolean toValue)
static void	maybeAddPropertyChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, int fromValue, int toValue)
static void	maybeAddPropertyChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list, java.lang.String propertyNameKey, java.lang.Object fromValue, java.lang.Object toValue)
static void	raiseAddedEvent(int auditEventTypeId, ChangeComparable<?> o)
static <T> void	raiseChangedEvent(int auditEventTypeId, T from, ChangeComparable<T> to)
static void	raiseDeletedEvent(int auditEventTypeId, ChangeComparable<?> o)
private static void	raiseEvent(int auditEventTypeId, ChangeComparable<?> o, java.lang.String key, java.lang.Object[] props)
static void	setEventTypeAlarmLevel(int type, int alarmLevel)
void	setRaisingUser(User raisingUser)
java.lang.String	toString()

Methods inherited from class com.serotonin.mango.rt.event.type.EventType

getCompoundEventDetectorId, getCompoundEventDetectorId, getDataPointId, getDataPointId, getDataSource, getDataSourceId, getInt, getMaintenanceEventId, getPointEventDetectorId, getPointEventDetectorId, getPublisher, getPublisherId, getScheduledEventId, getScheduleId, isSystemMessage

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

private static org.apache.commons.logging.Log log

AUDIT_SETTINGS_PREFIX

private static final java.lang.String AUDIT_SETTINGS_PREFIX

See Also:

Constant Field Values

TYPE_DATA_SOURCE

public static final int TYPE_DATA_SOURCE

See Also:

Constant Field Values

TYPE_DATA_POINT

public static final int TYPE_DATA_POINT

See Also:

Constant Field Values

TYPE_POINT_EVENT_DETECTOR

public static final int TYPE_POINT_EVENT_DETECTOR

See Also:

Constant Field Values

TYPE_COMPOUND_EVENT_DETECTOR

public static final int TYPE_COMPOUND_EVENT_DETECTOR

See Also:

Constant Field Values

TYPE_SCHEDULED_EVENT

public static final int TYPE_SCHEDULED_EVENT

See Also:

Constant Field Values

TYPE_EVENT_HANDLER

public static final int TYPE_EVENT_HANDLER

See Also:

Constant Field Values

TYPE_POINT_LINK

public static final int TYPE_POINT_LINK

See Also:

Constant Field Values

TYPE_MAINTENANCE_EVENT

public static final int TYPE_MAINTENANCE_EVENT

See Also:

Constant Field Values

TYPE_CODES

private static final ExportCodes TYPE_CODES

auditEventTypes

private static java.util.List<EventTypeVO> auditEventTypes

auditEventTypeId

private int auditEventTypeId

referenceId

private int referenceId

raisingUser

private User raisingUser

Constructor Detail

AuditEventType

public AuditEventType()

AuditEventType

public AuditEventType(int auditEventTypeId,
                      int referenceId)

Method Detail

getAuditEventTypes

public static java.util.List<EventTypeVO> getAuditEventTypes()

addEventTypeVO

private static void addEventTypeVO(int type,
                                   java.lang.String key)

getEventType

public static EventTypeVO getEventType(int type)

setEventTypeAlarmLevel

public static void setEventTypeAlarmLevel(int type,
                                          int alarmLevel)

raiseAddedEvent

public static void raiseAddedEvent(int auditEventTypeId,
                                   ChangeComparable<?> o)

raiseChangedEvent

public static <T> void raiseChangedEvent(int auditEventTypeId,
                                         T from,
                                         ChangeComparable<T> to)

raiseDeletedEvent

public static void raiseDeletedEvent(int auditEventTypeId,
                                     ChangeComparable<?> o)

raiseEvent

private static void raiseEvent(int auditEventTypeId,
                               ChangeComparable<?> o,
                               java.lang.String key,
                               java.lang.Object[] props)

addPropertyMessage

public static void addPropertyMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                      java.lang.String propertyNameKey,
                                      java.lang.Object propertyValue)

addPropertyMessage

public static void addPropertyMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                      java.lang.String propertyNameKey,
                                      boolean propertyValue)

addPeriodMessage

public static void addPeriodMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                    java.lang.String propertyNameKey,
                                    int periodType,
                                    int period)

addExportCodeMessage

public static void addExportCodeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                        java.lang.String propertyNameKey,
                                        ExportCodes codes,
                                        int id)

addDataTypeMessage

public static void addDataTypeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                      java.lang.String propertyNameKey,
                                      int dataTypeId)

maybeAddPropertyChangeMessage

public static void maybeAddPropertyChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                                 java.lang.String propertyNameKey,
                                                 int fromValue,
                                                 int toValue)

maybeAddPropertyChangeMessage

public static void maybeAddPropertyChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                                 java.lang.String propertyNameKey,
                                                 java.lang.Object fromValue,
                                                 java.lang.Object toValue)

maybeAddPropertyChangeMessage

public static void maybeAddPropertyChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                                 java.lang.String propertyNameKey,
                                                 boolean fromValue,
                                                 boolean toValue)

maybeAddAlarmLevelChangeMessage

public static void maybeAddAlarmLevelChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                                   java.lang.String propertyNameKey,
                                                   int fromAlarmLevel,
                                                   int toAlarmLevel)

maybeAddPeriodChangeMessage

public static void maybeAddPeriodChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                               java.lang.String propertyNameKey,
                                               int fromPeriodType,
                                               int fromPeriod,
                                               int toPeriodType,
                                               int toPeriod)

maybeAddExportCodeChangeMessage

public static void maybeAddExportCodeChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                                   java.lang.String propertyNameKey,
                                                   ExportCodes exportCodes,
                                                   int fromId,
                                                   int toId)

maybeAddDataTypeChangeMessage

public static void maybeAddDataTypeChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                                 java.lang.String propertyNameKey,
                                                 int fromDataTypeId,
                                                 int toDataTypeId)

getBooleanMessage

private static com.serotonin.web.i18n.LocalizableMessage getBooleanMessage(boolean value)

getExportCodeMessage

private static com.serotonin.web.i18n.LocalizableMessage getExportCodeMessage(ExportCodes exportCodes,
                                                                              int id)

addPropertyChangeMessage

public static void addPropertyChangeMessage(java.util.List<com.serotonin.web.i18n.LocalizableMessage> list,
                                            java.lang.String propertyNameKey,
                                            java.lang.Object fromValue,
                                            java.lang.Object toValue)

getEventSourceId

public int getEventSourceId()

Specified by:

getEventSourceId in class EventType

getAuditEventTypeId

public int getAuditEventTypeId()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDuplicateHandling

public int getDuplicateHandling()

Description copied from class: EventType

Determines whether an event type that, once raised, will always first be deactivated or whether overriding events can be raised. Overrides can occur in data sources and point locators where a retry of a failed action causes the same event type to be raised without the previous having returned to normal.

Specified by:

getDuplicateHandling in class EventType

Returns:

whether this event type can be overridden with newer event instances.

getReferenceId1

public int getReferenceId1()

Specified by:

getReferenceId1 in class EventType

getReferenceId2

public int getReferenceId2()

Specified by:

getReferenceId2 in class EventType

setRaisingUser

public void setRaisingUser(User raisingUser)

excludeUser

public boolean excludeUser(User user)

Description copied from class: EventType

Determines if the notification of this event to the given user should be suppressed. Useful if the action of the user resulted in the event being raised.

Overrides:

excludeUser in class EventType

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

jsonSerialize

public void jsonSerialize(java.util.Map<java.lang.String,java.lang.Object> map)

Specified by:

jsonSerialize in interface com.serotonin.json.JsonSerializable

Overrides:

jsonSerialize in class EventType

jsonDeserialize

public void jsonDeserialize(com.serotonin.json.JsonReader reader,
                            com.serotonin.json.JsonObject json)
                     throws com.serotonin.json.JsonException

Specified by:

jsonDeserialize in interface com.serotonin.json.JsonSerializable

Overrides:

jsonDeserialize in class EventType

Throws:

com.serotonin.json.JsonException