Class TargetBuilder.DirectUserBuilder

java.lang.Object

org.snmp4j.fluent.TargetBuilder.DirectUserBuilder

Enclosing class:

TargetBuilder<A extends Address>

public class TargetBuilder.DirectUserBuilder
extends Object

Since:

3.5.0

Author:

Frank Fock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DirectUserBuilder(OctetString securityName)
protected	DirectUserBuilder(OctetString securityName, byte[] authoritativeEngineID)

Method Summary

Modifier and Type	Method	Description
TargetBuilder<A>.DirectUserBuilder	auth(TargetBuilder.AuthProtocol authenticationProtocol)
TargetBuilder<A>.DirectUserBuilder	authPassphrase(String authPassword)
TargetBuilder<A>.DirectUserBuilder	authPassphrase(OctetString authPassword)
TargetBuilder<A>.DirectUserBuilder	deferLocalizationUntilFirstUsage()	This will set the deferLocalizationUntilFirstUsage to true.
TargetBuilder<A>	done()	Finalizes the configuration of the DirectUserTarget and returns the enclosing TargetBuilder instance.
TargetBuilder<A>.DirectUserBuilder	priv(TargetBuilder.PrivProtocol privacyProtocol)
TargetBuilder<A>.DirectUserBuilder	privPassphrase(String privPassword)
TargetBuilder<A>.DirectUserBuilder	privPassphrase(OctetString privPassword)

Methods inherited from class Object

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

Constructor Details

DirectUserBuilder

protected DirectUserBuilder(OctetString securityName)

DirectUserBuilder

protected DirectUserBuilder(OctetString securityName,
 byte[] authoritativeEngineID)

Method Details

deferLocalizationUntilFirstUsage

public TargetBuilder<A>.DirectUserBuilder deferLocalizationUntilFirstUsage()

This will set the deferLocalizationUntilFirstUsage to true. The target's authoritative engine ID will be resolved while Snmp.sendMessage(PDU, Target, TransportMapping, PduHandleCallback) is being executed then. Thus, the computing-intensive localization of the provided passphrases to localized keys will be done while sending the message, not when the target is created. This might need adjustment to the TargetBuilder.timeout(long) and TargetBuilder.retries(int) values. If set to false (which is the default), then the target's authoritative engine ID will be resolved when done() is being executed.

Returns:

this.

Since:

3.9.3

auth

public TargetBuilder<A>.DirectUserBuilder auth(TargetBuilder.AuthProtocol authenticationProtocol)

priv

public TargetBuilder<A>.DirectUserBuilder priv(TargetBuilder.PrivProtocol privacyProtocol)

authPassphrase

public TargetBuilder<A>.DirectUserBuilder authPassphrase(String authPassword)

authPassphrase

public TargetBuilder<A>.DirectUserBuilder authPassphrase(OctetString authPassword)

privPassphrase

public TargetBuilder<A>.DirectUserBuilder privPassphrase(String privPassword)

privPassphrase

public TargetBuilder<A>.DirectUserBuilder privPassphrase(OctetString privPassword)

done

public TargetBuilder<A> done()

Finalizes the configuration of the DirectUserTarget and returns the enclosing TargetBuilder instance. This method processes the necessary information, such as security protocols, passwords, and engine IDs, to construct a DirectUserTarget with appropriate security attributes. If the authoritative engine ID is not provided explicitly and localization is not deferred until the first usage, it attempts to discover the engine ID. The method also handles generating authentication and privacy keys if required.

Returns:

The enclosing TargetBuilder instance, allowing actually building the target with TargetBuilder.build().