org.netxms.client.events.EventInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of netxms-client Show documentation
NetXMS client library - complete JAVA API
There is a newer version: 5.0.6
/**
 * NetXMS - open source network management system
 * Copyright (C) 2003-2021 Victor Kirhenshtein
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
package org.netxms.client.events;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

import org.netxms.base.NXCPMessage;

/**
 * Information about NetXMS event
 */
public class EventInfo
{
   private long id;
   private Date timeStamp;
   private long sourceObjectId;
   private int code;
   private String name;
   private int severity;
   private String message;
   private EventInfo parent;
   private List children;

   /**
    * Create from NXCP message.
    *
    * @param msg NXCP message
    * @param baseId base field ID
    * @param parent parent event (the one this event is correlated to) or null 
    */
   public EventInfo(NXCPMessage msg, long baseId, EventInfo parent)
   {
      this.parent = parent;
      if (parent != null)
         parent.addChild(this);
      children = null;
      id = msg.getFieldAsInt64(baseId);
      code = msg.getFieldAsInt32(baseId + 2);
      name = msg.getFieldAsString(baseId + 3);
      severity = msg.getFieldAsInt32(baseId + 4);
      sourceObjectId = msg.getFieldAsInt64(baseId + 5);
      timeStamp = msg.getFieldAsDate(baseId + 6);
      message = msg.getFieldAsString(baseId + 7);
   }

   /**
    * Add child event
    *
    * @param e child event (event correlated to this event)
    */
   private void addChild(EventInfo e)
   {
      if (children == null)
         children = new ArrayList();
      children.add(e);
   }

   /**
    * Get unique event ID.
    *
    * @return unique event ID
    */
   public long getId()
   {
      return id;
   }

   /**
    * Get parent event.
    *
    * @return parent event or null
    */
   public EventInfo getParent()
   {
      return parent;
   }

   /**
    * @return the timeStamp
    */
   public Date getTimeStamp()
   {
      return timeStamp;
   }

   /**
    * @return the sourceObjectId
    */
   public long getSourceObjectId()
   {
      return sourceObjectId;
   }

   /**
    * @return the code
    */
   public int getCode()
   {
      return code;
   }

   /**
    * Get event name
    *
    * @return event name
    */
   public String getName()
   {
      return name;
   }

   /**
    * @return the severity
    */
   public int getSeverity()
   {
      return severity;
   }

   /**
    * @return the message
    */
   public String getMessage()
   {
      return message;
   }

   /**
    * @return the children
    */
   public EventInfo[] getChildren()
   {
      return (children != null) ? children.toArray(new EventInfo[children.size()]) : new EventInfo[0];
   }

   /**
    * Check if this object has children
    *
    * @return true if this object has children
    */
   public boolean hasChildren()
   {
      return (children != null) && (children.size() > 0);
   }
}