org.netxms.client.events.Event 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.Date;

import org.netxms.base.NXCPMessage;

/**
 * Read-only representation of NetXMS event. Intended to be created only
 * by client library communication module.
 */
public class Event
{
   private final long id;
   private final int code;
   private final Date timeStamp;
   private final long sourceId;
   private final long dciId;
   private final int severity;
   private final String message;
   private final String userTag;
   private final String[] parameters;

   /**
    * Create event object from NXCP message. Intended to be called only by NXCSession.
    *
    * @param msg NXCP message
    * @param baseId base field ID
    */
   public Event(final NXCPMessage msg, final long baseId)
   {
      long varId = baseId;

      id = msg.getFieldAsInt64(varId++);
      code = msg.getFieldAsInt32(varId++);
      timeStamp = msg.getFieldAsDate(varId++);
      sourceId = msg.getFieldAsInt64(varId++);
      severity = msg.getFieldAsInt32(varId++);
      message = msg.getFieldAsString(varId++);
      userTag = msg.getFieldAsString(varId++);

      int count = msg.getFieldAsInt32(varId++);
      parameters = new String[count];
      for(int i = 0; i < count; i++)
      {
         parameters[i] = msg.getFieldAsString(varId++);
      }
      dciId = msg.getFieldAsInt64(varId++);
   }

   /**
    * @return the id
    */
   public long getId()
   {
      return id;
   }

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

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

   /**
    * @return the sourceId
    */
   public long getSourceId()
   {
      return sourceId;
   }

   /**
    * @return the dciId
    */
   public long getDciId()
   {
      return dciId;
   }

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

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

   /**
    * @return the userTag
    */
   public String getUserTag()
   {
      return userTag;
   }

   /**
    * @return the parameters
    */
   public String[] getParameters()
   {
      return parameters;
   }
}