usmuser.java

snmp4j 1.8.2版 The org.snmp4j classes are capable of creating, sending, and receiving SNMPv1/v2c/v3

/*_############################################################################
  _## 
  _##  SNMP4J - UsmUser.java  
  _## 
  _##  Copyright 2003-2007  Frank Fock and Jochen Katz (SNMP4J.org)
  _##  
  _##  Licensed under the Apache License, Version 2.0 (the "License");
  _##  you may not use this file except in compliance with the License.
  _##  You may obtain a copy of the License at
  _##  
  _##      http://www.apache.org/licenses/LICENSE-2.0
  _##  
  _##  Unless required by applicable law or agreed to in writing, software
  _##  distributed under the License is distributed on an "AS IS" BASIS,
  _##  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  _##  See the License for the specific language governing permissions and
  _##  limitations under the License.
  _##  
  _##########################################################################*/

package org.snmp4j.security;

import org.snmp4j.User;
import org.snmp4j.smi.OctetString;
import org.snmp4j.smi.OID;

/**
 * The <code>UsmUser</code> class represents USM user providing information
 * to secure SNMPv3 message exchange. A user is characterized by its security
 * name and optionally by a authentication protocol and passphrase as well as
 * a privacy protocol and passphrase.
 * <p>
 * There are no mutators for the attributes of this class, to prevent
 * inconsistent states in the USM, when a user is changed from outside.
 *
 * @author Frank Fock
 * @version 1.6
 */
public class UsmUser implements User, Comparable, Cloneable {

  private static final long serialVersionUID = -2258973598142206767L;

  private OctetString securityName;
  private OctetString authenticationPassphrase;
  private OctetString privacyPassphrase;
  private OID authenticationProtocol;
  private OID privacyProtocol;
  private OctetString localizationEngineID;

  /**
   * Creates a USM user.
   * @param securityName
   *    the security name of the user (typically the user name).
   * @param authenticationProtocol
   *    the authentication protcol ID to be associated with this user. If set
   *    to <code>null</code>, this user only supports unauthenticated messages.
   * @param authenticationPassphrase
   *    the authentication passphrase. If not <code>null</code>,
   *    <code>authenticationProtocol</code> must also be not <code>null</code>.
   *    RFC3414