org.snmp4j.util
Class SnmpConfigurator

java.lang.Object
  extended by org.snmp4j.util.SnmpConfigurator

public class SnmpConfigurator
extends java.lang.Object

The SnmpConfigurator class configures a Snmp instance with settings taken from a Map conforming to the format returned by ArgumentParser.parse(String[] args). In addition, a SnmpConfigurator.InnerPDUFactory and Target can be created using settings from a Map too.

Since:
1.10
Version:
1.10
Author:
Frank Fock

Nested Class Summary
 class SnmpConfigurator.InnerPDUFactory
           
 
Field Summary
static java.lang.String F_ADDRESS
           
static java.lang.String F_AUTH_PASSPHRASE
           
static java.lang.String F_AUTH_PROTOCOL
           
static java.lang.String F_AUTHORITATIVE_ENGINE_ID
           
static java.lang.String F_BOOT_COUNTER
           
static java.lang.String F_COMMUNITY
           
static java.lang.String F_CONTEXT_ENGINE_ID
           
static java.lang.String F_CONTEXT_NAME
           
static java.lang.String F_LOCAL_ENGINE_ID
           
static java.lang.String F_MAX_REPETITIONS
           
static java.lang.String F_NON_REPEATERS
           
static java.lang.String F_OPERATION
           
static java.lang.String F_PRIV_PASSPHRASE
           
static java.lang.String F_PRIV_PROTOCOL
           
static java.lang.String F_RETRIES
           
static java.lang.String F_SEC_LEVEL
           
static java.lang.String F_SECURITY_NAME
           
static java.lang.String F_TIMEOUT
           
static java.lang.String F_TRAP_OID
           
static java.lang.String F_TRAP_UPTIME
           
static java.lang.String F_TRAPV1_AGENT_ADDR
           
static java.lang.String F_TRAPV1_ENTERPRISE
           
static java.lang.String F_TRAPV1_GENERIC_ID
           
static java.lang.String F_TRAPV1_SPECIFIC_ID
           
static java.lang.String F_VERSION
           
static java.lang.String O_ADDRESS
           
static java.lang.String O_AUTH_PASSPHRASE
           
static java.lang.String O_AUTH_PROTOCOL
           
static java.lang.String O_AUTHORITATIVE_ENGINE_ID
           
static java.lang.String O_BOOT_COUNTER
           
static java.lang.String O_COMMUNITY
           
static java.lang.String O_CONTEXT_ENGINE_ID
           
static java.lang.String O_CONTEXT_NAME
           
static java.lang.String O_LOCAL_ENGINE_ID
           
static java.lang.String O_MAX_REPETITIONS
           
static java.lang.String O_NON_REPEATERS
           
static java.lang.String O_OPERATION
           
static java.lang.String O_PRIV_PASSPHRASE
           
static java.lang.String O_PRIV_PROTOCOL
           
static java.lang.String O_RETRIES
           
static java.lang.String O_SEC_LEVEL
           
static java.lang.String O_SECURITY_NAME
           
static java.lang.String O_TIMEOUT
           
static java.lang.String O_TRAP_OID
           
static java.lang.String O_TRAP_UPTIME
           
static java.lang.String O_TRAPV1_AGENT_ADDR
           
static java.lang.String O_TRAPV1_ENTERPRISE
           
static java.lang.String O_TRAPV1_GENERIC_ID
           
static java.lang.String O_TRAPV1_SPECIFIC_ID
           
static java.lang.String O_VERSION
           
static java.lang.String P_ADDRESS
           
static java.lang.String P_AUTH_PASSPHRASE
           
static java.lang.String P_AUTH_PROTOCOL
           
static java.lang.String P_AUTHORITATIVE_ENGINE_ID
           
static java.lang.String P_BOOT_COUNTER
           
static java.lang.String P_COMMUNITY
           
static java.lang.String P_CONTEXT_ENGINE_ID
           
