com.adventnet.snmp.mibs
Class AgentCapabilities

java.lang.Object
  com.adventnet.snmp.mibs.AgentCapabilities

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

JdbcAgentCapabilities

public class AgentCapabilities
extends java.lang.Object
implements java.io.Serializable

This class represents a AGENT-CAPABILITIES macro in a module.

The AGENT-CAPABILITIES macro is used to specify the implementation characterstics of the agent sub-system.

The AGENT-CAPABILITIES construct consists of a header that is followed by a list of implementation specifications

The header consists of the PRODUCT-RELEASE, STATUS, DESCRIPTION and the REFERENCE clause. The implementation specification includes the SUPPORTS, INCLUDES clauses and list of variations.

The Agent Capabilties Variation includes the SYNTAX, WRITE SYNTAX, ACCESS, CREATION-REQUIRES, DEFVAL and DESCRIPTION clause.

 The AGENT-CAPABILTIES macro definition is as follows
 
 lowerCaseName    AGENT-CAPABILITIES
        PRODUCT-RELEASE    <Text>
        STATUS             <StatusV2>
        DESCRIPTION        <Text> 
        [REFERENCE         <Text>] 
        [<Module>]* 
 ::= <oidValue>
 

Where

<Module> is the implementation specification. It corresponds to the AgentCapabilitiesModule object. There can be one or more AgentCapabilitiesModule.

<oidValue> is an object identifier value.

<Text> is a character String enclosed within double quotes.

<StatusV2> is any one of the following status values - "current", "deprecated" or "obsolete".

The AgentCapabilities instance can be obtained using any one of the following methods, after loading the MIB containing the AGENT-CAPABILITIES macro.

 MibOperations mibOps = new MibOperations();
 try
 {
  mibOps.loadMibModules("mibFile");
 }
 catch(Exception ex)
 {
  System.out.println(ex);
 }
 

 Method 1
 MibModule mod = mibops.getMibModule("moduleName");
 AgentCapabilities ac = mod.getAgentCapabilities("AgentCapabilitiesName");
 

 Method 2
 MibModule mod = mibops.getMibModule("moduleName");
 Enumeration en = mod.getDefinedAgentCapabilities();
 while(en.hasMoreElements())
 {
  AgentCapabilities ac = (AgentCapabilities)en.nextElement();
 }
 

Since:

AdventNet SNMP API 4

See Also:

Serialized Form

Field Summary

(package private) java.util.Vector	agentCap
(package private) java.lang.String	description
(package private) java.lang.String	name
(package private) java.lang.String	productrelease
(package private) java.lang.String	reference
(package private) java.lang.String	status

Constructor Summary

AgentCapabilities()

Method Summary

java.util.Vector	getACModules() Gets the acModules defined in this AgentCapabilties macro.
java.lang.String	getDescription() Gets the DESCRIPTION value for this AgentCapabilities macro.
java.lang.String	getName() Gets the name of this AgentCapabilities definition.
java.lang.String	getProductRelease() Gets the PRODUCT-RELEASE of this AgentCapabilities macro.
java.lang.String	getReference() Gets the REFERENCE value for this AgentCapabilities macro.
java.lang.String	getStatus() Gets the STATUS value for this AgentCapabilities macro.
java.lang.String	toString() Gives the name of this ObjectGroup object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

java.lang.String name

status

java.lang.String status

description

java.lang.String description

reference

java.lang.String reference

productrelease

java.lang.String productrelease

agentCap

java.util.Vector agentCap

Constructor Detail

AgentCapabilities

AgentCapabilities()

Method Detail

getName

public java.lang.String getName()

Gets the name of this AgentCapabilities definition. Same as the toString() method.

Returns:

the name of the AgentCapabilities

See Also:

toString()

getProductRelease

public java.lang.String getProductRelease()

Gets the PRODUCT-RELEASE of this AgentCapabilities macro.

The purpose of the PRODUCT-RELEASE clause is to describe the product release which includes the implemented capabilities.

Returns:

String - the value of the PRODUCT-RELEASE clause.

getACModules

public java.util.Vector getACModules()

Gets the acModules defined in this AgentCapabilties macro. The acModules define the implementation characteristics of the SNMP Agent.
The Vector returned by this method contains the AgentCapabilitiesModule objects.

Returns:

Vector containing the acModules.

getStatus

public java.lang.String getStatus()

Gets the STATUS value for this AgentCapabilities macro.

Returns:

String - the value of the STATUS clause.

getDescription

public java.lang.String getDescription()

Gets the DESCRIPTION value for this AgentCapabilities macro.

Returns:

String - the value of the DESCRIPTION clause.

getReference

public java.lang.String getReference()

Gets the REFERENCE value for this AgentCapabilities macro.

Returns:

the REFERENCE value, if present.
empty string, if not found.

toString

public java.lang.String toString()

Gives the name of this ObjectGroup object. Same as the getName() method

Overrides:

toString in class java.lang.Object

See Also:

getName()