Module org.snmp4j

Package org.snmp4j.security

Enum Class UsmUser.LocalizationGrant

java.lang.Object

java.lang.Enum<UsmUser.LocalizationGrant>

org.snmp4j.security.UsmUser.LocalizationGrant

All Implemented Interfaces:

Serializable, Comparable<UsmUser.LocalizationGrant>, java.lang.constant.Constable

Enclosing class:

UsmUser

public static enum UsmUser.LocalizationGrant
extends Enum<UsmUser.LocalizationGrant>

This enum defines which Localization operations are allowed for a UsmUser. By default, and backward compatibility, any is the default. Use incoming for users that should receive notifications from unknown authoritative engine IDs. Use outgoing if the user must only be localized for command generators sending requests to command responders.

Since:

3.8.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
any	Allow any localization (default).
incoming	Allow localization for incoming message processing, i.e.
never	Never allow localization (does only make sense for non-localized users that should not be used with USM request processing).
outgoing	Allow localization for outgoing request processing where the using engine is non-authoritative, i.e.

Method Summary

Modifier and Type	Method	Description
static UsmUser.LocalizationGrant	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UsmUser.LocalizationGrant[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

never

public static final UsmUser.LocalizationGrant never

Never allow localization (does only make sense for non-localized users that should not be used with USM request processing). This is the default for already localized users.

outgoing

public static final UsmUser.LocalizationGrant outgoing

Allow localization for outgoing request processing where the using engine is non-authoritative, i.e. a command generator is sending a request message.

incoming

public static final UsmUser.LocalizationGrant incoming

Allow localization for incoming message processing, i.e. receiving notifications.

any

public static final UsmUser.LocalizationGrant any

Allow any localization (default).

Method Details

values

public static UsmUser.LocalizationGrant[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static UsmUser.LocalizationGrant valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null