static java.lang.String P_CONTEXT_NAME
           
static java.lang.String P_LOCAL_ENGINE_ID
           
static java.lang.String P_MAX_REPETITIONS
           
static java.lang.String P_NON_REPEATERS
           
static java.lang.String P_OPERATION
           
static java.lang.String P_PRIV_PASSPHRASE
           
static java.lang.String P_PRIV_PROTOCOL
           
static java.lang.String P_RETRIES
           
static java.lang.String P_SEC_LEVEL
           
static java.lang.String P_SECURITY_NAME
           
static java.lang.String P_TIMEOUT
           
static java.lang.String P_TRAP_OID
           
static java.lang.String P_TRAP_UPTIME
           
static java.lang.String P_TRAPV1_AGENT_ADDR
           
static java.lang.String P_TRAPV1_ENTERPRISE
           
static java.lang.String P_TRAPV1_GENERIC_ID
           
static java.lang.String P_TRAPV1_SPECIFIC_ID
           
static java.lang.String P_VERSION
           
 
Constructor Summary
SnmpConfigurator()
           
SnmpConfigurator(java.util.Properties props)
           
 
Method Summary
 void configure(Snmp snmp, java.util.Map settings)
           
static OctetString createOctetString(java.lang.String s, java.lang.String defaultString)
          Create an OctetString from a String value.
 PDUFactory getPDUFactory(java.util.Map settings)
           
 Target getTarget(java.util.Map settings)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

O_VERSION

public static final java.lang.String O_VERSION
See Also:
Constant Field Values

P_VERSION

public static final java.lang.String P_VERSION
See Also:
Constant Field Values

F_VERSION

public static final java.lang.String F_VERSION
See Also:
Constant Field Values

O_LOCAL_ENGINE_ID

public static final java.lang.String O_LOCAL_ENGINE_ID
See Also:
Constant Field Values

P_LOCAL_ENGINE_ID

public static final java.lang.String P_LOCAL_ENGINE_ID
See Also:
Constant Field Values

F_LOCAL_ENGINE_ID

public static final java.lang.String F_LOCAL_ENGINE_ID
See Also:
Constant Field Values

O_AUTHORITATIVE_ENGINE_ID

public static final java.lang.String O_AUTHORITATIVE_ENGINE_ID
See Also:
Constant Field Values

P_AUTHORITATIVE_ENGINE_ID

public static final java.lang.String P_AUTHORITATIVE_ENGINE_ID
See Also:
Constant Field Values

F_AUTHORITATIVE_ENGINE_ID

public static final java.lang.String F_AUTHORITATIVE_ENGINE_ID
See Also:
Constant Field Values

O_COMMUNITY

public static final java.lang.String O_COMMUNITY
See Also:
Constant Field Values

P_COMMUNITY

public static final java.lang.String P_COMMUNITY
See Also:
Constant Field Values

F_COMMUNITY

public static final java.lang.String F_COMMUNITY
See Also:
Constant Field Values

O_CONTEXT_NAME

public static final java.lang.String O_CONTEXT_NAME
See Also:
Constant Field Values

P_CONTEXT_NAME

public static final java.lang.String P_CONTEXT_NAME
See Also:
Constant Field Values

F_CONTEXT_NAME

public static final java.lang.String F_CONTEXT_NAME
See Also:
Constant Field Values

O_CONTEXT_ENGINE_ID

public static final java.lang.String O_CONTEXT_ENGINE_ID
See Also:
Constant Field Values

P_CONTEXT_ENGINE_ID

public static final java.lang.String P_CONTEXT_ENGINE_ID
See Also:
Constant Field Values

F_CONTEXT_ENGINE_ID

public static final java.lang.String F_CONTEXT_ENGINE_ID
See Also:
Constant Field Values

O_SECURITY_NAME

public static final java.lang.String O_SECURITY_NAME
See Also:
Constant Field Values

P_SECURITY_NAME

