com.hp.sdn.dvc.facet

Class SnmpDriver

java.lang.Object

com.hp.sdn.dvc.facet.SnmpDriver

public class SnmpDriver
extends Object

Overlay of the DefaultSnmpClient to add key discovery and usage from CredetialService. Key discovery occurs when the device is discovered, any other facet than DeviceIdentity can use the pre-discovered key.

Author:

Sean Humphress

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnmpDriver.Match

Field Summary

Fields

Modifier and Type	Field and Description
SnmpRequestListener	defaultListener Default listener will save the response and status
protected SnmpRequest	response
protected boolean	success

Constructor Summary

Constructors

Constructor and Description
SnmpDriver() Default constructor
SnmpDriver(int waitTimeout) Constructor to override default listener timeout.

Method Summary

Methods

Modifier and Type	Method and Description
SnmpRequest	createGet(IpAddress ip, SnmpRequestListener listener)
SnmpRequest	createRequest(IpAddress ip, SnmpRequestListener listener)
SnmpRequest	createSet(IpAddress ip, SnmpRequestListener listener)
SnmpRequest	createWalk(IpAddress ip, SnmpRequestListener listener)
SnmpRequest	createWalkByVersion(IpAddress ip, SnmpRequestListener listener)
SnmpDriver.Match	discoverCredentials(IpAddress ip, KeyService cs, String description) Discover the key that best matches the device.
void	execute(SnmpRequest request) Execute the SNMP request.
boolean	executeAndWait(SnmpRequest request, SnmpRequestListener listener) Execute the SNMP request and wait for the response.
SnmpResponse	getResponse()
SnmpWalkTable	getWalkTable()
SnmpKey	key() Get the credential UUID that was found to match the device.
void	setKey(SnmpKey key) Set the SNMP key information for future communication.
void	stopClient() SNMP client must be explicitly stopped to free resources.
boolean	success()
SnmpDriver.Match	testKey(IpAddress ip) Test the key for match.
protected void	waitOnListener(SnmpRequestListener listener) Wait for the listener to receive the response

Methods inherited from class java.lang.Object

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

Field Detail

response

protected SnmpRequest response

success

protected boolean success

defaultListener

public SnmpRequestListener defaultListener

Default listener will save the response and status

Constructor Detail

SnmpDriver

public SnmpDriver(int waitTimeout)

Constructor to override default listener timeout.

Parameters:

waitTimeout - timeout for default listener

SnmpDriver

public SnmpDriver()

Default constructor

Method Detail

discoverCredentials

public SnmpDriver.Match discoverCredentials(IpAddress ip,
                                   KeyService cs,
                                   String description)

Discover the key that best matches the device. If a key description is provided, use that key only.

Parameters:

ip - address of the device

cs - pointer to access the keys

description - optional key name

Returns:

true if matching key found

testKey

public SnmpDriver.Match testKey(IpAddress ip)

Test the key for match. Read a well known oid and write the value back. Will return PARTIAL if read worked but write failed.

Parameters:

ip - device address

Returns:

Match state

setKey

public void setKey(SnmpKey key)

Set the SNMP key information for future communication.

Parameters:

key - container of configuration and credentials

key

public SnmpKey key()

Get the credential UUID that was found to match the device.

Returns:

key that matched

execute

public void execute(SnmpRequest request)
             throws SocketException

Execute the SNMP request.

Parameters:

request - contains target, operation type, and pdus

Throws:

SocketException - error getting the socket to send

executeAndWait

public boolean executeAndWait(SnmpRequest request,
                     SnmpRequestListener listener)

Execute the SNMP request and wait for the response.

Parameters:

request - to send

listener - to handle response

Returns:

true if listener was successful

stopClient

public void stopClient()

SNMP client must be explicitly stopped to free resources. Automatically called from executeAndWait, users of execute() must call after request response is received.

createWalkByVersion

public SnmpRequest createWalkByVersion(IpAddress ip,
                              SnmpRequestListener listener)

createWalk

public SnmpRequest createWalk(IpAddress ip,
                     SnmpRequestListener listener)

createSet

public SnmpRequest createSet(IpAddress ip,
                    SnmpRequestListener listener)

createGet

public SnmpRequest createGet(IpAddress ip,
                    SnmpRequestListener listener)

createRequest

public SnmpRequest createRequest(IpAddress ip,
                        SnmpRequestListener listener)

waitOnListener

protected void waitOnListener(SnmpRequestListener listener)

Wait for the listener to receive the response

Parameters:

listener - to wait

getResponse

public SnmpResponse getResponse()

getWalkTable

public SnmpWalkTable getWalkTable()

success

public boolean success()