View Javadoc
1   // NAME
2   //      $RCSfile: SnmpContextFace.java,v $
3   // DESCRIPTION
4   //      [given below in javadoc format]
5   // DELTA
6   //      $Revision: 3.13 $
7   // CREATED
8   //      $Date: 2006/02/09 14:19:05 $
9   // COPYRIGHT
10  //      Westhawk Ltd
11  // TO DO
12  //
13  
14  /*
15   * Copyright (C) 2000 - 2006 by Westhawk Ltd
16   * <a href="www.westhawk.co.uk">www.westhawk.co.uk</a>
17   *
18   * Permission to use, copy, modify, and distribute this software
19   * for any purpose and without fee is hereby granted, provided
20   * that the above copyright notices appear in all copies and that
21   * both the copyright notice and this permission notice appear in
22   * supporting documentation.
23   * This software is provided "as is" without express or implied
24   * warranty.
25   * author <a href="mailto:snmp@westhawk.co.uk">Tim Panton</a>
26   */
27  
28  package uk.co.westhawk.snmp.stack;
29  
30  /*-
31   * ╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲
32   * SNMP Java Client
33   * ჻჻჻჻჻჻
34   * Copyright 2023 MetricsHub, Westhawk
35   * ჻჻჻჻჻჻
36   * This program is free software: you can redistribute it and/or modify
37   * it under the terms of the GNU Lesser General Public License as
38   * published by the Free Software Foundation, either version 3 of the
39   * License, or (at your option) any later version.
40   *
41   * This program is distributed in the hope that it will be useful,
42   * but WITHOUT ANY WARRANTY; without even the implied warranty of
43   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
44   * GNU General Lesser Public License for more details.
45   *
46   * You should have received a copy of the GNU General Lesser Public
47   * License along with this program.  If not, see
48   * <http://www.gnu.org/licenses/lgpl-3.0.html>.
49   * ╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱
50   */
51  import uk.co.westhawk.snmp.event.*;
52  
53  /**
54   * This interface contains the (basic) SNMP context interface that is needed 
55   * by every PDU to send a SNMP v1 request. The context also
56   * provides functionality to receive incoming PDUs.
57   *
58   * @see SnmpContext
59   * @see SnmpContextv2c
60   * @see SnmpContextv3
61   *
62   * @author <a href="mailto:snmp@westhawk.co.uk">Tim Panton</a>
63   * @version $Revision: 3.13 $ $Date: 2006/02/09 14:19:05 $
64   */
65  public interface SnmpContextFace extends SnmpContextBasisFace {
66      static final String version_id = "@(#)$Id: SnmpContextFace.java,v 3.13 2006/02/09 14:19:05 birgit Exp $ Copyright Westhawk Ltd";
67  
68      /**
69       * The default community name. This is <em>public</em>.
70       */
71      public final static String DEFAULT_COMMUNITY = "public";
72  
73      /**
74       * Returns the community name.
75       */
76      public String getCommunity();
77  
78      /**
79       * Sets the community name.
80       * This community name will be used for all PDUs sent with this context.
81       * The default community name is <em>public</em>.
82       *
83       * @see #DEFAULT_COMMUNITY
84       */
85      public void setCommunity(String newCommunity);
86  
87  }