public static final java.lang.String P_SECURITY_NAME
See Also:
Constant Field Values

F_SECURITY_NAME

public static final java.lang.String F_SECURITY_NAME
See Also:
Constant Field Values

O_RETRIES

public static final java.lang.String O_RETRIES
See Also:
Constant Field Values

P_RETRIES

public static final java.lang.String P_RETRIES
See Also:
Constant Field Values

F_RETRIES

public static final java.lang.String F_RETRIES
See Also:
Constant Field Values

O_TIMEOUT

public static final java.lang.String O_TIMEOUT
See Also:
Constant Field Values

P_TIMEOUT

public static final java.lang.String P_TIMEOUT
See Also:
Constant Field Values

F_TIMEOUT

public static final java.lang.String F_TIMEOUT
See Also:
Constant Field Values

O_ADDRESS

public static final java.lang.String O_ADDRESS
See Also:
Constant Field Values

P_ADDRESS

public static final java.lang.String P_ADDRESS
See Also:
Constant Field Values

F_ADDRESS

public static final java.lang.String F_ADDRESS
See Also:
Constant Field Values

O_AUTH_PASSPHRASE

public static final java.lang.String O_AUTH_PASSPHRASE
See Also:
Constant Field Values

P_AUTH_PASSPHRASE

public static final java.lang.String P_AUTH_PASSPHRASE
See Also:
Constant Field Values

F_AUTH_PASSPHRASE

public static final java.lang.String F_AUTH_PASSPHRASE
See Also:
Constant Field Values

O_PRIV_PASSPHRASE

public static final java.lang.String O_PRIV_PASSPHRASE
See Also:
Constant Field Values

P_PRIV_PASSPHRASE

public static final java.lang.String P_PRIV_PASSPHRASE
See Also:
Constant Field Values

F_PRIV_PASSPHRASE

public static final java.lang.String F_PRIV_PASSPHRASE
See Also:
Constant Field Values

O_AUTH_PROTOCOL

public static final java.lang.String O_AUTH_PROTOCOL
See Also:
Constant Field Values

P_AUTH_PROTOCOL

public static final java.lang.String P_AUTH_PROTOCOL
See Also:
Constant Field Values

F_AUTH_PROTOCOL

public static final java.lang.String F_AUTH_PROTOCOL
See Also:
Constant Field Values

O_PRIV_PROTOCOL

public static final java.lang.String O_PRIV_PROTOCOL
See Also:
Constant Field Values

P_PRIV_PROTOCOL

public static final java.lang.String P_PRIV_PROTOCOL
See Also:
Constant Field Values

F_PRIV_PROTOCOL

public static final java.lang.String F_PRIV_PROTOCOL
See Also:
Constant Field Values

O_OPERATION

public static final java.lang.String O_OPERATION
See Also:
Constant Field Values

P_OPERATION

public static final java.lang.String P_OPERATION
See Also:
Constant Field Values

F_OPERATION

public static final java.lang.String F_OPERATION
See Also:
Constant Field Values

O_MAX_REPETITIONS

public static final java.lang.String O_MAX_REPETITIONS
See Also:
Constant Field Values

P_MAX_REPETITIONS

public static final java.lang.String P_MAX_REPETITIONS
See Also:
Constant Field Values

F_MAX_REPETITIONS

public static final java.lang.String F_MAX_REPETITIONS
See Also:
Constant Field Values

O_NON_REPEATERS

public static final java.lang.String O_NON_REPEATERS
See Also:
Constant Field Values

P_NON_REPEATERS

public static final java.lang.String P_NON_REPEATERS
See Also:
Constant Field Values

F_NON_REPEATERS

public static final java.lang.String F_NON_REPEATERS
See Also:
Constant Field Values

O_TRAPV1_AGENT_ADDR

public static final java.lang.String O_TRAPV1_AGENT_ADDR
See Also:
Constant Field Values

P_TRAPV1_AGENT_ADDR

