snmpv1communicationinterface.html

snmp inquistor Pour la communication avec les agents SNMP on utilise un package Java open source

<A NAME="getNextMIBEntry(java.lang.String)"><!-- --></A><H3>
getNextMIBEntry</H3>
<PRE>
public <A HREF="../snmp/SNMPVarBindList.html" title="class in snmp">SNMPVarBindList</A> <B>getNextMIBEntry</B>(java.lang.String&nbsp;itemID)
                                throws java.io.IOException,
                                       <A HREF="../snmp/SNMPBadValueException.html" title="class in snmp">SNMPBadValueException</A>,
                                       <A HREF="../snmp/SNMPGetException.html" title="class in snmp">SNMPGetException</A></PRE>
<DL>
<DD>Retrieve the MIB variable value corresponding to the object identifier following that
    given in itemID (in dotted-integer notation). Return as SNMPVarBindList object; if no
    such variable (either due to device not supporting it, or community name having incorrect
    access privilege), variable value will be SNMPNull object
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - Thrown when timeout experienced while waiting for response to request.
<DD><CODE><A HREF="../snmp/SNMPBadValueException.html" title="class in snmp">SNMPBadValueException</A></CODE>
<DD><CODE><A HREF="../snmp/SNMPGetException.html" title="class in snmp">SNMPGetException</A></CODE> - Thrown if one the OID following the supplied OID has value that can't be retrieved</DL>
</DD>
</DL>
<HR>

<A NAME="getNextMIBEntry(java.lang.String[])"><!-- --></A><H3>
getNextMIBEntry</H3>
<PRE>
public <A HREF="../snmp/SNMPVarBindList.html" title="class in snmp">SNMPVarBindList</A> <B>getNextMIBEntry</B>(java.lang.String[]&nbsp;itemID)
                                throws java.io.IOException,
                                       <A HREF="../snmp/SNMPBadValueException.html" title="class in snmp">SNMPBadValueException</A>,
                                       <A HREF="../snmp/SNMPGetException.html" title="class in snmp">SNMPGetException</A></PRE>
<DL>
<DD>Retrieve the MIB variable value corresponding to the object identifiers following those
    given in the itemID array (in dotted-integer notation). Return as SNMPVarBindList object; 
    if no such variable (either due to device not supporting it, or community name having 
    incorrect access privilege), SNMPGetException thrown
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - Thrown when timeout experienced while waiting for response to request.
<DD><CODE><A HREF="../snmp/SNMPBadValueException.html" title="class in snmp">SNMPBadValueException</A></CODE>
<DD><CODE><A HREF="../snmp/SNMPGetException.html" title="class in snmp">SNMPGetException</A></CODE> - Thrown if OID following one of supplied OIDs has value that can't be retrieved</DL>
</DD>
</DL>
<HR>

<A NAME="setMIBEntry(java.lang.String, snmp.SNMPObject)"><!-- --></A><H3>
setMIBEntry</H3>
<PRE>
public <A HREF="../snmp/SNMPVarBindList.html" title="class in snmp">SNMPVarBindList</A> <B>setMIBEntry</B>(java.lang.String&nbsp;itemID,
                                   <A HREF="../snmp/SNMPObject.html" title="class in snmp">SNMPObject</A>&nbsp;newValue)
                            throws java.io.IOException,
                                   <A HREF="../snmp/SNMPBadValueException.html" title="class in snmp">SNMPBadValueException</A>,
                                   <A HREF="../snmp/SNMPSetException.html" title="class in snmp">SNMPSetException</A></PRE>
<DL>
<DD>Set the MIB variable value of the object identifier
    given in startID (in dotted-integer notation). Return SNMPVarBindList object returned
    by device in its response; can be used to check that setting was successful.
    Uses SNMPGetNextRequests to retrieve variable values in sequence.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - Thrown when timeout experienced while waiting for response to request.
<DD><CODE><A HREF="../snmp/SNMPBadValueException.html" title="class in snmp">SNMPBadValueException</A></CODE>
<DD><CODE><A HREF="../snmp/SNMPSetException.html" title="class in snmp">SNMPSetException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setMIBEntry(java.lang.String[], snmp.SNMPObject[])"><!-- --></A><H3>
setMIBEntry</H3>
<PRE>
public <A HREF="../snmp/SNMPVarBindList.html" title="class in snmp">SNMPVarBindList</A> <B>setMIBEntry</B>(java.lang.String[]&nbsp;itemID,
                                   <A HREF="../snmp/SNMPObject.html" title="class in snmp">SNMPObject</A>[]&nbsp;newValue)
                            throws java.io.IOException,
                                   <A HREF="../snmp/SNMPBadValueException.html" title="class in snmp">SNMPBadValueException</A>,
                                   <A HREF="../snmp/SNMPSetException.html" title="class in snmp">SNMPSetException</A></PRE>
