Module org.snmp4j.agent

Package org.snmp4j.agent.security

Class BasicVacmConfigurator

java.lang.Object

org.snmp4j.agent.security.BasicVacmConfigurator

All Implemented Interfaces:

VacmConfigurator

public class BasicVacmConfigurator
extends Object
implements VacmConfigurator

The BasicVacmConfigurator implements the VacmConfigurator that uses three unrestricted views for all access types to support two roles admin and monitor. The admin role has unrestricted access to the agent, whereas monitor has no write access, but unrestricted read and notification access.

Since:

3.0

Author:

Frank Fock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BasicVacmConfigurator.Roles

Nested classes/interfaces inherited from interface org.snmp4j.agent.security.VacmConfigurator

VacmConfigurator.VacmConfigResult

Field Summary

Fields

Modifier and Type	Field	Description
protected int	contextMatch
protected org.snmp4j.smi.OctetString	contextPrefix
protected org.snmp4j.smi.OID	rootOID
protected org.snmp4j.smi.OctetString	rootViewName
protected org.snmp4j.security.SecurityLevel	securityLevel
protected org.snmp4j.security.SecurityModel	securityModel

Constructor Summary

Constructors

Constructor	Description
BasicVacmConfigurator()

Method Summary

Modifier and Type	Method	Description
VacmConfigurator.VacmConfigResult	addUser(MutableVACM vacm, org.snmp4j.smi.OctetString securityName, String role)	Add a new user to a group.
String[]	getSupportedRoles()	Returns the list of roles supported by this configurator.
protected boolean	isRoleSupported(String role)
VacmConfigurator.VacmConfigResult	removeRole(MutableVACM vacm, String role)	Remover all users from the specified security group and then remove the group itself.
VacmConfigurator.VacmConfigResult	removeUser(MutableVACM vacm, org.snmp4j.smi.OctetString securityName, String role)	Remove a new user from the specified group.

Methods inherited from class java.lang.Object

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

Field Details

rootViewName

protected org.snmp4j.smi.OctetString rootViewName

rootOID

protected org.snmp4j.smi.OID rootOID

securityModel

protected org.snmp4j.security.SecurityModel securityModel

securityLevel

protected org.snmp4j.security.SecurityLevel securityLevel

contextPrefix

protected org.snmp4j.smi.OctetString contextPrefix

contextMatch

protected int contextMatch

Constructor Details

BasicVacmConfigurator

public BasicVacmConfigurator()

Method Details

addUser

public VacmConfigurator.VacmConfigResult addUser(MutableVACM vacm,
 org.snmp4j.smi.OctetString securityName,
 String role)

Description copied from interface: VacmConfigurator

Add a new user to a group. If the referenced group does not exist, it will be created. If the role identified by the group is not supported by this configurator, an error is returned.

Specified by:

addUser in interface VacmConfigurator

Parameters:

vacm - the MutableVACM to modify

securityName - the user name of the new user.

role - the group (VACM)/role name associated with the user. Only supported groups must ber provided. See VacmConfigurator.getSupportedRoles().

Returns:

the operation result.

removeUser

public VacmConfigurator.VacmConfigResult removeUser(MutableVACM vacm,
 org.snmp4j.smi.OctetString securityName,
 String role)

Description copied from interface: VacmConfigurator

Remove a new user from the specified group. If the referenced group does not exist, nothing will be changed and VacmConfigurator.VacmConfigResult.userRemovedFromRole will be returned. If the role identified by the group is not supported by this configurator, an error is returned.

Specified by:

removeUser in interface VacmConfigurator

Parameters:

vacm - the MutableVACM to modify

securityName - the user name of the new user.

role - the group (VACM)/role name associated with the user. Only supported groups must be provided. See VacmConfigurator.getSupportedRoles().

Returns:

the operation result.

removeRole

public VacmConfigurator.VacmConfigResult removeRole(MutableVACM vacm,
 String role)

Description copied from interface: VacmConfigurator

Remover all users from the specified security group and then remove the group itself. This operation will only affect the VACM provided, but not the USM.

Specified by:

removeRole in interface VacmConfigurator

Parameters:

vacm - the MutableVACM to modify

role - the group (VACM)/role to be removed from the above vacm.

Returns:

the operation result.

getSupportedRoles

public String[] getSupportedRoles()

Description copied from interface: VacmConfigurator

Returns the list of roles supported by this configurator.

Specified by:

getSupportedRoles in interface VacmConfigurator

Returns:

a non-empty array of roles/groups supported by this configurator.

isRoleSupported

protected boolean isRoleSupported(String role)