public static final java.lang.String P_TRAPV1_AGENT_ADDR
See Also:
Constant Field Values

F_TRAPV1_AGENT_ADDR

public static final java.lang.String F_TRAPV1_AGENT_ADDR
See Also:
Constant Field Values

O_TRAP_OID

public static final java.lang.String O_TRAP_OID
See Also:
Constant Field Values

P_TRAP_OID

public static final java.lang.String P_TRAP_OID
See Also:
Constant Field Values

F_TRAP_OID

public static final java.lang.String F_TRAP_OID
See Also:
Constant Field Values

O_TRAP_UPTIME

public static final java.lang.String O_TRAP_UPTIME
See Also:
Constant Field Values

P_TRAP_UPTIME

public static final java.lang.String P_TRAP_UPTIME
See Also:
Constant Field Values

F_TRAP_UPTIME

public static final java.lang.String F_TRAP_UPTIME
See Also:
Constant Field Values

O_TRAPV1_ENTERPRISE

public static final java.lang.String O_TRAPV1_ENTERPRISE
See Also:
Constant Field Values

P_TRAPV1_ENTERPRISE

public static final java.lang.String P_TRAPV1_ENTERPRISE
See Also:
Constant Field Values

F_TRAPV1_ENTERPRISE

public static final java.lang.String F_TRAPV1_ENTERPRISE
See Also:
Constant Field Values

O_TRAPV1_SPECIFIC_ID

public static final java.lang.String O_TRAPV1_SPECIFIC_ID
See Also:
Constant Field Values

P_TRAPV1_SPECIFIC_ID

public static final java.lang.String P_TRAPV1_SPECIFIC_ID
See Also:
Constant Field Values

F_TRAPV1_SPECIFIC_ID

public static final java.lang.String F_TRAPV1_SPECIFIC_ID
See Also:
Constant Field Values

O_TRAPV1_GENERIC_ID

public static final java.lang.String O_TRAPV1_GENERIC_ID
See Also:
Constant Field Values

P_TRAPV1_GENERIC_ID

public static final java.lang.String P_TRAPV1_GENERIC_ID
See Also:
Constant Field Values

F_TRAPV1_GENERIC_ID

public static final java.lang.String F_TRAPV1_GENERIC_ID
See Also:
Constant Field Values

O_BOOT_COUNTER

public static final java.lang.String O_BOOT_COUNTER
See Also:
Constant Field Values

P_BOOT_COUNTER

public static final java.lang.String P_BOOT_COUNTER
See Also:
Constant Field Values

F_BOOT_COUNTER

public static final java.lang.String F_BOOT_COUNTER
See Also:
Constant Field Values

O_SEC_LEVEL

public static final java.lang.String O_SEC_LEVEL
See Also:
Constant Field Values

P_SEC_LEVEL

public static final java.lang.String P_SEC_LEVEL
See Also:
Constant Field Values

F_SEC_LEVEL

public static final java.lang.String F_SEC_LEVEL
See Also:
Constant Field Values
Constructor Detail

SnmpConfigurator

public SnmpConfigurator()

SnmpConfigurator

public SnmpConfigurator(java.util.Properties props)
Method Detail

configure

public void configure(Snmp snmp,
                      java.util.Map settings)

getPDUFactory

public PDUFactory getPDUFactory(java.util.Map settings)

getTarget

public Target getTarget(java.util.Map settings)

createOctetString

public static OctetString createOctetString(java.lang.String s,
                                            java.lang.String defaultString)
Create an OctetString from a String value.

Parameters:
s - the string value to convert. If it starts with 0x its trailing value will be interpreted as a hex string with colon (:) separator.
defaultString - an optional default if s is null.
Returns:
an OctetString or null if s is null.
Since:
1.10.2

Copyright 2005-2010 Frank Fock (SNMP4J.org)

Copyright © 2011 SNMP4J.org. All Rights Reserved.