org.opennms.netmgt.config.users
Class Userinfo

java.lang.Object
  org.opennms.netmgt.config.users.Userinfo

All Implemented Interfaces:

Serializable

public class Userinfo
extends Object
implements Serializable

The top-level element of the users.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Userinfo()

Method Summary

Header	getHeader() Returns the value of field 'header'.
Users	getUsers() Returns the value of field 'users'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setHeader(Header header) Sets the value of field 'header'.
void	setUsers(Users users) Sets the value of field 'users'.
static Userinfo	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Userinfo

public Userinfo()

Method Detail

getHeader

public Header getHeader()

Returns the value of field 'header'. The field 'header' has the following description: Header containing information about this configuration file.

Returns:

the value of field 'Header'.

getUsers

public Users getUsers()

Returns the value of field 'users'.

Returns:

the value of field 'Users'.

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

setHeader

public void setHeader(Header header)

Sets the value of field 'header'. The field 'header' has the following description: Header containing information about this configuration file.

Parameters:

header - the value of field 'header'.

setUsers

public void setUsers(Users users)

Sets the value of field 'users'.

Parameters:

users - the value of field 'users'.

unmarshal

public static Userinfo 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.users.Userinfo

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