com.adventnet.snmp.snmp2.agent.notification
Class SnmpNotifyFilterTableRequestHandler

java.lang.Object
  |
  +--com.adventnet.snmp.snmp2.agent.SimpleRequestHandler
        |
        +--com.adventnet.snmp.snmp2.agent.BaseTableRequestHandler
              |
              +--com.adventnet.snmp.snmp2.agent.notification.SnmpNotifyFilterTableRequestHandler

public class SnmpNotifyFilterTableRequestHandler

extends BaseTableRequestHandler

Handles all requests under snmpNotifyFilterTable group.

Field Summary

(package private) SnmpAgent	agentName
(package private) SnmpAPI	api
(package private) static int	COLUMNCOUNT
(package private) java.lang.String	fileDir
(package private) java.lang.String	format
(package private) SnmpNotifyFilterTable	notifyFilterTable
(package private) SnmpNotifyTable	notifyTable
(package private) java.util.Vector	snmpNotifyFilterEntryVector
(package private) static int	SNMPNOTIFYFILTERMASK
(package private) static int	SNMPNOTIFYFILTERROWSTATUS
(package private) static int	SNMPNOTIFYFILTERSTORAGETYPE
(package private) static int	SNMPNOTIFYFILTERSUBTREE
(package private) static int	SNMPNOTIFYFILTERTYPE
(package private) SnmpNotifyFilterTableXMLToVector	xmlToVector

Fields inherited from class com.adventnet.snmp.snmp2.agent.BaseTableRequestHandler

agentName, listenerList, tModelComplete

Fields inherited from class com.adventnet.snmp.snmp2.agent.SimpleRequestHandler

instrumentHandler, listener, tableListener, writeEachTime

Constructor Summary

SnmpNotifyFilterTableRequestHandler(SnmpAgent agentRef)
The Primary Constructor for the SnmpNotifyFilterTableRequestHandler with * Agent Reference.

SnmpNotifyFilterTableRequestHandler(SnmpAgent agentRef, java.lang.String dirStr, java.lang.String fileName, java.lang.String format)
The Secondary Constructor with the agent Name and Persistence Support.

Method Summary

(package private) boolean	checkForRowStatus(SnmpNotifyFilterEntry entry)
boolean	createAndAddSnmpNotifyFilterEntry(java.lang.String profileName, java.lang.String filterSubtree, java.lang.String filterMask, java.lang.Integer filterType, java.lang.Integer storageType, java.lang.Integer rowStatus) The Method to Create and Add a new SnmpNotifyFilterEntry to SnmpNotifyTable.
static SnmpNotifyFilterEntry	createSnmpNotifyFilterEntry(java.lang.String profileName, java.lang.String filterSubtree, java.lang.String filterMask, java.lang.Integer filterType, java.lang.Integer storageType, java.lang.Integer rowStatus) The Static Method to create a SnmpNotifyFilterEntry.
int[]	getOidRep() Retrives the integer representation of OID
static int[]	getSnmpNotifyFilterTableOidRep() Getter for the Snmp Notify Filter Table OID representation.
protected int[]	getSubidList() Gets the subid list of the oid.
java.util.Vector	getTableVector() The method to return the Vector of SnmpNotifyFilterEntries present in the SnmpNotifyFilterTable.
protected void	processGetNextRequest(SnmpVarBind varb, AgentNode node, VarBindRequestEvent pe) Process the GetNext Request message which is received from PduRequestHandler.
protected void	processGetRequest(SnmpVarBind varb, AgentNode node, VarBindRequestEvent pe) Process the Get Request message which is received from PduRequestHandler.
protected void	processGetRequest(SnmpVarBind varb, int req, VarBindRequestEvent pe, SnmpNotifyFilterEntry entry, byte[] profileName) Process the Get Request message for the given params.
protected void	processSetRequest(SnmpVarBind varb, AgentNode node, VarBindRequestEvent pe) Process the Set Request message which is received from PduRequestHandler.
void	serialize(java.io.ObjectOutputStream outMain) This method Serializes the Output Stream.
void	setTableVector(java.util.Vector notifyFilterVec) The method to set the Vector of SnmpNotifyFilterEntries.

Methods inherited from class com.adventnet.snmp.snmp2.agent.BaseTableRequestHandler

addChangeListener, createChangeEvent, fireChangeEvent, removeChangeListener

Methods inherited from class com.adventnet.snmp.snmp2.agent.SimpleRequestHandler

addInstrumentHandler, addRegistrationListener, addTableListener, addUpdateListener, getInstrument, getMibVarHash, getNextRequest, getObjectHash, getObjectTypeHash, getRequest, getTableListener, isWriteEachTime, processGetNextRequest, processGetRequest, processSetRequest, removeRegistrationListener, removeUpdateListener, setRequest, setWriteEachTime, writeIntoFile

Methods inherited from class java.lang.Object

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

Field Detail

SNMPNOTIFYFILTERSUBTREE

static final int SNMPNOTIFYFILTERSUBTREE

SNMPNOTIFYFILTERMASK

static final int SNMPNOTIFYFILTERMASK

SNMPNOTIFYFILTERTYPE

static final int SNMPNOTIFYFILTERTYPE

SNMPNOTIFYFILTERSTORAGETYPE

static final int SNMPNOTIFYFILTERSTORAGETYPE

SNMPNOTIFYFILTERROWSTATUS

static final int SNMPNOTIFYFILTERROWSTATUS

COLUMNCOUNT

static final int COLUMNCOUNT

agentName

SnmpAgent agentName

api

SnmpAPI api

notifyFilterTable

SnmpNotifyFilterTable notifyFilterTable

notifyTable

SnmpNotifyTable notifyTable

snmpNotifyFilterEntryVector

java.util.Vector snmpNotifyFilterEntryVector

xmlToVector

SnmpNotifyFilterTableXMLToVector xmlToVector

format

java.lang.String format

fileDir

java.lang.String fileDir

Constructor Detail

SnmpNotifyFilterTableRequestHandler

public SnmpNotifyFilterTableRequestHandler(SnmpAgent agentRef)

The Primary Constructor for the SnmpNotifyFilterTableRequestHandler with * Agent Reference.

Parameters:

agentRef - The Agent Reference.

SnmpNotifyFilterTableRequestHandler

public SnmpNotifyFilterTableRequestHandler(SnmpAgent agentRef,
                                           java.lang.String dirStr,
                                           java.lang.String fileName,
                                           java.lang.String format)

The Secondary Constructor with the agent Name and Persistence Support.

Parameters:

agentRef - The Agent Name Reference.

dirStr - the directory location String of the File.

fileName - The fileName String.

format - The file format("xml").

Method Detail

getSnmpNotifyFilterTableOidRep

public static int[] getSnmpNotifyFilterTableOidRep()

Getter for the Snmp Notify Filter Table OID representation.

Returns:

The OID Representation Required.

getOidRep

public int[] getOidRep()

Description copied from class: SimpleRequestHandler

Retrives the integer representation of OID

Overrides:

getOidRep in class SimpleRequestHandler

Tags copied from class: SimpleRequestHandler

Returns:

the integer array of OID

getSubidList

protected int[] getSubidList()

Description copied from class: SimpleRequestHandler

Gets the subid list of the oid.

Overrides:

getSubidList in class SimpleRequestHandler

Tags copied from class: SimpleRequestHandler

Returns:

the integer array of subid list

processGetRequest

protected void processGetRequest(SnmpVarBind varb,
                                 AgentNode node,
                                 VarBindRequestEvent pe)
                          throws AgentSnmpException

Description copied from class: SimpleRequestHandler

Process the Get Request message which is received from PduRequestHandler.

Overrides:

processGetRequest in class SimpleRequestHandler

Tags copied from class: SimpleRequestHandler

Parameters:

varb - The received varbind .

node - The node for which Get Request is to be done.

pe - The VarBind Request Event created by this Get request.

Throws:

AgentSnmpException - This wraps all the Exceptions thrown while Processing the Event.

processGetRequest

protected void processGetRequest(SnmpVarBind varb,
                                 int req,
                                 VarBindRequestEvent pe,
                                 SnmpNotifyFilterEntry entry,
                                 byte[] profileName)
                          throws AgentSnmpException

Process the Get Request message for the given params.

Parameters:

varb - The received VarBind.

req - The request given.

pe - The Varbind Request Event created after thid Event.

entry - The Snmp Notify Filter Entry for the Request.

profileName - The Profile name of the Notify Filter Table.

Throws:

AgentSnmpException - This wraps all the Exceptions thrown by the Agent while Processing this event.

processSetRequest

protected void processSetRequest(SnmpVarBind varb,
                                 AgentNode node,
                                 VarBindRequestEvent pe)
                          throws AgentSnmpException

Description copied from class: SimpleRequestHandler

Process the Set Request message which is received from PduRequestHandler.

Overrides:

processSetRequest in class SimpleRequestHandler

Tags copied from class: SimpleRequestHandler

Parameters:

varb - The received varbind.

node - The node for which Get Next Request is to be done.

pe - The VarBind Request Event created by this GetNext request.

Throws:

AgentSnmpException - This wraps all the Exceptions thrown while Processing the Event.

processGetNextRequest

protected void processGetNextRequest(SnmpVarBind varb,
                                     AgentNode node,
                                     VarBindRequestEvent pe)
                              throws AgentSnmpException

Description copied from class: SimpleRequestHandler

Process the GetNext Request message which is received from PduRequestHandler.

Overrides:

processGetNextRequest in class SimpleRequestHandler

Tags copied from class: SimpleRequestHandler

Parameters:

varb - The received varbind.

node - The node for which Get Next Request is to be done.

pe - The VarBind Request Event created by this GetNext request.

Throws:

AgentSnmpException - This wraps all the Exceptions thrown while Processing the Event.

checkForRowStatus

boolean checkForRowStatus(SnmpNotifyFilterEntry entry)
                    throws AgentException

createAndAddSnmpNotifyFilterEntry

public boolean createAndAddSnmpNotifyFilterEntry(java.lang.String profileName,
                                                 java.lang.String filterSubtree,
                                                 java.lang.String filterMask,
                                                 java.lang.Integer filterType,
                                                 java.lang.Integer storageType,
                                                 java.lang.Integer rowStatus)

The Method to Create and Add a new SnmpNotifyFilterEntry to SnmpNotifyTable.

Parameters:

profileName - The profileName with which the entry is to be created.

filterSubtree - The filterSubtree with which the entry is to be created.

filterMask - The filterMask with which the entry is to be created.

filterType - The filterType with which the entry is to be created.

storageType - The storageType for the Entry.

rowStatus - the RowStatus Integer for the Entry.

Returns:

the boolean specifying whether the row is added Successfylly or Not.

See Also:

createSnmpNotifyFilterEntry.

createSnmpNotifyFilterEntry

public static SnmpNotifyFilterEntry createSnmpNotifyFilterEntry(java.lang.String profileName,
                                                                java.lang.String filterSubtree,
                                                                java.lang.String filterMask,
                                                                java.lang.Integer filterType,
                                                                java.lang.Integer storageType,
                                                                java.lang.Integer rowStatus)

The Static Method to create a SnmpNotifyFilterEntry.

Parameters:

profileName - The profileName with which the entry is to be created.

filterSubtree - The filterSubtree with which the entry is to be created.

filterMask - The filterMask with which the entry is to be created.

filterType - The filterType with which the entry is to be created.

storageType - The storageType for the Entry.

rowStatus - the RowStatus Integer for the Entry.

Returns:

The created SnmpNotifyFilterEntry Object.

See Also:

createAndAddSnmpNotifyFilterEntry.

setTableVector

public void setTableVector(java.util.Vector notifyFilterVec)

The method to set the Vector of SnmpNotifyFilterEntries.

Overrides:

setTableVector in class BaseTableRequestHandler

Parameters:

The - Vector of SnmpNotifyFilterEntries.

getTableVector

public java.util.Vector getTableVector()

The method to return the Vector of SnmpNotifyFilterEntries present in the SnmpNotifyFilterTable.

Overrides:

getTableVector in class BaseTableRequestHandler

Returns:

The Vector of SnmpNotifyFilterEntries.

serialize

public void serialize(java.io.ObjectOutputStream outMain)

This method Serializes the Output Stream.

Parameters:

outMain - The objet Output stream to be serialized.