org.friendlysnmp.target

Class TargetBase

java.lang.Object

org.friendlysnmp.target.TargetBase

Direct Known Subclasses:

TargetV1, TargetV3

public abstract class TargetBase
extends java.lang.Object

This class is a base class for SNMP v2 and v3 targets.

Field Summary

Fields

Modifier and Type	Field and Description
protected AgentWorker	agent SNMP agent
protected FConfig	config Configuration object
protected Storage	storageNotify Storage for notify
protected Storage	storageVacmAccess Storage for Vacm access
protected Storage	storageVacmGroup Storage for Vacm group
protected Storage	storageVacmViewTree Storage for Vacm view tree

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TargetBase(java.lang.String targetName) Constructor

Method Summary

Modifier and Type	Method and Description
void	addCommunities(org.snmp4j.agent.mo.snmp.SnmpCommunityMIB communityMIB) Adds communities
protected void	addNotificationEntry(org.snmp4j.agent.mo.snmp.SnmpNotificationMIB notificationMIB, org.friendlysnmp.target.TargetBase.NotificationType type) Adds notification entry with default tag to notification MIB
protected void	addNotificationEntry(org.snmp4j.agent.mo.snmp.SnmpNotificationMIB notificationMIB, org.friendlysnmp.target.TargetBase.NotificationType type, org.snmp4j.smi.OctetString octTag) Adds notification entry to notification MIB
abstract void	addNotificationTargets(org.snmp4j.agent.mo.snmp.SnmpTargetMIB targetMIB, org.snmp4j.agent.mo.snmp.SnmpNotificationMIB notificationMIB) Adds notification target
protected void	addTargetAddress(org.snmp4j.agent.mo.snmp.SnmpTargetMIB targetMIB) Adds target address to the target MIB.
protected void	addTargetAddress(org.snmp4j.agent.mo.snmp.SnmpTargetMIB targetMIB, org.snmp4j.smi.OctetString octTagList) Adds target address to the target MIB.
protected void	addTargetParams(org.snmp4j.agent.mo.snmp.SnmpTargetMIB targetMIB) Adds target parameters to the target MIB
void	addUsmUser(org.snmp4j.security.USM usm) Adds USM user
abstract void	addViews(org.snmp4j.agent.mo.snmp.VacmMIB vacm) Adds VACM views
protected org.snmp4j.smi.OctetString	createNotificationName() Returns notification name which is used to create an entry index
protected int	getProcessingModel() Return message processing model.
protected int	getSecurityLevel() Returns security level.
protected int	getSecurityModel() Returns security model.
protected org.snmp4j.smi.OctetString	getTargetAddrName() The method creates read-only "Name" for the column snmpTargetAddrName in the table snmpTargetMIB.snmpTargetAddrTable.
java.lang.String	getTargetName()
protected org.snmp4j.smi.OctetString	getTargetParamsName() The method creates read-only "Name" which is used in two places linking them: 1.
protected org.snmp4j.smi.OctetString	getTransportAddress() Return transport address.
protected org.snmp4j.smi.OID	getTransportDomainOID() Returns transport domain OID
void	init(AgentWorker aw) Initializes target
protected void	setSNMP(int secModel, int procModel, int secLevel)
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

agent

protected AgentWorker agent

SNMP agent

config

protected FConfig config

Configuration object

storageVacmGroup

protected Storage storageVacmGroup

Storage for Vacm group

storageVacmAccess

protected Storage storageVacmAccess

Storage for Vacm access

storageVacmViewTree

protected Storage storageVacmViewTree

Storage for Vacm view tree

storageNotify

protected Storage storageNotify

Storage for notify

Constructor Detail

TargetBase

protected TargetBase(java.lang.String targetName)

Constructor

Parameters:

targetName - target

Method Detail

setSNMP

protected void setSNMP(int secModel,
                       int procModel,
                       int secLevel)

init

public void init(AgentWorker aw)
          throws FException

Initializes target

Parameters:

aw - agent

Throws:

FException - exception may be thrown in derived class

addCommunities

