io.bigdime.alert.Alert Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bigdime-monitoring-impl Show documentation
There is a newer version: 0.9.3
Show newest version
/**
 * Copyright (C) 2015 Stubhub.
 */
package io.bigdime.alert;

import java.util.Date;

import io.bigdime.alert.Logger.ALERT_CAUSE;
import io.bigdime.alert.Logger.ALERT_SEVERITY;
import io.bigdime.alert.Logger.ALERT_TYPE;

/**
 * Alert object encapsulating alert related fields.
 *
 * @author Neeraj Jain
 *
 */
public class Alert {

	/**
	 * Name of the application that surfaced the alert situation.
	 */
	private String applicationName;
	/**
	 * Context in which the alert situation occurred, e.g. during reading phase,
	 * validation phase, writing phase etc.
	 */
	private String messageContext;
	/**
	 * Type of the alert, contains alert code and corresponding description.
	 */
	private ALERT_TYPE type;
	/**
	 * Reason for alert.
	 */
	private ALERT_CAUSE cause;
	/**
	 * Severity of the alert.
	 */
	private ALERT_SEVERITY severity;
	/**
	 * Detailed message describing the exception situation.
	 */
	private String message;

	/**
	 * Date and time when the alert occured.
	 */
	
	private Date dateTime;	
    /**
     * Log level of the alert eg:info,wran,debug,error
     */
	
	private String logLevel;
	/**
	 * Gets the name of application set on this object.
	 *
	 * @return applicationName
	 */
	public String getApplicationName() {
		return applicationName;
	}

	/**
	 * Sets the applicationName field on this object.
	 *
	 * @param applicationName
	 *            applicationName to set
	 */
	public void setApplicationName(String applicationName) {
		this.applicationName = applicationName;
	}

	/**
	 * Gets the messageContext(context in which error occured) field set on this
	 * object.
	 *
	 * @return messageContext field set on this object
	 */
	public String getMessageContext() {
		return messageContext;
	}

	/**
	 * Sets the messageContext field on this object.
	 *
	 * @param messageContext
	 *            messageContext to set
	 */
	public void setMessageContext(String messageContext) {
		this.messageContext = messageContext;
	}

	/**
	 * Gets the type of alert set on this object.
	 *
	 * @return type field set on this object
	 */
	public ALERT_TYPE getType() {
		return type;
	}

	/**
	 * Sets the type field on this object.
	 *
	 * @param type
	 *            type to set
	 */
	public void setType(ALERT_TYPE type) {
		this.type = type;
	}

	/**
	 * Gets the cause of the alert set on this object.
	 *
	 * @return cause field set on this object
	 */
	public ALERT_CAUSE getCause() {
		return cause;
	}

	/**
	 * Sets the cause of the alert on this object.
	 *
	 * @param cause
	 *            cause to set
	 */
	public void setCause(ALERT_CAUSE cause) {
		this.cause = cause;
	}

	/**
	 * Gets the severity of the alert set on this object.
	 *
	 * @return severity field set on this object
	 */
	public ALERT_SEVERITY getSeverity() {
		return severity;
	}

	/**
	 * Sets the severity or alert on this object.
	 *
	 * @param severity
	 *            severity to set
	 */
	public void setSeverity(ALERT_SEVERITY severity) {
		this.severity = severity;
	}

	/**
	 * Gets the detailed message for the alert set on this object.
	 *
	 * @return message field set on this object
	 */
	public String getMessage() {
		return message;
	}

	/**
	 * Sets the detailed message for alert on this object.
	 *
	 * @param message
	 *            message to set
	 */
	public void setMessage(String message) {
		this.message = message;
	}

	/**
	 * Gets the time when this alert was raised.
	 * @return Date object representing time when the alert was raised
	 */
	public Date getDateTime() {
		if(dateTime!=null){
			return new Date(dateTime.getTime());
			}else{
			return  new Date(System.currentTimeMillis());	
		}
	}

	/**
	 * Sets the time of alert.
	 * @param dateTime dateTime to set
	 */
	public void setDateTime(Date dateTime) {
		this.dateTime = new Date(dateTime.getTime());
	}
    /**
     * Gets the log level of the alert eg:info,warn,debug,error 
     * @return
     */
	public String getLogLevel() {
		return logLevel;
	}
    /**
     * Sets the log level of the alert eg:info,warn,debug,error 
     * @param logLevel
     */
	public void setLogLevel(String logLevel) {
		this.logLevel = logLevel;
	}
	
	

}