org.soulwing.snmp

Interface SnmpOperations

All Known Subinterfaces:

SnmpContext

public interface SnmpOperations

An API for synchronous SNMP operations.

Author:

Carl Harris

Method Summary

Methods

Modifier and Type	Method and Description
SnmpResponse<VarbindCollection>	get(List<String> oids) Performs an SNMP GET operation.
SnmpResponse<VarbindCollection>	get(String... oids) Performs an SNMP GET operation.
SnmpResponse<VarbindCollection>	get(VarbindCollection varbinds) Performs an SNMP GET operation.
SnmpResponse<List<VarbindCollection>>	getBulk(int nonRepeaters, int maxRepetitions, List<String> oids) Performs an SNMP GETBULK operation.
SnmpResponse<List<VarbindCollection>>	getBulk(int nonRepeaters, int maxRepetitions, String... oids) Performs an SNMP GETBULK operation.
SnmpResponse<List<VarbindCollection>>	getBulk(int nonRepeaters, int maxRepetitions, VarbindCollection varbinds) Performs an SNMP GETBULK operation.
SnmpResponse<VarbindCollection>	getNext(List<String> oids) Performs an SNMP GETNEXT operation.
SnmpResponse<VarbindCollection>	getNext(String... oids) Performs an SNMP GETNEXT operation.
SnmpResponse<VarbindCollection>	getNext(VarbindCollection varbinds) Performs an SNMP GETNEXT operation.
SnmpResponse<VarbindCollection>	set(List<Varbind> varbinds) Performs an SNMP SET operation.
SnmpResponse<VarbindCollection>	set(Varbind... varbinds) Performs an SNMP SET operation.
SnmpResponse<VarbindCollection>	set(VarbindCollection varbinds) Performs an SNMP GET operation.
SnmpWalker<VarbindCollection>	walk(int nonRepeaters, List<String> oids) Performs a walk of a MIB conceptual table.
SnmpWalker<VarbindCollection>	walk(int nonRepeaters, String... oids) Performs a walk of a MIB conceptual table.
SnmpWalker<VarbindCollection>	walk(List<String> repeaters) Performs a walk of a MIB conceptual table.
SnmpWalker<VarbindCollection>	walk(List<String> nonRepeaters, List<String> repeaters) Performs a walk of a MIB conceptual table.
SnmpWalker<VarbindCollection>	walk(String... repeaters) Performs a walk of a MIB conceptual table.

Method Detail

get

SnmpResponse<VarbindCollection> get(List<String> oids)

Performs an SNMP GET operation.

Parameters:

oids - MIB names or dotted-decimal object identifiers for the objects to fetch

Returns:

a response containing the retrieved varbinds in the same order and with the same keys as the requested objects

get

SnmpResponse<VarbindCollection> get(VarbindCollection varbinds)

Performs an SNMP GET operation.

Parameters:

varbinds - a collection identifying the objects to fetch

Returns:

a response containing the retrieved varbinds in the same order and with the same keys as the requested objects

set

SnmpResponse<VarbindCollection> set(Varbind... varbinds)

Performs an SNMP SET operation.

Parameters:

varbinds - variable bindings to set

Returns:

a response containing the resulting varbinds in the same order and with the same keys as the requested varbinds

set

SnmpResponse<VarbindCollection> set(List<Varbind> varbinds)

Performs an SNMP SET operation.

Parameters:

varbinds - variable bindings to set

Returns:

a response containing the resulting varbinds in the same order and with the same keys as the requested varbinds

set

SnmpResponse<VarbindCollection> set(VarbindCollection varbinds)

Performs an SNMP GET operation.

Parameters:

varbinds - a collection identifying the objects to set

Returns:

a response containing the resulting varbinds in the same order and with the same keys as the requested varbinds

get

SnmpResponse<VarbindCollection> get(String... oids)

Performs an SNMP GET operation.

Parameters:

oids - MIB names or dotted-decimal object identifiers for the objects to fetch

Returns:

a response containing the retrieved varbinds in the same order and with the same keys as the requested objects

getNext

SnmpResponse<VarbindCollection> getNext(List<String> oids)

Performs an SNMP GETNEXT operation.

Parameters:

oids - MIB names or dotted-decimal object identifiers for the objects to fetch

Returns:

a response containing the retrieved varbinds in the same order and with the same keys as the requested objects

getNext

