KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > jmx > snmp > internal > SnmpSubSystem


1 /*
2  * @(#)file SnmpSubSystem.java
3  * @(#)author Sun Microsystems, Inc.
4  * @(#)version 1.15
5  * @(#)date 08/02/09
6  *
7  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
8  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
9  *
10  */

11 package com.sun.jmx.snmp.internal;
12
13 import com.sun.jmx.snmp.SnmpEngine;
14 import com.sun.jmx.snmp.SnmpUnknownModelException;
15 import java.util.Hashtable JavaDoc;
16 /**
17  * 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.
18  * <P> Every sub system is associated to its SNMP engine.
19  * <p><b>This API is a Sun Microsystems internal API and is subject
20  * to change without notice.</b></p>
21  */

22 public interface SnmpSubSystem {
23     /**
24      * Returns the associated engine.
25      * @return The engine.
26      */

27     public SnmpEngine getEngine();
28
29     /**
30      * Adds a model to this sub system.
31      * @param id The model ID.
32      * @param model The model to add.
33      */

34     public void addModel(int id, SnmpModel model);
35
36     /**
37      * Removes a model from this sub system.
38      * @param id The model ID to remove.
39      * @return The removed model.
40      */

41     public SnmpModel removeModel(int id) throws SnmpUnknownModelException;
42
43     /**
44      * Gets a model from this sub system.
45      * @param id The model ID to get.
46      * @return The model.
47      */

48     public SnmpModel getModel(int id) throws SnmpUnknownModelException;
49     
50     /**
51      * Returns the set of model Ids that have been registered within the sub system.
52      */

53     public int[] getModelIds();
54
55     /**
56      * Returns the set of model names that have been registered within the sub system.
57      */

58     public String JavaDoc[] getModelNames();
59 }
60
Popular Tags