org.friendlysnmp

Class FriendlyAgent

java.lang.Object

org.friendlysnmp.FriendlyAgent

public class FriendlyAgent
extends java.lang.Object

This agent class is used in Java application to enable SNMP. The code in the application to create the SNMP agent is the following:

 FriendlyAgent agentSNMP = new FriendlyAgent(TITLE, VERSION, prop);
 // Optional UncaughtExceptionListener
 agentSNMP.addUncaughtExceptionListener(new UncaughtExceptionListener() {
     public void uncaughtException(Thread t, Throwable e) {
         [process uncaught exception]
     }
 });
 agentSNMP.initAgent();
 agentSNMP.start();

There is no need to shutdown or close the SNMP agent. It catches JVM shutdown event and closes SNMP connections and agent threads.

Constructor Summary

Constructors

Constructor and Description
FriendlyAgent(java.lang.String title, java.lang.String version, java.util.Properties prop) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addFExceptionListener(FExceptionListener l) Adds FExceptionListener
void	addMIB(BaseMib mib) Method to add user defined MIB to the agent.
void	addShutdownListener(ShutdownListener l) Adds ShutdownListener
void	addTarget(TargetBase target) Adds targets TargetBase to the agent.
void	addUncaughtExceptionListener(UncaughtExceptionListener l) Adds UncaughtExceptionListener
FNode	getNode(org.snmp4j.smi.OID oid) Returns node registered in one of agent's mib
FNotification	getNotification(org.snmp4j.smi.OID oid) Returns notification registered in one of agent's mib.
PersistStorage	getPersistStorage() Returns persistence storage.
FScalar	getScalar(org.snmp4j.smi.OID oid) Returns scalar registered in one of agent's mib
FTable	getTable(org.snmp4j.smi.OID oid) Returns table registered in one of agent's mib
void	init() Initializes SNMP agent.
boolean	isRunning() Returns state of the SNMP agent.
static java.util.Properties	loadProps(java.lang.Class<?> clazz, java.lang.String filename) Helper method to load properties file.
void	removeFExceptionListener(FExceptionListener l) Removes FExceptionListener
void	removeShutdownListener(ShutdownListener l) Removes ShutdownListener
void	removeUncaughtExceptionListener(UncaughtExceptionListener l) Removes UncaughtExceptionListener
void	reportException(java.lang.String comment, java.lang.Throwable e) Use this method to report caught exception to MIB browser via SNMP.
void	setPersistStorage(PersistStorage persistStorage) Sets persistence storage.
void	shutdown() Shutdowns SNMP agent.
void	start() Starts SNMP agent.
void	stop() Stops SNMP agent.

Methods inherited from class java.lang.Object

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

Constructor Detail

FriendlyAgent

public FriendlyAgent(java.lang.String title,
                     java.lang.String version,
                     java.util.Properties prop)
              throws FException

Constructor.

Parameters:

title - application title.

version - application version.

prop - properties to initialize agent and with other. application information.

Throws:

FException - failure to create agent.

Method Detail

addUncaughtExceptionListener

public void addUncaughtExceptionListener(UncaughtExceptionListener l)

Adds UncaughtExceptionListener

Parameters:

l - UncaughtExceptionListener object

removeUncaughtExceptionListener

public void removeUncaughtExceptionListener(UncaughtExceptionListener l)

Removes UncaughtExceptionListener

Parameters:

l - UncaughtExceptionListener object

addFExceptionListener

public void addFExceptionListener(FExceptionListener l)

Adds FExceptionListener

Parameters:

l - FExceptionListener object

removeFExceptionListener

public void removeFExceptionListener(FExceptionListener l)

Removes FExceptionListener

Parameters:

l - FExceptionListener object

addShutdownListener

public void addShutdownListener(ShutdownListener l)

Adds ShutdownListener

Parameters:

l - ShutdownListener object

removeShutdownListener

public void removeShutdownListener(ShutdownListener l)

Removes ShutdownListener

Parameters:

l - ShutdownListener object

addMIB

public void addMIB(BaseMib mib)
            throws FException

Method to add user defined MIB to the agent. Call this method multiple times for each additional MIB. This method must be called before agent starts.

Parameters:

mib - MIB object.

Throws:

FException - failure to add MIB.

addTarget

public void addTarget(TargetBase target)
               throws FException

Adds targets TargetBase to the agent.

Usually targets are added via properties file, see FConstant.KEY_V1_COMMUNITY, FConstant.KEY_V2_COMMUNITY and FConstant.KEY_V3_USER, Alternative technique is to derive class from TargetBase class, implement required functionality and add target with this method.

Parameters:

target - target object.

Throws:

FException - failure to add target.

init

public void init()
          throws FException

Initializes SNMP agent. This is a complex procedure (in comparison to simple start())

Throws:

FException - wrapper exception with a cause exception which may be IOException while loading persistence or properties problem, DuplicateRegistrationException while loading managed objects, BindException if address is already in use, FException for loading initial values and initialization.

start

public void start()
           throws FException

Starts SNMP agent.

Throws:

FException - failure to start agent.

stop

public void stop()
          throws FException

Stops SNMP agent.

Throws:

FException - failure to stop agent.

isRunning

public boolean isRunning()

Returns state of the SNMP agent.

Returns:

boolean flag: agent is in running state

shutdown

public void shutdown()

Shutdowns SNMP agent.

getNode

public FNode getNode(org.snmp4j.smi.OID oid)

Returns node registered in one of agent's mib

Parameters:

oid - node OID

Returns:

node or null if not found

getScalar

public FScalar getScalar(org.snmp4j.smi.OID oid)

Returns scalar registered in one of agent's mib

Parameters:

oid - node OID

Returns:

node or null if not found

getTable

public FTable getTable(org.snmp4j.smi.OID oid)

Returns table registered in one of agent's mib

Parameters:

oid - node OID

Returns:

node or null if not found

getNotification

public FNotification getNotification(org.snmp4j.smi.OID oid)

Returns notification registered in one of agent's mib.

Parameters:

oid - node OID.

Returns:

node or null if not found.

setPersistStorage

public void setPersistStorage(PersistStorage persistStorage)
                       throws FException

Sets persistence storage.

Parameters:

persistStorage - persistence storage.

Throws:

FException - failure to set persistence storage.

getPersistStorage

public PersistStorage getPersistStorage()

Returns persistence storage.

Returns:

persistence storage.

reportException

public void reportException(java.lang.String comment,
                            java.lang.Throwable e)

Use this method to report caught exception to MIB browser via SNMP.

Parameters:

comment - error message (empty or null)

e - exception

loadProps

public static java.util.Properties loadProps(java.lang.Class<?> clazz,
                                             java.lang.String filename)
                                      throws java.io.IOException

Helper method to load properties file.

Parameters:

clazz - use this class classloader to load properties.

filename - properties file name.

Returns:

properties object.

Throws:

java.io.IOException - failure to load properties file.