Module org.snmp4j

Package org.snmp4j.fluent

Class TargetBuilder<A extends Address>

java.lang.Object

org.snmp4j.fluent.TargetBuilder<A>

Type Parameters:

A - the address type to generate a target for.

public class TargetBuilder<A extends Address>
extends Object

The TargetBuilder class creates SNMP Target instances using a fluent flow.

Since:

3.5.0

Author:

Frank Fock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TargetBuilder.AuthProtocol
class	TargetBuilder.DirectUserBuilder
static enum	TargetBuilder.PrivProtocol
static enum	TargetBuilder.SnmpVersion
class	TargetBuilder.TlsTargetBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected A	address
protected int	maxSizeRequestPDU
protected int	retries
protected OctetString	securityName
protected final SnmpBuilder	snmpBuilder
protected TargetBuilder.SnmpVersion	snmpVersion
protected Target<A>	target
protected long	timeoutMillis

Constructor Summary

Constructors

Modifier	Constructor	Description
	TargetBuilder(SnmpBuilder snmpBuilder)	Creates a TargetBuilder from a given SnmpBuilder which is used to discover authoritative engine ID and to get the security protocols to derive keys from passwords.
protected	TargetBuilder(SnmpBuilder snmpBuilder, A address)

Method Summary

Modifier and Type	Method	Description
TargetBuilder<A>	address(A address)	Sets the target's address.
Target<A>	build()	Build the target and return it.
TargetBuilder<A>	community(OctetString snmpV1V2Community)
TargetBuilder<A>.TlsTargetBuilder	dtls(String identity)	Return a TargetBuilder<A extends Address>.TlsTargetBuilder to specify special TLS target parameters.
TargetBuilder<A>.TlsTargetBuilder	dtls(OctetString identity)	Return a TargetBuilder<A extends Address>.TlsTargetBuilder to specify special TLS target parameters.
static <A extends Address> TargetBuilder<A>	forAddress(SnmpBuilder snmpBuilder, A address)	Creates a TargetBuilder from a given SnmpBuilder which is used to discover authoritative engine ID and to get the security protocols to derive keys from passwords.
void	maxSizeRequestPDU(int maxSizeRequestPDU)
PduBuilder	pdu()	Creates a PduBuilder based on this target builder.
TargetBuilder<A>	retries(int retries)
TargetBuilder<A>	timeout(long timeoutMillis)
TargetBuilder<A>.TlsTargetBuilder	tls(String identity)	Return a TargetBuilder<A extends Address>.TlsTargetBuilder to specify special TLS target parameters.
TargetBuilder<A>.TlsTargetBuilder	tls(OctetString identity)	Return a TargetBuilder<A extends Address>.TlsTargetBuilder to specify special TLS target parameters.
TargetBuilder<A>.DirectUserBuilder	user(String securityName)	Creates a DirectUserBuilder for the specified security name.
TargetBuilder<A>.DirectUserBuilder	user(String securityName, byte[] authoritativeEngineID)
TargetBuilder<A>.DirectUserBuilder	user(OctetString securityName)
TargetBuilder<A>.DirectUserBuilder	user(OctetString securityName, byte[] authoritativeEngineID)	Creates a TargetBuilder<A extends Address>.DirectUserBuilder based on this target builder for the specified security name authoritative engine ID.
TargetBuilder<A>	v1()
TargetBuilder<A>	v2c()
TargetBuilder<A>	v3()

Methods inherited from class java.lang.Object

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

Field Details

snmpBuilder

protected final SnmpBuilder snmpBuilder

address

protected A extends Address address

securityName

protected OctetString securityName

snmpVersion

protected TargetBuilder.SnmpVersion snmpVersion

target

protected Target<A extends Address> target

timeoutMillis

protected long timeoutMillis

retries

protected int retries

maxSizeRequestPDU

protected int maxSizeRequestPDU

Constructor Details

TargetBuilder

public TargetBuilder(SnmpBuilder snmpBuilder)

Creates a TargetBuilder from a given SnmpBuilder which is used to discover authoritative engine ID and to get the security protocols to derive keys from passwords.

