org.opennms.netmgt.config.trapd

Class Snmpv3User

java.lang.Object

org.opennms.netmgt.config.trapd.Snmpv3User

All Implemented Interfaces:

Serializable

public class Snmpv3User
extends Object
implements Serializable

SNMPv3 User Configuration.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Snmpv3User()

Method Summary

Modifier and Type	Method and Description
void	deleteSecurityLevel()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getAuthPassphrase() Returns the value of field 'authPassphrase'.
String	getAuthProtocol() Returns the value of field 'authProtocol'.
String	getEngineId() Returns the value of field 'engineId'.
String	getPrivacyPassphrase() Returns the value of field 'privacyPassphrase'.
String	getPrivacyProtocol() Returns the value of field 'privacyProtocol'.
int	getSecurityLevel() Returns the value of field 'securityLevel'.
String	getSecurityName() Returns the value of field 'securityName'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasSecurityLevel() Method hasSecurityLevel.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setAuthPassphrase(String authPassphrase) Sets the value of field 'authPassphrase'.
void	setAuthProtocol(String authProtocol) Sets the value of field 'authProtocol'.
void	setEngineId(String engineId) Sets the value of field 'engineId'.
void	setPrivacyPassphrase(String privacyPassphrase) Sets the value of field 'privacyPassphrase'.
void	setPrivacyProtocol(String privacyProtocol) Sets the value of field 'privacyProtocol'.
void	setSecurityLevel(int securityLevel) Sets the value of field 'securityLevel'.
void	setSecurityName(String securityName) Sets the value of field 'securityName'.
static Snmpv3User	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Snmpv3User

public Snmpv3User()

Method Detail

deleteSecurityLevel

public void deleteSecurityLevel()

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getAuthPassphrase

public String getAuthPassphrase()

Returns the value of field 'authPassphrase'. The field 'authPassphrase' has the following description: SNMPv3 Authentication Password Phrase

Returns:

the value of field 'AuthPassphrase'.

getAuthProtocol

public String getAuthProtocol()

Returns the value of field 'authProtocol'. The field 'authProtocol' has the following description: SNMPv3 Authentication Protocol

Returns:

the value of field 'AuthProtocol'.

getEngineId

public String getEngineId()

Returns the value of field 'engineId'. The field 'engineId' has the following description: SNMPv3 Application Engine ID

Returns:

the value of field 'EngineId'.

getPrivacyPassphrase

public String getPrivacyPassphrase()

Returns the value of field 'privacyPassphrase'. The field 'privacyPassphrase' has the following description: SNMPv3 Privacy Password Phrase

Returns:

the value of field 'PrivacyPassphrase'.

getPrivacyProtocol

public String getPrivacyProtocol()

Returns the value of field 'privacyProtocol'. The field 'privacyProtocol' has the following description: SNMPv3 Privacy Protocol

Returns:

the value of field 'PrivacyProtocol'.

getSecurityLevel

public int getSecurityLevel()

Returns the value of field 'securityLevel'. The field 'securityLevel' has the following description: SNMPv3 Security Level (noAuthNoPriv, authNoPriv, authPriv)

Returns:

the value of field 'SecurityLevel'.

getSecurityName

public String getSecurityName()

Returns the value of field 'securityName'. The field 'securityName' has the following description: SNMPv3 Security Name (User Name)

Returns:

the value of field 'SecurityName'.

hasSecurityLevel

public boolean hasSecurityLevel()

Method hasSecurityLevel.

Returns:

true if at least one SecurityLevel has been added

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

setAuthPassphrase

public void setAuthPassphrase(String authPassphrase)

Sets the value of field 'authPassphrase'. The field 'authPassphrase' has the following description: SNMPv3 Authentication Password Phrase

Parameters:

authPassphrase - the value of field 'authPassphrase'.

setAuthProtocol

public void setAuthProtocol(String authProtocol)

Sets the value of field 'authProtocol'. The field 'authProtocol' has the following description: SNMPv3 Authentication Protocol

Parameters:

authProtocol - the value of field 'authProtocol'.

setEngineId

public void setEngineId(String engineId)

Sets the value of field 'engineId'. The field 'engineId' has the following description: SNMPv3 Application Engine ID

Parameters:

engineId - the value of field 'engineId'.

setPrivacyPassphrase

public void setPrivacyPassphrase(String privacyPassphrase)

Sets the value of field 'privacyPassphrase'. The field 'privacyPassphrase' has the following description: SNMPv3 Privacy Password Phrase

Parameters:

privacyPassphrase - the value of field 'privacyPassphrase'.

setPrivacyProtocol

public void setPrivacyProtocol(String privacyProtocol)

Sets the value of field 'privacyProtocol'. The field 'privacyProtocol' has the following description: SNMPv3 Privacy Protocol

Parameters:

privacyProtocol - the value of field 'privacyProtocol'.

setSecurityLevel

public void setSecurityLevel(int securityLevel)

Sets the value of field 'securityLevel'. The field 'securityLevel' has the following description: SNMPv3 Security Level (noAuthNoPriv, authNoPriv, authPriv)

Parameters:

securityLevel - the value of field 'securityLevel'.

setSecurityName

public void setSecurityName(String securityName)

Sets the value of field 'securityName'. The field 'securityName' has the following description: SNMPv3 Security Name (User Name)

Parameters:

securityName - the value of field 'securityName'.

unmarshal

public static Snmpv3User unmarshal(Reader reader)
                            throws org.exolab.castor.xml.MarshalException,
                                   org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.trapd.Snmpv3User

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema