File	Doc	Category	Size	Date	Package
SnmpTableSupport.java	API Doc	Java SE 5 API	18448	Fri Aug 26 14:55:04 BST 2005	com.sun.jmx.snmp.agent

SnmpTableSupport

• java.lang.Object

Fields Summary
protected List	entries The list of entries
protected SnmpMibTable	meta The associated metadata object
protected SnmpMib	theMib The MIB to which this table belongs
private boolean	registrationRequired This variable is initialized while binding this object to its corresponding meta object.

Constructors Summary

protected SnmpTableSupport(SnmpMib mib) Initializes the table. The steps are these: allocate an array for storing entry object, retrieve the corresponding metadata object from the MIB, bind this object to the corresponding metadata object from the MIB. param mib The MIB to which this table belong. //----------------------------------------------------------------- // // Constructor // //----------------------------------------------------------------- theMib = mib; meta = getRegisteredTableMeta(mib); bindWithTableMeta(); entries = allocateTable();

Methods Summary
protected void	addEntry(SnmpIndex index, java.lang.Object entry) Add an entry in this table. This method registers an entry in the table and perform synchronization with the associated table metadata object. This method assumes that the given entry will not be registered, or will be registered with its default ObjectName built from the associated SnmpIndex. If the entry is going to be registered, then {@link com.sun.jmx.snmp.agent.SnmpTableSupport#addEntry(SnmpIndex, ObjectName, Object)} should be prefered. This function is mainly provided for backward compatibility. param index The SnmpIndex built from the given entry. param entry The entry that should be added in the table. exception SnmpStatusException if the entry cannot be registered with the given index. SnmpOid oid = buildOidFromIndex(index); ObjectName name = null; if (isRegistrationRequired()) { name = buildNameFromIndex(index); } meta.addEntry(oid,name,entry);
protected void	addEntry(SnmpIndex index, javax.management.ObjectName name, java.lang.Object entry) Add an entry in this table. This method registers an entry in the table and performs synchronization with the associated table metadata object. param index The SnmpIndex built from the given entry. param name The ObjectName with which this entry will be registered. param entry The entry that should be added in the table. exception SnmpStatusException if the entry cannot be registered with the given index. SnmpOid oid = buildOidFromIndex(index); meta.addEntry(oid,name,entry);
public void	addEntryCb(int pos, com.sun.jmx.snmp.SnmpOid row, javax.management.ObjectName name, java.lang.Object entry, SnmpMibTable meta) This callback is called by the associated metadata object when a new table entry has been registered in the table metadata. This method will update the entries list. param pos The position at which the new entry was inserted in the table. param row The row OID of the new entry param name The ObjectName of the new entry (as specified by the factory) param entry The new entry (as returned by the factory) param meta The table metadata object. try { if (entries != null) entries.add(pos,entry); } catch (Exception e) { throw new SnmpStatusException(SnmpStatusException.noSuchName); }
public void	addNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object handback) Enables to add an SNMP entry listener to this SnmpMibTable. param listener The listener object which will handle the notifications emitted by the registered MBean. param filter The filter object. If filter is null, no filtering will be performed before handling notifications. param handback The context to be sent to the listener when a notification is emitted. exception IllegalArgumentException Listener parameter is null. meta.addNotificationListener(listener,filter,handback);
protected java.util.List	allocateTable() Allocates an ArrayList for storing table entries. This method is called within the constructor at object creation. Any object implementing the {@link java.util.List} interface can be used. return A new list in which to store entries. If null is returned then no entry will be stored in the list and getEntry() will always return null. return new ArrayList();
protected void	bindWithTableMeta() Binds this table with its associated metadata, registering itself as an SnmpTableEntryFactory. if (meta == null) return; registrationRequired = meta.isRegistrationRequired(); meta.registerEntryFactory(this);
public abstract javax.management.ObjectName	buildNameFromIndex(SnmpIndex index) Builds the default ObjectName of an entry from the SnmpIndex identifying this entry. No access is made on the entry itself. This method is generated by mibgen and used internally. You can subclass this method if you want to change the default ObjectName policy. This is only meaningfull when entries are registered MBeans. param index The SnmpIndex identifying the entry from which we want to build the default ObjectName. return The default ObjectName for the entry identified by the given index. exception SnmpStatusException if the given index is not valid.
public abstract com.sun.jmx.snmp.SnmpOid	buildOidFromIndex(SnmpIndex index) Builds an SnmpOid from an SnmpIndex object. This method is generated by mibgen and used internally. param index An SnmpIndex object identifying a table entry. return The SnmpOid form of the given entry index. exception SnmpStatusException if the given index is not valid.
protected abstract SnmpIndex	buildSnmpIndex(long[] oid, int start) Builds an SnmpIndex object from the index part of an OID. This method is generated by mibgen and used internally. param oid The OID from which to build the index, represented as an array of long. param start The position where to start from in the OID array. return The SnmpOid form of the given entry index. exception SnmpStatusException if the given index is not valid.
public SnmpIndex	buildSnmpIndex(com.sun.jmx.snmp.SnmpOid rowOid) Builds an entry SnmpIndex from its row OID. This method is generated by mibgen and used internally. param rowOid The SnmpOid object identifying a table entry. return The SnmpIndex of the entry identified by rowOid. exception SnmpStatusException if the index cannot be built from the given OID. return buildSnmpIndex(rowOid.longValue(false), 0);
public abstract void	createNewEntry(SnmpMibSubRequest request, com.sun.jmx.snmp.SnmpOid rowOid, int depth, SnmpMibTable meta) Creates a new entry in the table. This factory method is generated by mibgen and used internally. It is part of the {@link com.sun.jmx.snmp.agent.SnmpTableEntryFactory} interface. You may subclass this method to implement any specific behaviour your application requires. exception SnmpStatusException if the entry cannot be created.
protected java.lang.Object[]	getBasicEntries() Returns the entries in the table. return An Object[] array containing the entries registered in the table. if (entries == null) return null; Object[] array= new Object[entries.size()]; entries.toArray(array); return array;
public java.lang.Object	getEntry(int pos) Returns the entry located at the given position in the table. return The entry located at the given position, null if no entry can be found at this position. if (entries == null) return null; return entries.get(pos);
public javax.management.MBeanNotificationInfo[]	getNotificationInfo() Returns a NotificationInfo object containing the notification class and the notification type sent by the SnmpMibTable. return meta.getNotificationInfo();
protected abstract SnmpMibTable	getRegisteredTableMeta(SnmpMib mib) Returns the metadata object associated with this table. This method is generated by mibgen and used internally. param mib The SnmpMib object holding the Metadata corresponding to this table. return The metadata object associated with this table. Returns null if this implementation of the MIB doesn't support this table.
public int	getSize() Returns the number of entries registered in the table. return The number of entries registered in the table. return meta.getSize();
public boolean	isCreationEnabled() Tells whether a new entry should be created when a SET operation is received for an entry that does not exist yet. This method calls isCreationEnabled() on the metadata object associated with this table. return true if a new entry must be created, false otherwise. [default: returns false] see com.sun.jmx.snmp.agent.SnmpMibTable return meta.isCreationEnabled();
public boolean	isRegistrationRequired() Tells whether the metadata object to which this table is linked requires entries to be registered. In this case passing an ObjectName when registering entries will be mandatory. return true if the associated metadata requires entries to be registered (mibgen generated generic metadata). return registrationRequired;
protected void	removeEntry(SnmpIndex index, java.lang.Object entry) Remove an entry from this table. This method unregisters an entry from the table and performs synchronization with the associated table metadata object. param index The SnmpIndex identifying the entry. param entry The entry that should be removed in the table. This parameter is optional and can be omitted if it doesn't need to be passed along to the removeEntryCb() callback defined in the {@link com.sun.jmx.snmp.agent.SnmpTableCallbackHandler} interface. exception SnmpStatusException if the entry cannot be unregistered. SnmpOid oid = buildOidFromIndex(index); meta.removeEntry(oid,entry);
public void	removeEntryCb(int pos, com.sun.jmx.snmp.SnmpOid row, javax.management.ObjectName name, java.lang.Object entry, SnmpMibTable meta) This callback is called by the associated metadata object when a new table entry has been removed from the table metadata. This method will update the entries list. param pos The position from which the entry was deleted param row The row OID of the deleted entry param name The ObjectName of the deleted entry (may be null if ObjectName's were not required) param entry The deleted entry (may be null if only ObjectName's were required) param meta The table metadata object. try { if (entries != null) entries.remove(pos); } catch (Exception e) { }
public synchronized void	removeNotificationListener(javax.management.NotificationListener listener) Enables to remove an SNMP entry listener from this SnmpMibTable. param listener The listener object which will handle the notifications emitted by the registered MBean. This method will remove all the information related to this listener. exception ListenerNotFoundException The listener is not registered in the MBean. meta.removeNotificationListener(listener);
public void	setCreationEnabled(boolean remoteCreationFlag) This method lets you dynamically switch the creation policy. setCreationEnabled() will switch the policy of remote entry creation via SET operations, by calling setCreationEnabled() on the metadata object associated with this table. By default remote entry creation via SET operation is disabled. param remoteCreationFlag Tells whether remote entry creation must be enabled or disabled. setCreationEnabled(true) will enable remote entry creation via SET operations. setCreationEnabled(false) will disable remote entry creation via SET operations. By default remote entry creation via SET operation is disabled. see com.sun.jmx.snmp.agent.SnmpMibTable meta.setCreationEnabled(remoteCreationFlag);