org.snmp4j.security.UsmTimeEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of snmp4j Show documentation
SNMP API for Java
There is a newer version: 3.8.2
/*_############################################################################
  _## 
  _##  SNMP4J 2 - UsmTimeEntry.java  
  _## 
  _##  Copyright (C) 2003-2016  Frank Fock and Jochen Katz (SNMP4J.org)
  _##  
  _##  Licensed under the Apache License, Version 2.0 (the "License");
  _##  you may not use this file except in compliance with the License.
  _##  You may obtain a copy of the License at
  _##  
  _##      http://www.apache.org/licenses/LICENSE-2.0
  _##  
  _##  Unless required by applicable law or agreed to in writing, software
  _##  distributed under the License is distributed on an "AS IS" BASIS,
  _##  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  _##  See the License for the specific language governing permissions and
  _##  limitations under the License.
  _##  
  _##########################################################################*/
package org.snmp4j.security;

import java.io.Serializable;
import org.snmp4j.smi.OctetString;

/**
 * The UsmTimeEntry class represents time synchronization
 * information associated with an engine ID.
 *
 * @author Frank Fock
 * @version 1.0
 */
public class UsmTimeEntry implements Serializable {

  private static final long serialVersionUID = -8064483016765127449L;

  private OctetString engineID;
  private int engineBoots;
  private int timeDiff;
  private int latestReceivedTime;

  /**
   * Creates a time entry with engine ID, engine boots and time.
   *
   * @param engineID
   *    the engine ID for which time synchronization information is created.
   * @param engineBoots
   *    the number of engine boots of the engine.
   * @param engineTime
   *    the time in seconds elapsed since the last reboot of the engine.
   */
  public UsmTimeEntry(OctetString engineID, int engineBoots, int engineTime) {
    this.engineID = engineID;
    this.engineBoots = engineBoots;
    setEngineTime(engineTime);
  }

  public OctetString getEngineID() {
    return engineID;
  }

  public int getEngineBoots() {
    return engineBoots;
  }

  public void setEngineBoots(int engineBoots) {
    this.engineBoots = engineBoots;
  }

  public int getTimeDiff() {
    return timeDiff;
  }

  public void setTimeDiff(int timeDiff) {
    this.timeDiff = timeDiff;
  }

  /**
   * Gets the time when a message has been received last from the associated
   * SNMP engine.
   * @return
   *    the engine time in seconds.
   */
  public int getLatestReceivedTime() {
    return latestReceivedTime;
  }

  /**
   * Sets the time when a message has been received last from the associated
   * SNMP engine.
   * @param latestReceivedTime
   *    the engine time in seconds.
   */
  public void setLatestReceivedTime(int latestReceivedTime) {
    this.latestReceivedTime = latestReceivedTime;
  }

  /**
   * Sets the engine time which also sets the last received engine time
   * to the supplied value.
   * @param engineTime
   *    the time in seconds elapsed since the last reboot of the engine.
   */
  public void setEngineTime(int engineTime) {
    this.latestReceivedTime = engineTime;
    this.timeDiff = engineTime - (int)(System.nanoTime()/UsmTimeTable.TIME_PRECISION);
  }
}