| java.lang.Object
 org.snmp4j.security.UsmUser
| UsmUser | | public class UsmUser implements User,Comparable,Cloneable(Code) | | The UsmUser 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.
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 |
| Constructor Summary | |
| public | UsmUser(OctetString securityName, OID authenticationProtocol, OctetString authenticationPassphrase, OID privacyProtocol, OctetString privacyPassphrase)
Creates a USM user.
Parameters:
securityName - the security name of the user (typically the user name).
Parameters:
authenticationProtocol - the authentication protcol ID to be associated with this user. | | public | UsmUser(OctetString securityName, OID authenticationProtocol, OctetString authenticationPassphrase, OID privacyProtocol, OctetString privacyPassphrase, OctetString localizationEngineID)
Creates a localized USM user.
Parameters:
securityName - the security name of the user (typically the user name).
Parameters:
authenticationProtocol - the authentication protcol ID to be associated with this user. |
| UsmUser | | public UsmUser(OctetString securityName, OID authenticationProtocol, OctetString authenticationPassphrase, OID privacyProtocol, OctetString privacyPassphrase)(Code) | | Creates a USM user.
Parameters:
securityName - the security name of the user (typically the user name).
Parameters:
authenticationProtocol - the authentication protcol ID to be associated with this user. If setto null, this user only supports unauthenticated messages.
Parameters:
authenticationPassphrase - the authentication passphrase. If not null,authenticationProtocol must also be not null.RFC3414 §11.2 requires passphrases to have a minimum length of 8 bytes.If the length of authenticationPassphrase is less than 8bytes an IllegalArgumentException is thrown.
Parameters:
privacyProtocol - the privacy protcol ID to be associated with this user. If setto null, this user only supports unencrypted messages.
Parameters:
privacyPassphrase - the privacy passphrase. If not null,privacyProtocol must also be not null.RFC3414 §11.2 requires passphrases to have a minimum length of 8 bytes.If the length of authenticationPassphrase is less than 8bytes an IllegalArgumentException is thrown. |
| UsmUser | | public UsmUser(OctetString securityName, OID authenticationProtocol, OctetString authenticationPassphrase, OID privacyProtocol, OctetString privacyPassphrase, OctetString localizationEngineID)(Code) | | Creates a localized USM user.
Parameters:
securityName - the security name of the user (typically the user name).
Parameters:
authenticationProtocol - the authentication protcol ID to be associated with this user. If setto null, this user only supports unauthenticated messages.
Parameters:
authenticationPassphrase - the authentication passphrase. If not null,authenticationProtocol must also be not null.RFC3414 §11.2 requires passphrases to have a minimum length of 8 bytes.If the length of authenticationPassphrase is less than 8bytes an IllegalArgumentException is thrown.
Parameters:
privacyProtocol - the privacy protcol ID to be associated with this user. If setto null, this user only supports unencrypted messages.
Parameters:
privacyPassphrase - the privacy passphrase. If not null,privacyProtocol must also be not null.RFC3414 §11.2 requires passphrases to have a minimum length of 8 bytes.If the length of authenticationPassphrase is less than 8bytes an IllegalArgumentException is thrown.
Parameters:
localizationEngineID - if not null, the localizationEngineID specifies theengine ID for which the supplied passphrases are already localized.Such an USM user can only be used with the target whose engine IDequals localizationEngineID. |
| compareTo | | public int compareTo(Object o)(Code) | | Compares two USM users by their security names.
Parameters:
o - another UsmUser instance.a negative integer, zero, or a positive integer as this object isless than, equal to, or greater than the specified object. |
| getAuthenticationPassphrase | | public OctetString getAuthenticationPassphrase()(Code) | | Gets the authentication passphrase.
a clone of the authentication passphrase or null. |
| getAuthenticationProtocol | | public OID getAuthenticationProtocol()(Code) | | Gets the authentication protocol ID.
a clone of the authentication protocol ID or null. |
| getLocalizationEngineID | | public OctetString getLocalizationEngineID()(Code) | | Returns the localization engine ID for which this USM user has been already
localized.
null if this USM user is not localized or the SNMP engineID of the target for which this user has been localized.
since:
1.6 |
| getPrivacyPassphrase | | public OctetString getPrivacyPassphrase()(Code) | | Gets the privacy passphrase.
a clone of the privacy passphrase or null. |
| getPrivacyProtocol | | public OID getPrivacyProtocol()(Code) | | Gets the privacy protocol ID.
a clone of the privacy protocol ID or null. |
| getSecurityModel | | public int getSecurityModel()(Code) | | Gets the security model ID of the USM.
USM.getID |
| getSecurityName | | public OctetString getSecurityName()(Code) | | Gets the user's security name.
a clone of the user's security name. |
| isLocalized | | public boolean isLocalized()(Code) | | Indicates whether the passphrases of this USM user need to be localized
or not (true is returned in that case).
true if the passphrases of this USM user representlocalized keys.
since:
1.6 |
|
|