com.hp.sdn.driver

Class SnmpKey

java.lang.Object

com.hp.sdn.driver.AbstractKey

com.hp.sdn.driver.SnmpKey

All Implemented Interfaces:

Distributable, Transportable<Key,String>, Key, Serializable

public class SnmpKey
extends AbstractKey

SNMP device key.

Author:

Sean Humphress

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.hp.sdn.driver.Key

Key.Type

Field Summary

Fields inherited from class com.hp.sdn.driver.AbstractKey

description

Constructor Summary

Constructors

Modifier	Constructor and Description
	SnmpKey() Empty constructor for use with importData
protected	SnmpKey(SnmpKey key)

Method Summary

Methods

Modifier and Type	Method and Description
String	exportData() Export the contents of the key into a string form.
static SnmpKey	forSnmpV1(String description, String readCommunityName, String writeCommunityName) Create a v1 SNMP key
static SnmpKey	forSnmpV2(String description, String readCommunityName, String writeCommunityName) Create a v2 SNMP key
static SnmpKey	forSnmpV3(String description, Usm.AuthorizationType authType, Usm.PrivacyType privacyType, String userName, String authPassword, String privacyPassword) Create a v3 SNMP key
boolean	importData(String data) Imports the contents of the key from an export-encoded string.
SnmpTargetArgs	targetArgs() Export key data in SNMP Client format.
String	toJson() To convert an SNMP Key to a JSON representation.

Methods inherited from class com.hp.sdn.driver.AbstractKey

create, decrypt, description, encrypt, equals, getId, hashCode, setDescription, toString, type

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SnmpKey

protected SnmpKey(SnmpKey key)

SnmpKey

public SnmpKey()

Empty constructor for use with importData

Method Detail

forSnmpV1

public static SnmpKey forSnmpV1(String description,
                String readCommunityName,
                String writeCommunityName)

Create a v1 SNMP key

Parameters:

description - key name

readCommunityName - community

writeCommunityName - community

Returns:

created key

forSnmpV2

public static SnmpKey forSnmpV2(String description,
                String readCommunityName,
                String writeCommunityName)

Create a v2 SNMP key

Parameters:

description - key name

readCommunityName - community

writeCommunityName - community

Returns:

created key

forSnmpV3

public static SnmpKey forSnmpV3(String description,
                Usm.AuthorizationType authType,
                Usm.PrivacyType privacyType,
                String userName,
                String authPassword,
                String privacyPassword)

Create a v3 SNMP key

Parameters:

description - key name

authType - authentication type

privacyType - privacy type

userName - user name

authPassword - authentication password

privacyPassword - privacy password

Returns:

created key

targetArgs

public SnmpTargetArgs targetArgs()

Export key data in SNMP Client format.

Returns:

target arguments

toJson

public String toJson()

To convert an SNMP Key to a JSON representation.

Returns:

JSON String

exportData

public String exportData()

Description copied from interface: Key

Export the contents of the key into a string form.

Returns:

string containing export suitable to be re-imported

importData

public boolean importData(String data)

Description copied from interface: Key

Imports the contents of the key from an export-encoded string.

Parameters:

data - information to rebuild key

Returns:

true is the import was successful.