public void addCommunities(org.snmp4j.agent.mo.snmp.SnmpCommunityMIB communityMIB)

Adds communities

Parameters:

communityMIB - community MIB

addViews

public abstract void addViews(org.snmp4j.agent.mo.snmp.VacmMIB vacm)

Adds VACM views

Parameters:

vacm - VACM MIB

addUsmUser

public void addUsmUser(org.snmp4j.security.USM usm)

Adds USM user

Parameters:

usm - USM user

addNotificationTargets

public abstract void addNotificationTargets(org.snmp4j.agent.mo.snmp.SnmpTargetMIB targetMIB,
                                            org.snmp4j.agent.mo.snmp.SnmpNotificationMIB notificationMIB)

Adds notification target

Parameters:

targetMIB - target MIB

notificationMIB - notification MIB

addTargetAddress

protected void addTargetAddress(org.snmp4j.agent.mo.snmp.SnmpTargetMIB targetMIB)

Adds target address to the target MIB.

Parameters:

targetMIB - target MIB.

addTargetAddress

protected void addTargetAddress(org.snmp4j.agent.mo.snmp.SnmpTargetMIB targetMIB,
                                org.snmp4j.smi.OctetString octTagList)

Adds target address to the target MIB.

Parameters:

targetMIB - target MIB.

octTagList - space delimited tag list in OctetString format.

addTargetParams

protected void addTargetParams(org.snmp4j.agent.mo.snmp.SnmpTargetMIB targetMIB)

Adds target parameters to the target MIB

Parameters:

targetMIB - target MIB

addNotificationEntry

protected void addNotificationEntry(org.snmp4j.agent.mo.snmp.SnmpNotificationMIB notificationMIB,
                                    org.friendlysnmp.target.TargetBase.NotificationType type)

Adds notification entry with default tag to notification MIB

Parameters:

notificationMIB - notification MIB

type - notification type

addNotificationEntry

protected void addNotificationEntry(org.snmp4j.agent.mo.snmp.SnmpNotificationMIB notificationMIB,
                                    org.friendlysnmp.target.TargetBase.NotificationType type,
                                    org.snmp4j.smi.OctetString octTag)

Adds notification entry to notification MIB

Parameters:

notificationMIB - notification MIB

type - notification type

octTag - tag

getTargetName

public java.lang.String getTargetName()

getSecurityModel

protected int getSecurityModel()

Returns security model.

Returns:

security model

getProcessingModel

protected int getProcessingModel()

Return message processing model.

Returns:

message processing model.

getSecurityLevel

protected int getSecurityLevel()

Returns security level.

Returns:

security level.

getTargetAddrName

protected org.snmp4j.smi.OctetString getTargetAddrName()

The method creates read-only "Name" for the column snmpTargetAddrName in the table snmpTargetMIB.snmpTargetAddrTable. This name could be any unique. See description in the MIB: "The locally arbitrary, but unique identifier associated with this snmpTargetAddrEntry."

Returns:

OctetString

getTargetParamsName

protected org.snmp4j.smi.OctetString getTargetParamsName()

The method creates read-only "Name" which is used in two places linking them:
1. Column snmpTargetParamsName in the table snmpTargetMIB.snmpTargetParamsTable
2. Column snmpTargetAddrParams in the table snmpTargetMIB.snmpTargetAddrTable

The name could be any unique. See description in the MIB for these two tables. MIB Params table: "The locally arbitrary, but unique identifier associated with this snmpTargetParamsEntry."
MIB Addr table: "The value of this object identifies an entry in the snmpTargetParamsTable. The identified entry contains SNMP parameters to be used when generating messages to be sent to this transport address."

Returns:

OctetString

createNotificationName

protected org.snmp4j.smi.OctetString createNotificationName()

Returns notification name which is used to create an entry index

Returns:

notification name

getTransportDomainOID

protected org.snmp4j.smi.OID getTransportDomainOID()

Returns transport domain OID

Returns:

transport domain OID

getTransportAddress

protected org.snmp4j.smi.OctetString getTransportAddress()

Return transport address.

Returns:

transport address.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()