org.snmp4j.agent.security
Interface VACM

All Known Subinterfaces:

MutableVACM

All Known Implementing Classes:

VacmMIB

public interface VACM

The View-based Access Control Model interface defines methods and constants that a contrete implementation of such a model has to implement. An example of such a concrete implementation is defined by RFC 3415 and implemented by the VacmMIB class.

Version:

1.0

Author:

Frank Fock

Field Summary

static int	VACM_NO_ACCESS_ENTRY
static int	VACM_NO_GROUP_NAME
static int	VACM_NO_SUCH_CONTEXT
static int	VACM_NO_SUCH_VIEW
static int	VACM_NOT_IN_VIEW
static int	VACM_OK
static int	VACM_OTHER_ERROR
static int	VIEW_NOTIFY
static int	VIEW_READ
static int	VIEW_WRITE

Method Summary

org.snmp4j.smi.OctetString	getViewName(org.snmp4j.smi.OctetString context, org.snmp4j.smi.OctetString securityName, int securityModel, int securityLevel, int viewType) Gets the view name of the view defined by the supplied credentials.
int	isAccessAllowed(org.snmp4j.smi.OctetString context, org.snmp4j.smi.OctetString securityName, int securityModel, int securityLevel, int viewType, org.snmp4j.smi.OID oid) Checks whether access is allowed in the specified context for the security name, model, level, and view type for the supplied OID.
int	isAccessAllowed(org.snmp4j.smi.OctetString viewName, org.snmp4j.smi.OID oid) Checks if access is allowed for the given OID within the specified view.

Field Detail

VIEW_NOTIFY

static final int VIEW_NOTIFY

See Also:

Constant Field Values

VIEW_READ

static final int VIEW_READ

See Also:

Constant Field Values

VIEW_WRITE

static final int VIEW_WRITE

See Also:

Constant Field Values

VACM_OK

static final int VACM_OK

See Also:

Constant Field Values

VACM_NOT_IN_VIEW

static final int VACM_NOT_IN_VIEW

See Also:

Constant Field Values

VACM_NO_SUCH_VIEW

static final int VACM_NO_SUCH_VIEW

See Also:

Constant Field Values

VACM_NO_SUCH_CONTEXT

static final int VACM_NO_SUCH_CONTEXT

See Also:

Constant Field Values

VACM_NO_GROUP_NAME

static final int VACM_NO_GROUP_NAME

See Also:

Constant Field Values

VACM_NO_ACCESS_ENTRY

static final int VACM_NO_ACCESS_ENTRY

See Also:

Constant Field Values

VACM_OTHER_ERROR

static final int VACM_OTHER_ERROR

See Also:

Constant Field Values

Method Detail

isAccessAllowed

int isAccessAllowed(org.snmp4j.smi.OctetString context,
                    org.snmp4j.smi.OctetString securityName,
                    int securityModel,
                    int securityLevel,
                    int viewType,
                    org.snmp4j.smi.OID oid)

Checks whether access is allowed in the specified context for the security name, model, level, and view type for the supplied OID.

Parameters:

context - the context for which access is requested.

securityName - the security name.

securityModel - the security model, see SecurityModel for possible values.

securityLevel - the security level, see SecurityLevel for possible values.

viewType - the requested view type, possible values are VIEW_NOTIFY, VIEW_READ, and VIEW_WRITE.

oid - the OID of the object instance for which access is requested.

Returns:

VACM_OK if access is granted or one of the VACM errors defined by this interface if access is rejected.

isAccessAllowed

int isAccessAllowed(org.snmp4j.smi.OctetString viewName,
                    org.snmp4j.smi.OID oid)

Checks if access is allowed for the given OID within the specified view.

Parameters:

viewName - the name of an existing view, i.e. that has bee retrieved by getViewName(org.snmp4j.smi.OctetString, org.snmp4j.smi.OctetString, int, int, int) before.

oid - the OID of the object instance for which access is requested.

Returns:

VACM_OK if access is granted or one of the VACM errors defined by this interface if access is rejected.

getViewName

org.snmp4j.smi.OctetString getViewName(org.snmp4j.smi.OctetString context,
                                       org.snmp4j.smi.OctetString securityName,
                                       int securityModel,
                                       int securityLevel,
                                       int viewType)

Gets the view name of the view defined by the supplied credentials.

Parameters:

context - the context for which access is requested.

securityName - the security name.

securityModel - the security model, see SecurityModel for possible values.

securityLevel - the security level, see SecurityLevel for possible values.

viewType - the requested view type, possible values are VIEW_NOTIFY, VIEW_READ, and VIEW_WRITE.

Returns:

the view name if the credentials can be mapped to an existing view. Otherwise, if no such view exists then null is returned.