| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2001-2003 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | package com.sun.jmx.snmp.internal; |
| 26 | |
| 27 | import com.sun.jmx.snmp.SnmpEngine; |
| 28 | import com.sun.jmx.snmp.SnmpUnknownModelException; |
| 29 | import java.util.Hashtable; |
| 30 | /** |
| 31 | * SNMP sub system interface. To allow engine framework integration, a sub system must implement this interface. A sub system is a model manager. Every model is identified by an ID. A sub system can retrieve a previously registered model using this ID. |
| 32 | * <P> Every sub system is associated to its SNMP engine. |
| 33 | * <p><b>This API is a Sun Microsystems internal API and is subject |
| 34 | * to change without notice.</b></p> |
| 35 | */ |
| 36 | public interface SnmpSubSystem { |
| 37 | /** |
| 38 | * Returns the associated engine. |
| 39 | * @return The engine. |
| 40 | */ |
| 41 | public SnmpEngine getEngine(); |
| 42 | |
| 43 | /** |
| 44 | * Adds a model to this sub system. |
| 45 | * @param id The model ID. |
| 46 | * @param model The model to add. |
| 47 | */ |
| 48 | public void addModel(int id, SnmpModel model); |
| 49 | |
| 50 | /** |
| 51 | * Removes a model from this sub system. |
| 52 | * @param id The model ID to remove. |
| 53 | * @return The removed model. |
| 54 | */ |
| 55 | public SnmpModel removeModel(int id) throws SnmpUnknownModelException; |
| 56 | |
| 57 | /** |
| 58 | * Gets a model from this sub system. |
| 59 | * @param id The model ID to get. |
| 60 | * @return The model. |
| 61 | */ |
| 62 | public SnmpModel getModel(int id) throws SnmpUnknownModelException; |
| 63 | |
| 64 | /** |
| 65 | * Returns the set of model Ids that have been registered within the sub system. |
| 66 | */ |
| 67 | public int[] getModelIds(); |
| 68 | |
| 69 | /** |
| 70 | * Returns the set of model names that have been registered within the sub system. |
| 71 | */ |
| 72 | public String[] getModelNames(); |
| 73 | } |