org.soulwing.snmp

Class SnmpFactory

java.lang.Object

org.soulwing.snmp.SnmpFactory

public class SnmpFactory
extends Object

A factory that produces contexts and listeners for SNMP.

Author:

Carl Harris

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this factory, releasing any resources it might be holding.
SimpleSnmpTargetConfig	getDefaultTargetConfig() Gets the default configuration that will be used for new context instances created by this factory.
ExecutorService	getExecutorService() Gets the executor service that should be used for short-lived tasks.
SnmpFactoryConfig	getFactoryConfig() Gets the factory configuration associated with this instance.
static SnmpFactory	getInstance() Gets the singleton factory instance.
static SnmpFactory	getInstance(SnmpFactoryConfig config, ThreadFactory threadFactory) Gets the singleton factory instance.
static SnmpFactory	getInstance(ThreadFactory threadFactory) Gets the singleton factory instance.
ScheduledExecutorService	getScheduledExecutorService() Gets the executor service that should be used for scheduled tasks.
ThreadFactory	getThreadFactory() Gets the thread factory that should be used to create threads for long running tasks.
SnmpContext	newContext(SnmpTarget target) Gets a new SNMPv2c context using the first available provider, default MIB, and the factory's default configuration.
SnmpContext	newContext(SnmpTarget target, Mib mib) Gets a new SNMPv2c context using the first available provider and the factory's default configuration.
SnmpContext	newContext(SnmpTarget target, Mib mib, SnmpTargetConfig config, String providerName) Gets a new SNMPv2c context using the named provider.
SnmpContext	newContext(SnmpTarget target, SnmpTargetConfig config) Gets a new SNMPv2c context using the first available provider.
SnmpListener	newListener(int port, Mib mib) Creates a new listener that listens on any local address using the first available provider.
SnmpListener	newListener(Mib mib) Creates a new listener that listens on the default notification port with any local address, using the first available provider.
SnmpListener	newListener(String address, int port, Mib mib) Creates a new listener using the first available provider.
SnmpListener	newListener(String address, int port, Mib mib, String providerName) Creates a new listener using the named provider.
void	setDefaultTargetConfig(SimpleSnmpTargetConfig config) Sets the default configuration that will be used for new context instances created by this factory.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SnmpFactory getInstance()

Gets the singleton factory instance.

Returns:

factory object

getInstance

public static SnmpFactory getInstance(ThreadFactory threadFactory)

Gets the singleton factory instance.

Parameters:

threadFactory - thread factory that will be used to create threads as needed for components produced by this factory

Returns:

factory object

getInstance

public static SnmpFactory getInstance(SnmpFactoryConfig config,
                      ThreadFactory threadFactory)

Gets the singleton factory instance.

Parameters:

config - factory configuration

threadFactory - thread factory that will be used to create threads as needed for components produced by this factory

Returns:

factory object

getExecutorService

public ExecutorService getExecutorService()

Gets the executor service that should be used for short-lived tasks.

Returns:

executor service

getScheduledExecutorService

public ScheduledExecutorService getScheduledExecutorService()

Gets the executor service that should be used for scheduled tasks.

Returns:

executor service

getThreadFactory

public ThreadFactory getThreadFactory()

Gets the thread factory that should be used to create threads for long running tasks.

Returns:

thread factory

getFactoryConfig

public SnmpFactoryConfig getFactoryConfig()

Gets the factory configuration associated with this instance.

Returns:

factory config

close

public void close()
           throws InterruptedException

Closes this factory, releasing any resources it might be holding.

Throws:

InterruptedException

getDefaultTargetConfig

public SimpleSnmpTargetConfig getDefaultTargetConfig()

Gets the default configuration that will be used for new context instances created by this factory.

Returns:

configuration

setDefaultTargetConfig

public void setDefaultTargetConfig(SimpleSnmpTargetConfig config)

Sets the default configuration that will be used for new context instances created by this factory.

Parameters:

config - the value to set

newContext

public SnmpContext newContext(SnmpTarget target)

Gets a new SNMPv2c context using the first available provider, default MIB, and the factory's default configuration.

Parameters:

target - target agent

Returns:

SNMP context object

newContext

public SnmpContext newContext(SnmpTarget target,
                     Mib mib)

Gets a new SNMPv2c context using the first available provider and the factory's default configuration.

Parameters:

target - target agent

mib - MIB that will be passed into the context

Returns:

SNMP context object

newContext

public SnmpContext newContext(SnmpTarget target,
                     SnmpTargetConfig config)

Gets a new SNMPv2c context using the first available provider.

Parameters:

target - target agent

config - SNMP configuration for the context

Returns:

SNMP context object

newContext

public SnmpContext newContext(SnmpTarget target,
                     Mib mib,
                     SnmpTargetConfig config,
                     String providerName)

Gets a new SNMPv2c context using the named provider.

Parameters:

target - target agent

mib - MIB that will be passed into the context

config - SNMP configuration for the context

providerName - name of the desired provider

Returns:

SNMP context object

Throws:

ProviderNotFoundException - if the named provider cannot be found on the class path

newListener

public SnmpListener newListener(Mib mib)

Creates a new listener that listens on the default notification port with any local address, using the first available provider.

Parameters:

mib - MIB that will be passed into the listener

Returns:

SNMP notification listener

newListener

public SnmpListener newListener(int port,
                       Mib mib)

Creates a new listener that listens on any local address using the first available provider.

Parameters:

port - port on which to listen

mib - MIB that will be passed into the listener

Returns:

SNMP notification listener

newListener

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

Creates a new listener using the first available provider.

Parameters:

address - local address on which to listen or null to bind to any local address

port - port on which to listen

mib - MIB that will be passed into the listener

Returns:

SNMP notification listener

newListener

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

Creates a new listener using the named provider.

Parameters:

address - local address on which to listen or null to bind to any local address

port - port on which to listen

mib - MIB that will be passed into the listener

providerName - name of the desired provider or null to use first available provider

Returns:

SNMP notification listener