0N/A/*
2362N/A * Copyright (c) 2002, 2003, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/Apackage com.sun.jmx.snmp;
0N/A
0N/A/**
0N/A * This engine is conformant with the RFC 2571. It is the main object within an SNMP entity (agent, manager...).
0N/A * To an engine is associated an {@link SnmpEngineId}.
0N/A * Engine instantiation is based on a factory {@link com.sun.jmx.snmp.SnmpEngineFactory SnmpEngineFactory}.
0N/A * When an <CODE> SnmpEngine </CODE> is created, a User based Security Model (USM) is initialized. The security configuration is located in a text file.
0N/A * The text file is read when the engine is created.
0N/A * <p>Note that the engine is not used when the agent is SNMPv1/SNMPv2 only.
0N/A<P> The USM configuration text file is remotely updatable using the USM Mib.</P>
0N/A<P> User that are configured in the Usm text file are nonVolatile. </P>
0N/A<P> Usm Mib userEntry supported storage type values are : volatile or nonVolatile only. Other values are rejected and a wrongValue is returned) </P>
0N/A<ul>
0N/A<li> volatile means that user entry is not flushed in security file </li>
0N/A<li> nonVolatile means that user entry is flushed in security file </li>
0N/A<li> If a nonVolatile row is set to be volatile, it will be not flushed in the file </li>
0N/A<li>If a volatile row created from the UsmMib is set to nonVolatile, it will be flushed in the file (if the file exist and is writable otherwise an inconsistentValue is returned)</li>
0N/A</ul>
0N/A * <p><b>This API is a Sun Microsystems internal API and is subject
0N/A * to change without notice.</b></p>
0N/A * @since 1.5
0N/A */
0N/Apublic interface SnmpEngine {
0N/A /**
0N/A * Gets the engine time in seconds. This is the time from the last reboot.
0N/A * @return The time from the last reboot.
0N/A */
0N/A public int getEngineTime();
0N/A /**
0N/A * Gets the engine Id. This is unique for each engine.
0N/A * @return The engine Id object.
0N/A */
0N/A public SnmpEngineId getEngineId();
0N/A
0N/A /**
0N/A * Gets the engine boot number. This is the number of time this engine has rebooted. Each time an <CODE>SnmpEngine</CODE> is instantiated, it will read this value in its Lcd, and store back the value incremented by one.
0N/A * @return The engine's number of reboot.
0N/A */
0N/A public int getEngineBoots();
0N/A
0N/A /**
0N/A * Gets the Usm key handler.
0N/A * @return The key handler.
0N/A */
0N/A public SnmpUsmKeyHandler getUsmKeyHandler();
0N/A}