java.lang.Object
org.snmp4j.fluent.TargetBuilder<A>
- Type Parameters:
A
- the address type to generate a target for.
The
TargetBuilder
class creates SNMP Target
instances using a fluent flow.- Since:
- 3.5.0
- Author:
- Frank Fock
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
class
static class
static class
class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected A
protected int
protected int
protected OctetString
protected SnmpBuilder
protected TargetBuilder.SnmpVersion
protected long
-
Constructor Summary
ConstructorsModifierConstructorDescriptionTargetBuilder(SnmpBuilder snmpBuilder)
Creates aTargetBuilder
from a givenSnmpBuilder
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 TypeMethodDescriptionSets the target's address.build()
Build the target and return it.community(OctetString snmpV1V2Community)
Return aTargetBuilder.TlsTargetBuilder
to specify special TLS target parameters.dtls(OctetString identity)
Return aTargetBuilder.TlsTargetBuilder
to specify special TLS target parameters.static <A extends Address>
TargetBuilder<A>forAddress(SnmpBuilder snmpBuilder, A address)
Creates aTargetBuilder
from a givenSnmpBuilder
which is used to discover authoritative engine ID and to get the security protocols to derive keys from passwords.void
maxSizeRequestPDU(int maxSizeRequestPDU)
pdu()
Creates aPduBuilder
based on this target builder.retries(int retries)
timeout(long timeoutMillis)
Return aTargetBuilder.TlsTargetBuilder
to specify special TLS target parameters.tls(OctetString identity)
Return aTargetBuilder.TlsTargetBuilder
to specify special TLS target parameters.user(OctetString securityName)
user(OctetString securityName, byte[] authoritativeEngineID)
Creates aTargetBuilder.DirectUserBuilder
based on this target builder for the specified security name authoritative engine ID.v1()
v2c()
v3()
-
Field Details
-
snmpBuilder
-
address
-
securityName
-
snmpVersion
-
target
-
timeoutMillis
protected long timeoutMillis -
retries
protected int retries -
maxSizeRequestPDU
protected int maxSizeRequestPDU
-
-
Constructor Details
-
TargetBuilder
Creates aTargetBuilder
from a givenSnmpBuilder
which is used to discover authoritative engine ID and to get the security protocols to derive keys from passwords.- Parameters:
snmpBuilder
- aSnmpBuilder
instance.
-
TargetBuilder
-
-
Method Details
-
forAddress
Creates aTargetBuilder
from a givenSnmpBuilder
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
- aSnmpBuilder
instance.
-
address
Sets the target's address.- Parameters:
address
- a transportAddress
instance.- Returns:
- this.
-
v1
-
v2c
-
v3
-
timeout
-
retries
-
maxSizeRequestPDU
public void maxSizeRequestPDU(int maxSizeRequestPDU) -
community
-
user
-
user
-
user
-
user
public TargetBuilder.DirectUserBuilder user(OctetString securityName, byte[] authoritativeEngineID)Creates aTargetBuilder.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.- Returns:
- a
TargetBuilder.DirectUserBuilder
to build aDirectUserTarget
.
-
tls
Return aTargetBuilder.TlsTargetBuilder
to specify special TLS target parameters.- Parameters:
identity
- the certificate identity.- Returns:
- a
TargetBuilder.TlsTargetBuilder
instance based on thisTargetBuilder
.
-
tls
Return aTargetBuilder.TlsTargetBuilder
to specify special TLS target parameters.- Parameters:
identity
- the certificate identity.- Returns:
- a
TargetBuilder.TlsTargetBuilder
instance based on thisTargetBuilder
.
-
dtls
Return aTargetBuilder.TlsTargetBuilder
to specify special TLS target parameters.- Parameters:
identity
- the certificate identity.- Returns:
- a
TargetBuilder.TlsTargetBuilder
instance based on thisTargetBuilder
.
-
dtls
Return aTargetBuilder.TlsTargetBuilder
to specify special TLS target parameters.- Parameters:
identity
- the certificate identity.- Returns:
- a
TargetBuilder.TlsTargetBuilder
instance based on thisTargetBuilder
.
-
build
Build the target and return it.- Returns:
- a new
Target
instance.
-
pdu
Creates aPduBuilder
based on this target builder.- Returns:
- a new
PduBuilder
.
-