org.opennms.netmgt.xml.eventconf

Class Security

java.lang.Object

org.opennms.netmgt.xml.eventconf.Security

All Implemented Interfaces:

Serializable

public class Security
extends Object
implements Serializable

Security settings for this configuration

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Security()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDoNotOverride(int index, String vDoNotOverride)
void	addDoNotOverride(String vDoNotOverride)
Enumeration<String>	enumerateDoNotOverride() Method enumerateDoNotOverride.
boolean	equals(Object obj) Overrides the Object.equals method.
String[]	getDoNotOverride() Method getDoNotOverride.Returns the contents of the collection in an Array.
String	getDoNotOverride(int index) Method getDoNotOverride.
List<String>	getDoNotOverrideCollection() Method getDoNotOverrideCollection.Returns a reference to '_doNotOverrideList'.
int	getDoNotOverrideCount() Method getDoNotOverrideCount.
int	hashCode() Overrides the Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<String>	iterateDoNotOverride() Method iterateDoNotOverride.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllDoNotOverride()
boolean	removeDoNotOverride(String vDoNotOverride) Method removeDoNotOverride.
String	removeDoNotOverrideAt(int index) Method removeDoNotOverrideAt.
void	setDoNotOverride(int index, String vDoNotOverride)
void	setDoNotOverride(List<String> vDoNotOverrideList) Sets the value of '_doNotOverrideList' by copying the given Vector.
void	setDoNotOverride(String[] vDoNotOverrideArray)
void	setDoNotOverrideCollection(List<String> doNotOverrideList) Deprecated.
static Security	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

Security

public Security()

Method Detail

addDoNotOverride

public void addDoNotOverride(String vDoNotOverride)
                      throws IndexOutOfBoundsException

Parameters:

vDoNotOverride -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addDoNotOverride

public void addDoNotOverride(int index,
                    String vDoNotOverride)
                      throws IndexOutOfBoundsException

Parameters:

index -

vDoNotOverride -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateDoNotOverride

public Enumeration<String> enumerateDoNotOverride()

Method enumerateDoNotOverride.

Returns:

an Enumeration over all possible elements of this collection

equals

public boolean equals(Object obj)

Overrides the Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getDoNotOverride

public String getDoNotOverride(int index)
                        throws IndexOutOfBoundsException

Method getDoNotOverride.

Parameters:

index -

Returns:

the value of the String at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getDoNotOverride

public String[] getDoNotOverride()

Method getDoNotOverride.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getDoNotOverrideCollection

public List<String> getDoNotOverrideCollection()

Method getDoNotOverrideCollection.Returns a reference to '_doNotOverrideList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getDoNotOverrideCount

public int getDoNotOverrideCount()

Method getDoNotOverrideCount.

Returns:

the size of this collection

hashCode

public int hashCode()

Overrides the 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

iterateDoNotOverride

public Iterator<String> iterateDoNotOverride()

Method iterateDoNotOverride.

Returns:

an Iterator over all possible elements in this collection

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

removeAllDoNotOverride

public void removeAllDoNotOverride()

removeDoNotOverride

public boolean removeDoNotOverride(String vDoNotOverride)

Method removeDoNotOverride.

Parameters:

vDoNotOverride -

Returns:

true if the object was removed from the collection.

removeDoNotOverrideAt

public String removeDoNotOverrideAt(int index)

Method removeDoNotOverrideAt.

Parameters:

index -

Returns:

the element removed from the collection

setDoNotOverride

public void setDoNotOverride(int index,
                    String vDoNotOverride)
                      throws IndexOutOfBoundsException

Parameters:

index -

vDoNotOverride -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setDoNotOverride

public void setDoNotOverride(String[] vDoNotOverrideArray)

Parameters:

vDoNotOverrideArray -

setDoNotOverride

public void setDoNotOverride(List<String> vDoNotOverrideList)

Sets the value of '_doNotOverrideList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vDoNotOverrideList - the Vector to copy.

setDoNotOverrideCollection

public void setDoNotOverrideCollection(List<String> doNotOverrideList)

Deprecated.

Sets the value of '_doNotOverrideList' by setting it to the given Vector. No type checking is performed.

Parameters:

doNotOverrideList - the Vector to set.

unmarshal

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

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.xml.eventconf.Security

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