java.lang.Object
org.snmp4j.SNMP4JSettings
The
SNMP4JSettings
class implements a central configuration class of the SNMP4J framework. As a rule of
thumb, changes to the default configuration should be made before any other classes of the SNMP4J API are
instantiated or referenced by the application code.- Since:
- 1.5
- Version:
- 3.6.1
- Author:
- Frank Fock
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Specifies the how the security level of retry requests after a REPORT PDU is set.static enum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The enterprise ID of AGENT++ which is the root OID also for SNMP4J. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Character
Gets the default non-printable character escape character.static int
Get the default number of retries for packet oriented transport mappings.static long
Get the default timeout forAbstractTarget
.static int
Gets the enterprise OID used for creating SNMP engine IDs and other enterprise specific identifiers.static int
Gets the maximum number of engine IDs to be hold in the cache of theMPv3
.static int
static OIDTextFormat
Gets the OID text format for textual representation of OIDs.Get the SNMP4J statistics level.static ThreadFactory
Gets the thread factory.static long
Gets the Thread join timeout used to join threads if no explicit timeout is set.static TimerFactory
Gets the timer factory.static VariableTextFormat
Gets the variable text format for textual representation of variable bindings.static boolean
static boolean
static boolean
Tests if the extensibility feature is enabled.static boolean
Indicates whether runtime exceptions should be thrown on thread boundaries controlled by SNMP4J and related APIs.static boolean
static Boolean
Check if logging secrets with their secret value in any debug level is allowed (true
) or not (false
).static void
setAllowSNMPv2InV1
(boolean allowSNMPv2InV1) Sets the compatibility flag for Counter64 usage in SNMPv1 PDUs and the ability to decode SNMPv2 traps in SNMPv1 version PDUs.static void
setCheckUsmUserPassphraseLength
(boolean checkUsmUserPassphraseLength) static void
setDefaultNonPrintableEscapeCharacter
(Character defaultNonPrintableEscapeCharacter) Gets the default non-printable character escape character.static void
setDefaultRetries
(int defaultRetries) Set the default number of retries for packet oriented transport mappings, default is 0.static void
setDefaultTimeoutMillis
(long defaultTimeoutMillis) Set the default timeout forAbstractTarget
.static void
setEnterpriseID
(int enterpriseID) Sets the enterprise OID used for creating SNMP engine IDs and other enterprise specific identifiers.static void
setExtensibilityEnabled
(boolean enable) Enables (or disables) the extensibility feature of SNMP4J.static void
setForwardRuntimeExceptions
(boolean forwardExceptions) Enables or disables runtime exception forwarding.static void
setMaxEngineIdCacheSize
(int maxEngineIdCacheSize) Sets the maximum number of engine IDs that can be cached by theMPv3
.static void
setMaxSizeRequestPDU
(int maxSizeRequestPDU) Sets the maximum size of a request PDU.static void
setNoGetBulk
(boolean noGetBulk) static void
setOIDTextFormat
(OIDTextFormat newOidTextFormat) Sets the OID text format to be used by SNMP4J.static void
setReportSecurityLevelStrategy
(SNMP4JSettings.ReportSecurityLevelStrategy reportSecurityLevelStrategy) static boolean
setSecretLoggingEnabled
(boolean enableSecretLogging) Activates or deactivates the secret logging.static void
setSnmp4jStatistics
(SNMP4JSettings.Snmp4jStatistics snmp4jStatistics) Sets the SNMP4J statistics level.static void
setThreadFactory
(ThreadFactory newThreadFactory) Sets the thread factory for creating new threads of execution.static void
setThreadJoinTimeout
(long millis) Sets the Thread join timeout used to join threads if no explicit timeout is set.static void
setTimerFactory
(TimerFactory newTimerFactory) Sets the timer factory for creating new timer instances.static void
setVariableTextFormat
(VariableTextFormat newVariableTextFormat) Sets the variable text format to be used by SNMP4J.
-
Field Details
-
AGENTPP_ENTERPRISE_ID
public static final int AGENTPP_ENTERPRISE_IDThe enterprise ID of AGENT++ which is the root OID also for SNMP4J.- See Also:
-
-
Constructor Details
-
SNMP4JSettings
public SNMP4JSettings()
-
-
Method Details
-
getMaxSizeRequestPDU
public static int getMaxSizeRequestPDU() -
setMaxSizeRequestPDU
public static void setMaxSizeRequestPDU(int maxSizeRequestPDU) Sets the maximum size of a request PDU. This value must be betweenSnmpConstants.MIN_PDU_LENGTH
and 65536 bytes (including).- Parameters:
maxSizeRequestPDU
- a value greater or equal to 494 and less or equal to 65535.- Since:
- 3.5.0
-
getDefaultRetries
public static int getDefaultRetries()Get the default number of retries for packet oriented transport mappings.- Returns:
- the default number of retries, should be greater than or equal to zero.
- Since:
- 3.5.0
-
setDefaultRetries
public static void setDefaultRetries(int defaultRetries) Set the default number of retries for packet oriented transport mappings, default is 0.- Parameters:
defaultRetries
- the number maximum of retries before a request is timed out. Must be greater than or equal to zero.
-
setExtensibilityEnabled
public static void setExtensibilityEnabled(boolean enable) Enables (or disables) the extensibility feature of SNMP4J. When enabled, SNMP4J checks certain properties files that describe which transport mappings, address types, SMI syntaxes, security protocols, etc. should be supported by SNMP4J.By default, the extensibility feature is disabled which provides a faster startup and since no system properties are read, it ensures that SNMP4J can be used also in secure environments like applets.
- Parameters:
enable
- iftrue
activates extensibility or iffalse
disables it. In the latter case, SNMP4J's default configuration will be used with all available features.- Since:
- 1.2.2
-
isExtensibilityEnabled
public static boolean isExtensibilityEnabled()Tests if the extensibility feature is enabled.- Returns:
- if
true
the extensibility is enabled otherwise it is disabled. In the latter case, SNMP4J's default configuration will be used with all available features. - Since:
- 1.2.2
-
setForwardRuntimeExceptions
public static void setForwardRuntimeExceptions(boolean forwardExceptions) Enables or disables runtime exception forwarding.- Parameters:
forwardExceptions
-true
runtime exceptions are thrown on thread boundaries controlled by SNMP4J and related APIs. Default isfalse
.- Since:
- 1.8.1
- See Also:
-
forwardRuntimeExceptions
-
isForwardRuntimeExceptions
public static boolean isForwardRuntimeExceptions()Indicates whether runtime exceptions should be thrown on thread boundaries controlled by SNMP4J and related APIs.- Returns:
true
runtime exceptions are thrown on thread boundaries controlled by SNMP4J and related APIs. Default isfalse
.- Since:
- 1.8.1
-
getThreadFactory
Gets the thread factory.- Returns:
- a ThreadFactory.
- Since:
- 1.9
-
setThreadFactory
Sets the thread factory for creating new threads of execution.- Parameters:
newThreadFactory
- a ThreadFactory (must not benull
).- Since:
- 1.9
-
getTimerFactory
Gets the timer factory.- Returns:
- a TimerFactory.
- Since:
- 1.9
-
setTimerFactory
Sets the timer factory for creating new timer instances.- Parameters:
newTimerFactory
- a TimerFactory (must not benull
).- Since:
- 1.9
-
getOIDTextFormat
Gets the OID text format for textual representation of OIDs.- Returns:
- an
OIDTextFormat
instance. - Since:
- 1.10
-
setOIDTextFormat
Sets the OID text format to be used by SNMP4J.- Parameters:
newOidTextFormat
- the newOIDTextFormat
(must not benull
).- Since:
- 1.10
-
getVariableTextFormat
Gets the variable text format for textual representation of variable bindings.- Returns:
- an
VariableTextFormat
instance. - Since:
- 1.10
-
setVariableTextFormat
Sets the variable text format to be used by SNMP4J.- Parameters:
newVariableTextFormat
- the newVariableTextFormat
(must not benull
).- Since:
- 1.10
-
getThreadJoinTimeout
public static long getThreadJoinTimeout()Gets the Thread join timeout used to join threads if no explicit timeout is set.- Returns:
- the timeout millis.
- Since:
- 1.10.2
-
setThreadJoinTimeout
public static void setThreadJoinTimeout(long millis) Sets the Thread join timeout used to join threads if no explicit timeout is set.- Parameters:
millis
- the maximum time in milliseconds to wait for a Thread to join if no explicit timeout has been set.- Since:
- 1.10.2
-
isAllowSNMPv2InV1
public static boolean isAllowSNMPv2InV1() -
setAllowSNMPv2InV1
public static void setAllowSNMPv2InV1(boolean allowSNMPv2InV1) Sets the compatibility flag for Counter64 usage in SNMPv1 PDUs and the ability to decode SNMPv2 traps in SNMPv1 version PDUs. The default isfalse
. Note: By setting this totrue
you disable SNMP standard conformity.- Parameters:
allowSNMPv2InV1
- if set totrue
, SNMP4J will allow Counter64 objects in SNMPv1 PDUs although the SNMPv1 standard does not allow this. There are several buggy implementations which send such v1 PDUs.- Since:
- 2.2
-
getReportSecurityLevelStrategy
-
setReportSecurityLevelStrategy
public static void setReportSecurityLevelStrategy(SNMP4JSettings.ReportSecurityLevelStrategy reportSecurityLevelStrategy) -
isNoGetBulk
public static boolean isNoGetBulk() -
setNoGetBulk
public static void setNoGetBulk(boolean noGetBulk) -
getEnterpriseID
public static int getEnterpriseID()Gets the enterprise OID used for creating SNMP engine IDs and other enterprise specific identifiers.- Returns:
- an enterprise ID. For example 4976 as enterprise ID (IANA number) for AGENT++ (SNMP4J). This value should be changed for other enterprises (i.e., companies or organizations).
-
setEnterpriseID
public static void setEnterpriseID(int enterpriseID) Sets the enterprise OID used for creating SNMP engine IDs and other enterprise specific identifiers.- Parameters:
enterpriseID
- the new enterprise ID.
-
getMaxEngineIdCacheSize
public static int getMaxEngineIdCacheSize()Gets the maximum number of engine IDs to be hold in the cache of theMPv3
. A upper limit is necessary to avoid DoS attacks with unconfirmed SNMPv3 PDUs.- Returns:
- the maximum number, by default 50.000 (~2MB of cached data).
- Since:
- 2.3.4
-
setMaxEngineIdCacheSize
public static void setMaxEngineIdCacheSize(int maxEngineIdCacheSize) Sets the maximum number of engine IDs that can be cached by theMPv3
.- Parameters:
maxEngineIdCacheSize
- the maximum number of engine IDs in the cache, by default 50.000 (~2MB of cached data).- Since:
- 2.3.4
-
getSnmp4jStatistics
Get the SNMP4J statistics level.- Returns:
- the Snmp4jStatistics enum value.
- Since:
- 2.4.2
-
setSnmp4jStatistics
Sets the SNMP4J statistics level.- Parameters:
snmp4jStatistics
- the level of statistics to be collected by SNMP4J and provided throughCounterEvent
s.- Since:
- 2.4.2
-
isCheckUsmUserPassphraseLength
public static boolean isCheckUsmUserPassphraseLength() -
setCheckUsmUserPassphraseLength
public static void setCheckUsmUserPassphraseLength(boolean checkUsmUserPassphraseLength) -
getDefaultTimeoutMillis
public static long getDefaultTimeoutMillis()Get the default timeout forAbstractTarget
.- Returns:
- the default timeout in milli seconds.
- Since:
- 3.5.0
-
setDefaultTimeoutMillis
public static void setDefaultTimeoutMillis(long defaultTimeoutMillis) Set the default timeout forAbstractTarget
. The default of the default value is 1000 milliseconds (= one second).- Parameters:
defaultTimeoutMillis
- the default timeout forTarget
s in milli seconds.- Since:
- 3.5.0
-
getDefaultNonPrintableEscapeCharacter
Gets the default non-printable character escape character. Ifnull
non-printableOctetString
and otherVariable
will be printed/formatted withVariable#toString()
as hexadecimal string. If nonnull
non-printable characters (seeOctetString.isPrintable()
) will be replaced by the given character in the output.- Returns:
- the escape character for non-printable characters.
- Since:
- 3.6.1
-
setDefaultNonPrintableEscapeCharacter
public static void setDefaultNonPrintableEscapeCharacter(Character defaultNonPrintableEscapeCharacter) Gets the default non-printable character escape character. Ifnull
non-printableOctetString
and otherVariable
will be printed/formatted withVariable#toString()
as hexadecimal string. If nonnull
non-printable characters (seeOctetString.isPrintable()
) will be replaced by the given character in the output.- Parameters:
defaultNonPrintableEscapeCharacter
- the escape character for non-printable characters.null
disables escaping.- Since:
- 3.6.1
-
isSecretLoggingEnabled
Check if logging secrets with their secret value in any debug level is allowed (true
) or not (false
). This value isfalse
by default.- Returns:
true
if secret logging is enabled,false
otherwise.
-
setSecretLoggingEnabled
public static boolean setSecretLoggingEnabled(boolean enableSecretLogging) Activates or deactivates the secret logging. Note: Disabling secret logging is possible at any time, but enabling it is only possible if it has not yet been disabled.- Parameters:
enableSecretLogging
-true
for enabling secret logging,false
otherwise. Enabling will work only initially.- Returns:
- the new status (
true
if secret logging is enabled,false
otherwise). - Since:
- 3.6.1
-