KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > jmx > snmp > SnmpScopedPduPacket


1 /*
2  * @(#)file SnmpScopedPduPacket.java
3  * @(#)author Sun Microsystems, Inc.
4  * @(#)version 1.17
5  * @(#)date 08/02/09
6  *
7  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
8  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
9  *
10  */
11
12 package com.sun.jmx.snmp;
13
14 import java.io.Serializable JavaDoc;
15
16 import com.sun.jmx.snmp.SnmpSecurityParameters;
17
18 import com.sun.jmx.snmp.SnmpDefinitions;
19 /**
20  * Is the fully decoded representation of an SNMP V3 packet.
21  * <P>
22  *
23  * Classes are derived from <CODE>SnmpPdu</CODE> to
24  * represent the different forms of SNMP pdu
25  * ({@link com.sun.jmx.snmp.SnmpScopedPduRequest SnmpScopedPduRequest},
26  * {@link com.sun.jmx.snmp.SnmpScopedPduBulk SnmpScopedPduBulk}).
27  * <BR>The <CODE>SnmpScopedPduPacket</CODE> class defines the attributes
28  * common to every scoped SNMP packets.
29  *
30  * <p><b>This API is a Sun Microsystems internal API and is subject
31  * to change without notice.</b></p>
32  * @see SnmpV3Message
33  *
34  * @since 1.5
35  */
36 public abstract class SnmpScopedPduPacket extends SnmpPdu
37     implements Serializable JavaDoc {
38     /**
39      * Message max size the pdu sender can deal with.
40      */
41     public int msgMaxSize = 0;
42
43     /**
44      * Message identifier.
45      */
46     public int msgId = 0;
47
48     /**
49      * Message flags. Reportable flag and security level.</P>
50      *<PRE>
51      * -- .... ...1 authFlag
52      * -- .... ..1. privFlag
53      * -- .... .1.. reportableFlag
54      * -- Please observe:
55      * -- .... ..00 is OK, means noAuthNoPriv
56      * -- .... ..01 is OK, means authNoPriv
57      * -- .... ..10 reserved, must NOT be used.
58      * -- .... ..11 is OK, means authPriv
59      *</PRE>
60      */
61     public byte msgFlags = 0;
62
63     /**
64      * The security model the security sub system MUST use in order to deal with this pdu (eg: User based Security Model Id = 3).
65      */
66     public int msgSecurityModel = 0;
67
68     /**
69      * The context engine Id in which the pdu must be handled (Generaly the local engine Id).
70      */
71     public byte[] contextEngineId = null;
72
73     /**
74      * The context name in which the OID have to be interpreted.
75      */
76     public byte[] contextName = null;
77
78     /**
79      * The security parameters. This is an opaque member that is
80      * interpreted by the concerned security model.
81      */
82     public SnmpSecurityParameters securityParameters = null;
83
84     /**
85      * Constructor. Is only called by a son. Set the version to <CODE>SnmpDefinitions.snmpVersionThree</CODE>.
86      */
87     protected SnmpScopedPduPacket() {
88     version = SnmpDefinitions.snmpVersionThree;
89     }
90 }
91
92
Popular Tags