netsnmpsession.html

snmp based application it is used to get the info of snmp

<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the privacy password in use</DL>
</DD>
</DL>
<HR>

<A NAME="getRcvMsgMaxSize()"><!-- --></A><H3>
getRcvMsgMaxSize</H3>
<PRE>
public long <B>getRcvMsgMaxSize</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>

<A NAME="getRetries()"><!-- --></A><H3>
getRetries</H3>
<PRE>
public int <B>getRetries</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>

<A NAME="getSecurityAuthKey()"><!-- --></A><H3>
getSecurityAuthKey</H3>
<PRE>
public byte[] <B>getSecurityAuthKey</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>

<A NAME="getSecurityAuthOID()"><!-- --></A><H3>
getSecurityAuthOID</H3>
<PRE>
public <A HREF="../../org/netsnmp/OID.html">OID</A> <B>getSecurityAuthOID</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>

<A NAME="getSecurityEngineID()"><!-- --></A><H3>
getSecurityEngineID</H3>
<PRE>
public byte[] <B>getSecurityEngineID</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>

<A NAME="getSecurityLevel()"><!-- --></A><H3>
getSecurityLevel</H3>
<PRE>
public <A HREF="../../org/netsnmp/SecurityLevel.html">SecurityLevel</A> <B>getSecurityLevel</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>

<A NAME="getSecurityModel()"><!-- --></A><H3>
getSecurityModel</H3>
<PRE>
public int <B>getSecurityModel</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>

<A NAME="getSecurityName()"><!-- --></A><H3>
getSecurityName</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>getSecurityName</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>

<A NAME="getSecurityPrivKey()"><!-- --></A><H3>
getSecurityPrivKey</H3>
<PRE>
public byte[] <B>getSecurityPrivKey</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>

<A NAME="getSecurityPrivOID()"><!-- --></A><H3>
getSecurityPrivOID</H3>
<PRE>
public <A HREF="../../org/netsnmp/OID.html">OID</A> <B>getSecurityPrivOID</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>

<A NAME="getSerializeException()"><!-- --></A><H3>
getSerializeException</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Exception.html">Exception</A> <B>getSerializeException</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>exception generated the underlying session during serialization</DL>
</DD>
</DL>
<HR>

<A NAME="getSessionHandle()"><!-- --></A><H3>
getSessionHandle</H3>
<PRE>
public long <B>getSessionHandle</B>()</PRE>
<DL>
<DD>The session handle is the native pointer to data specific to this
 session.  For debugging purposes it may be prudent to have access to it.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the session handle</DL>
</DD>
</DL>
<HR>

<A NAME="getSndMsgMaxSize()"><!-- --></A><H3>
getSndMsgMaxSize</H3>
<PRE>
public long <B>getSndMsgMaxSize</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>

<A NAME="getSnmpVersion()"><!-- --></A><H3>
getSnmpVersion</H3>
<PRE>
public <A HREF="../../org/netsnmp/SNMPVersion.html">SNMPVersion</A> <B>getSnmpVersion</B>()</PRE>
<DL>
<DD>Getter for property snmpVersion.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Value of property snmpVersion.<DT><B>See Also:</B><DD><A HREF="../../org/netsnmp/NetSNMP.html#SNMPv1"><CODE>NetSNMP.SNMPv1</CODE></A>, 
<A HREF="../../org/netsnmp/NetSNMP.html#SNMPv2c"><CODE>NetSNMP.SNMPv2c</CODE></A>, 
<A HREF="../../org/netsnmp/NetSNMP.html#SNMPv3"><CODE>NetSNMP.SNMPv3</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getTimeout()"><!-- --></A><H3>
getTimeout</H3>
<PRE>
public long <B>getTimeout</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the curreent timeout in microseconds</DL>
</DD>
</DL>
<HR>

<A NAME="getVersion()"><!-- --></A><H3>
getVersion</H3>
<PRE>
public <A HREF="../../org/netsnmp/SNMPVersion.html">SNMPVersion</A> <B>getVersion</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the SNMP protocol version in use</DL>
</DD>
</DL>
<HR>

<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
public int <B>hashCode</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a hash code that can be used for storing object in 
 hashtable</DL>
</DD>
</DL>
<HR>

<A NAME="isOpen()"><!-- --></A><H3>
isOpen</H3>
<PRE>
public boolean <B>isOpen</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if the session is open</DL>
</DD>
</DL>
<HR>

<A NAME="nativeFinalize()"><!-- --></A><H3>
nativeFinalize</H3>
<PRE>
protected void <B>nativeFinalize</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="open()"><!-- --></A><H3>
open</H3>
<PRE>
public void <B>open</B>()
          throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalStateException.html">IllegalStateException</A></PRE>
<DL>
<DD>Opens the session given the current set of properties
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalStateException.html">IllegalStateException</A></CODE> - if the peername or community name
 have not been set, or the lookup on the peer fails</DL>
</DD>
</DL>
<HR>

<A NAME="send(org.netsnmp.PDU, java.lang.Object)"><!-- --></A><H3>
send</H3>
<PRE>
public void <B>send</B>(<A HREF="../../org/netsnmp/PDU.html">PDU</A>&nbsp;thePdu,
                 <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A>&nbsp;o)
          throws <A HREF="../../org/netsnmp/NetSNMPSendError.html">NetSNMPSendError</A>,
                 <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalStateException.html">IllegalStateException</A></PRE>
<DL>
<DD>Sends the pdu to the peer
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>thePdu</CODE> - pdu to send<DD><CODE>o</CODE> - object to be passed to the SNMPEventListener when a response
 to this pdu is received.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../org/netsnmp/NetSNMPSendError.html">NetSNMPSendError</A></CODE> - if an error occurs in sending the pdu
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/IllegalStateException.html">IllegalStateException</A></CODE> - if the session is not open</DL>
</DD>
</DL>
<HR>

<A NAME="setAuthenticationProtocol(org.netsnmp.OID)"><!-- --></A><H3>
setAuthenticationProtocol</H3>
<PRE>
public void <B>setAuthenticationProtocol</B>(<A HREF="../../org/netsnmp/OID.html">OID</A>&nbsp;oid)</PRE>
<DL>
<DD>Setter for authentication protocol
 corresponds to the -a option for snmpcmd(1)
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>oid</CODE> - Identifier for the authentication protocol to use<DT><B>See Also:</B><DD><A HREF="../../org/netsnmp/NetSNMP.html#usmNoAuthOID"><CODE>NetSNMP.usmNoAuthOID</CODE></A>, 
<A HREF="../../org/netsnmp/NetSNMP.html#usmMD5AuthOID"><CODE>NetSNMP.usmMD5AuthOID</CODE></A>, 
<A HREF="../../org/netsnmp/NetSNMP.html#usmSHAAuthOID"><CODE>NetSNMP.usmSHAAuthOID</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setAuthPassword(java.lang.String)"><!-- --></A><H3>
setAuthPassword</H3>
<PRE>
public void <B>setAuthPassword</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;string)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>string</CODE> - authorization password</DL>
</DD>
</DL>
<HR>

<A NAME="setCommunity(java.lang.String)"><!-- --></A><H3>
setCommunity</H3>
<PRE>
public void <B>setCommunity</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;string)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>string</CODE> - the V1/V2c community</DL>
</DD>
</DL>
<HR>

<A NAME="setContextEngineID(byte[])"><!-- --></A><H3>
setContextEngineID</H3>
<PRE>
public void <B>setContextEngineID</B>(byte[]&nbsp;bs)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bs</CODE> - </DL>