Parameters:

snmpBuilder - a SnmpBuilder instance.

TargetBuilder

protected TargetBuilder(SnmpBuilder snmpBuilder,
 A address)

Method Details

forAddress

public static <A extends Address> TargetBuilder<A> forAddress(SnmpBuilder snmpBuilder,
 A address)

Creates a TargetBuilder from a given SnmpBuilder which is used to discover authoritative engine ID and to get the security protocols to derive keys from passwords. The given address specifies the target's address.

Parameters:

snmpBuilder - a SnmpBuilder instance.

address

public TargetBuilder<A> address(A address)

Sets the target's address.

Parameters:

address - a transport Address instance.

Returns:

this.

v1

public TargetBuilder<A> v1()

v2c

public TargetBuilder<A> v2c()

v3

public TargetBuilder<A> v3()

timeout

public TargetBuilder<A> timeout(long timeoutMillis)

retries

public TargetBuilder<A> retries(int retries)

maxSizeRequestPDU

public void maxSizeRequestPDU(int maxSizeRequestPDU)

community

public TargetBuilder<A> community(OctetString snmpV1V2Community)

user

public TargetBuilder<A>.DirectUserBuilder user(String securityName)

Creates a DirectUserBuilder for the specified security name. Delegates to the user(String, byte[]) method with null as the authoritative engine ID. Use this method if localization should be deferred until the first usage.

Parameters:

securityName - the security name associated with the user.

Returns:

a DirectUserBuilder instance to further configure the user.

user

public TargetBuilder<A>.DirectUserBuilder user(String securityName,
 byte[] authoritativeEngineID)

user

public TargetBuilder<A>.DirectUserBuilder user(OctetString securityName)

user

public TargetBuilder<A>.DirectUserBuilder user(OctetString securityName,
 byte[] authoritativeEngineID)

Creates a TargetBuilder<A extends Address>.DirectUserBuilder based on this target builder for the specified security name authoritative engine ID.

Parameters:

securityName - the security name associated with the user.

authoritativeEngineID - the authoritative engine ID of the target. Should be null if localization is deferred until the first usage. Must not be null if localization is not deferred (default). See TargetBuilder.DirectUserBuilder.deferLocalizationUntilFirstUsage().

Returns:

a TargetBuilder<A extends Address>.DirectUserBuilder to build a DirectUserTarget.

tls

public TargetBuilder<A>.TlsTargetBuilder tls(String identity)

Return a TargetBuilder<A extends Address>.TlsTargetBuilder to specify special TLS target parameters.

Parameters:

identity - the certificate identity.

Returns:

a TargetBuilder<A extends Address>.TlsTargetBuilder instance based on this TargetBuilder.

tls

public TargetBuilder<A>.TlsTargetBuilder tls(OctetString identity)

Return a TargetBuilder<A extends Address>.TlsTargetBuilder to specify special TLS target parameters.

Parameters:

identity - the certificate identity.

Returns:

a TargetBuilder<A extends Address>.TlsTargetBuilder instance based on this TargetBuilder.

dtls

public TargetBuilder<A>.TlsTargetBuilder dtls(String identity)

Return a TargetBuilder<A extends Address>.TlsTargetBuilder to specify special TLS target parameters.

Parameters:

identity - the certificate identity.

Returns:

a TargetBuilder<A extends Address>.TlsTargetBuilder instance based on this TargetBuilder.

dtls

public TargetBuilder<A>.TlsTargetBuilder dtls(OctetString identity)

Return a TargetBuilder<A extends Address>.TlsTargetBuilder to specify special TLS target parameters.

Parameters:

identity - the certificate identity.

Returns:

a TargetBuilder<A extends Address>.TlsTargetBuilder instance based on this TargetBuilder.

build

public Target<A> build()

Build the target and return it. This throws a IllegalStateException if the target has not yet been prepared yet, using one of the user(..), (d)tls(..), or community(..) methods.

Returns:

a new Target instance.

pdu

public PduBuilder pdu()

Creates a PduBuilder based on this target builder.

Returns:

a new PduBuilder.