<DL>
<DD>Set the MIB variable values of the supplied object identifiers given in the 
    itemID array (in dotted-integer notation). Return SNMPVarBindList returned
    by device in its response; can be used to check that setting was successful.
    Uses SNMPGetNextRequests to retrieve variable values in sequence.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - Thrown when timeout experienced while waiting for response to request.
<DD><CODE><A HREF="../snmp/SNMPBadValueException.html" title="class in snmp">SNMPBadValueException</A></CODE>
<DD><CODE><A HREF="../snmp/SNMPSetException.html" title="class in snmp">SNMPSetException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="retrieveMIBTable(java.lang.String)"><!-- --></A><H3>
retrieveMIBTable</H3>
<PRE>
public <A HREF="../snmp/SNMPVarBindList.html" title="class in snmp">SNMPVarBindList</A> <B>retrieveMIBTable</B>(java.lang.String&nbsp;baseID)
                                 throws java.io.IOException,
                                        <A HREF="../snmp/SNMPBadValueException.html" title="class in snmp">SNMPBadValueException</A>,
                                        <A HREF="../snmp/SNMPGetException.html" title="class in snmp">SNMPGetException</A></PRE>
<DL>
<DD>Retrieve all MIB variable values whose OIDs start with the supplied baseID. Since the entries of
   an SNMP table have the form  <baseID>.<tableEntry>.<index>, this will retrieve all of the table 
   data as an SNMPVarBindList object consisting of sequence of SNMPVariablePairs.
    Uses SNMPGetNextRequests to retrieve variable values in sequence.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - Thrown when timeout experienced while waiting for response to request.
<DD><CODE><A HREF="../snmp/SNMPBadValueException.html" title="class in snmp">SNMPBadValueException</A></CODE>
<DD><CODE><A HREF="../snmp/SNMPGetException.html" title="class in snmp">SNMPGetException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="retrieveMIBTable(java.lang.String[])"><!-- --></A><H3>
retrieveMIBTable</H3>
<PRE>
public <A HREF="../snmp/SNMPVarBindList.html" title="class in snmp">SNMPVarBindList</A> <B>retrieveMIBTable</B>(java.lang.String[]&nbsp;baseID)
                                 throws java.io.IOException,
                                        <A HREF="../snmp/SNMPBadValueException.html" title="class in snmp">SNMPBadValueException</A>,
                                        <A HREF="../snmp/SNMPGetException.html" title="class in snmp">SNMPGetException</A></PRE>
<DL>
<DD>Retrieve all MIB variable values whose OIDs start with the supplied baseIDs. The normal way for
   this to be used is for the base OID array to consist of the base OIDs of the columns of a table.
   This method will then retrieve all of the entries of the table corresponding to these columns, one 
   row at a time (i.e., the entries for each row will be retrieved in a single SNMP request). This 
   will retrieve the table data as an SNMPVarBindList object consisting of sequence of SNMPVariablePairs,
   with the entries for each row grouped together. This may provide a more convenient arrangement of
   the table data than the simpler retrieveMIBTable method taking a single OID as argument; in addition,
   it's more efficient, requiring one SNMP request per row rather than one request per entry.
    Uses SNMPGetNextRequests to retrieve variable values for each row in sequence.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - Thrown when timeout experienced while waiting for response to request.
<DD><CODE><A HREF="../snmp/SNMPBadValueException.html" title="class in snmp">SNMPBadValueException</A></CODE>
<DD><CODE><A HREF="../snmp/SNMPGetException.html" title="class in snmp">SNMPGetException</A></CODE> - Thrown if incomplete row retrieved</DL>
</DD>
</DL>
<HR>

<A NAME="setReceiveBufferSize(int)"><!-- --></A><H3>
setReceiveBufferSize</H3>
<PRE>
public void <B>setReceiveBufferSize</B>(int&nbsp;receiveBufferSize)</PRE>
<DL>
<DD>Set the size of the buffer used to receive response packets. RFC 1157 stipulates that an SNMP
   implementation must be able to receive packets of at least 484 bytes, so if you try to set the
   size to a value less than this, the receive buffer size will be set to 484 bytes. In addition,
   the maximum size of a UDP packet payload is 65535 bytes, so setting the buffer to a larger size
   will just waste memory. The default value is 512 bytes. The value may need to be increased if
   get-requests are issued for multiple OIDs.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getReceiveBufferSize()"><!-- --></A><H3>
getReceiveBufferSize</H3>
<PRE>
public int <B>getReceiveBufferSize</B>()</PRE>
<DL>
<DD>Returns the current size of the buffer used to receive response packets.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SNMPv1CommunicationInterface.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../snmp/SNMPv1AgentInterface.html" title="class in snmp"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../snmp/SNMPv1TrapListener.html" title="interface in snmp"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../index.html?snmp/SNMPv1CommunicationInterface.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="SNMPv1CommunicationInterface.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>