org.soulwing.snmp.provider

Interface SnmpProvider

All Known Implementing Classes:

Snmp4jProvider

public interface SnmpProvider

A provider of SnmpContext objects.

Author:

Carl Harris

Method Summary

Modifier and Type	Method and Description
void	close() Notifies the recipient that the SnmpFactory has been closed.
String	getName() Gets the provider name.
void	init(SnmpFactoryConfig config) Initializes this provider instance.
SnmpContext	newContext(SnmpTarget target, SnmpTargetConfig config, Mib mib) Creates a new SNMPv2c context.
SnmpListener	newListener(String address, int port, Mib mib) Creates a new listener that will receive and distribute SNMP notifications (traps, informs).

Method Detail

getName

String getName()

Gets the provider name.

Returns:

provider name (never null)

init

void init(SnmpFactoryConfig config)

Initializes this provider instance.

This method is invoked once, after the factory has been instantiated, before the provider is called upon to create contexts or listeners.

Parameters:

config - configuration associated with the caling factory

newContext

SnmpContext newContext(SnmpTarget target,
                       SnmpTargetConfig config,
                       Mib mib)

Creates a new SNMPv2c context.

Parameters:

target - target agent

config - context configuration; the provider can safely assume that the configuration is immutable for the lifetime of the returned context

mib - MIB provider

Returns:

SNMP context

newListener

SnmpListener newListener(String address,
                         int port,
                         Mib mib)

Creates a new listener that will receive and distribute SNMP notifications (traps, informs).

Parameters:

address - address on which to listen (null to indicate ANY)

port - port on which to listen

mib - MIB provider

Returns:

listener object

close

void close()

Notifies the recipient that the SnmpFactory has been closed.

The provider should release any resources such as threads, locks, open files/sockets, etc when this method is invoked.