KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > snmp4j > agent > mo > snmp > AgentCapabilityList


1 /*_############################################################################
2   _##
3   _## SNMP4J-Agent - AgentCapabilityList.java
4   _##
5   _## Copyright (C) 2005-2007 Frank Fock (SNMP4J.org)
6   _##
7   _## Licensed under the Apache License, Version 2.0 (the "License");
8   _## you may not use this file except in compliance with the License.
9   _## You may obtain a copy of the License at
10   _##
11   _## http://www.apache.org/licenses/LICENSE-2.0
12   _##
13   _## Unless required by applicable law or agreed to in writing, software
14   _## distributed under the License is distributed on an "AS IS" BASIS,
15   _## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   _## See the License for the specific language governing permissions and
17   _## limitations under the License.
18   _##
19   _##########################################################################*/

20
21 package org.snmp4j.agent.mo.snmp;
22
23 import org.snmp4j.smi.OID;
24 import org.snmp4j.smi.OctetString;
25 import org.snmp4j.agent.mo.MOTableRow;
26
27 /**
28  * The agent capabilities list exports information about the agent's
29  * capabilities.
30  *
31  * @author Frank Fock
32  * @version 1.0
33  */

34 public interface AgentCapabilityList {
35
36   /**
37    * Add a capabilities description to the exported list.
38    * @param sysORID
39    * the OID of an AGENT-CAPABILITIES statement.
40    * @param sysORDescr
41    * A textual description of the capabilities identified
42    * by the corresponding instance of sysORID.
43    * @return
44    * the index OID of the entry that uniquely identifies it.
45    */

46   OID addSysOREntry(OID sysORID, OctetString sysORDescr);
47
48   /**
49    * Remove a capabilities description from the exported list.
50    * @param index
51    * the index OID previously returned by {@link #addSysOREntry}.
52    * @return MOTableRow
53    * the removed sysOREntry row or <code>null</code> if such a row
54    * could not be found.
55    */

56   MOTableRow removeSysOREntry(OID index);
57 }
58
Popular Tags