SnmpResponse<VarbindCollection> getNext(VarbindCollection varbinds)

Performs an SNMP GETNEXT operation.

Parameters:

varbinds - a collection identifying the objects to fetch

Returns:

a response containing the retrieved varbinds in the same order and with the same keys as the requested objects

getNext

SnmpResponse<VarbindCollection> getNext(String... oids)

Performs an SNMP GETNEXT operation.

Parameters:

oids - MIB names or dotted-decimal object identifiers for the objects to fetch

Returns:

a response containing the retrieved varbinds in the same order and with the same keys as the requested objects

getBulk

SnmpResponse<List<VarbindCollection>> getBulk(int nonRepeaters,
                                            int maxRepetitions,
                                            List<String> oids)

Performs an SNMP GETBULK operation.

Parameters:

nonRepeaters - number of non-repeating objects at the beginning of oids.

maxRepetitions - maximum number of repetitions to retrieve for the repeating objects in oids

oids - MIB names or dotted-decimal object identifiers for the objects to fetch; the first nonRepeaters identifiers in the list are assumed to be non-repeating objects

Returns:

a response containing a list of varbind collections; the list size is maxRepetitions.

getBulk

SnmpResponse<List<VarbindCollection>> getBulk(int nonRepeaters,
                                            int maxRepetitions,
                                            VarbindCollection varbinds)

Performs an SNMP GETBULK operation.

Parameters:

nonRepeaters - number of non-repeating objects at the beginning of varbinds.

maxRepetitions - maximum number of repetitions to retrieve for the repeating objects in varbinds

varbinds - a collection identifying the objects to fetch

Returns:

a response containing a list of varbind collections; the list size is maxRepetitions.

getBulk

SnmpResponse<List<VarbindCollection>> getBulk(int nonRepeaters,
                                            int maxRepetitions,
                                            String... oids)

Performs an SNMP GETBULK operation.

Parameters:

nonRepeaters - number of non-repeating objects at the beginning of oids.

maxRepetitions - maximum number of repetitions to retrieve for the repeating objects in oids

oids - MIB names or dotted-decimal object identifiers for the objects to fetch; the first nonRepeaters identifiers in the list are assumed to be for non-repeating objects

Returns:

a response containing a list of varbind collections; the list size is maxRepetitions.

walk

SnmpWalker<VarbindCollection> walk(int nonRepeaters,
                                 List<String> oids)

Performs a walk of a MIB conceptual table.

This is a high level operation that can be used to retrieve all rows of a conceptual table.

Parameters:

nonRepeaters - number of non-repeating objects at the beginning of oids

oids - MIB names or dotted-decimal object identifiers; the first nonRepeaters identifiers in the list are assumed to be for non-repeating objects

Returns:

a response containing the retrieved varbinds in the same order and with the same keys as the requested objects

walk

SnmpWalker<VarbindCollection> walk(int nonRepeaters,
                                 String... oids)

Performs a walk of a MIB conceptual table.

This is a high level operation that can be used to retrieve all rows of a conceptual table.

Parameters:

nonRepeaters - number of non-repeating objects at the beginning of oids

oids - MIB names or dotted-decimal object identifiers; the first nonRepeaters identifiers in the list are assumed to be for non-repeating objects

Returns:

table row walker

walk

SnmpWalker<VarbindCollection> walk(List<String> nonRepeaters,
                                 List<String> repeaters)

Performs a walk of a MIB conceptual table.

This is a high level operation that can be used to retrieve all rows of a conceptual table.

Parameters:

nonRepeaters - MIB names or dotted-decimal object identifiers for the non-repeating elements to retrieve

repeaters - MIB names or dotted-decimal object identifiers for the table column elements to retrieve

Returns:

table row walker

walk

SnmpWalker<VarbindCollection> walk(List<String> repeaters)

Performs a walk of a MIB conceptual table.

This is a high level operation that can be used to retrieve all rows of a conceptual table.

Parameters:

repeaters - MIB names or dotted-decimal object identifiers for the table column elements to retrieve

Returns:

table row walker

walk

SnmpWalker<VarbindCollection> walk(String... repeaters)

Performs a walk of a MIB conceptual table.

This is a high level operation that can be used to retrieve all rows of a conceptual table.

Parameters:

repeaters - MIB names or dotted-decimal object identifiers for the table column elements to retrieve

Returns:

table row walker