org.opennms.netmgt.config.server

Class LocalServer

java.lang.Object

org.opennms.netmgt.config.server.LocalServer

All Implemented Interfaces:

Serializable

public class LocalServer
extends Object
implements Serializable

Top-level element for the opennms-server.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocalServer()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteDefaultCriticalPathRetries()
void	deleteDefaultCriticalPathTimeout()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getDefaultCriticalPathIp() Returns the value of field 'defaultCriticalPathIp'.
int	getDefaultCriticalPathRetries() Returns the value of field 'defaultCriticalPathRetries'.
String	getDefaultCriticalPathService() Returns the value of field 'defaultCriticalPathService'.
int	getDefaultCriticalPathTimeout() Returns the value of field 'defaultCriticalPathTimeout'.
String	getServerName() Returns the value of field 'serverName'.
String	getVerifyServer() Returns the value of field 'verifyServer'.
boolean	hasDefaultCriticalPathRetries() Method hasDefaultCriticalPathRetries.
boolean	hasDefaultCriticalPathTimeout() Method hasDefaultCriticalPathTimeout.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setDefaultCriticalPathIp(String defaultCriticalPathIp) Sets the value of field 'defaultCriticalPathIp'.
void	setDefaultCriticalPathRetries(int defaultCriticalPathRetries) Sets the value of field 'defaultCriticalPathRetries'.
void	setDefaultCriticalPathService(String defaultCriticalPathService) Sets the value of field 'defaultCriticalPathService'.
void	setDefaultCriticalPathTimeout(int defaultCriticalPathTimeout) Sets the value of field 'defaultCriticalPathTimeout'.
void	setServerName(String serverName) Sets the value of field 'serverName'.
void	setVerifyServer(String verifyServer) Sets the value of field 'verifyServer'.
static LocalServer	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

LocalServer

public LocalServer()

Method Detail

deleteDefaultCriticalPathRetries

public void deleteDefaultCriticalPathRetries()

deleteDefaultCriticalPathTimeout

public void deleteDefaultCriticalPathTimeout()

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.

getDefaultCriticalPathIp

public String getDefaultCriticalPathIp()

Returns the value of field 'defaultCriticalPathIp'.

Returns:

the value of field 'DefaultCriticalPathIp'.

getDefaultCriticalPathRetries

public int getDefaultCriticalPathRetries()

Returns the value of field 'defaultCriticalPathRetries'.

Returns:

the value of field 'DefaultCriticalPathRetries'.

getDefaultCriticalPathService

public String getDefaultCriticalPathService()

Returns the value of field 'defaultCriticalPathService'.

Returns:

the value of field 'DefaultCriticalPathService'.

getDefaultCriticalPathTimeout

public int getDefaultCriticalPathTimeout()

Returns the value of field 'defaultCriticalPathTimeout'.

Returns:

the value of field 'DefaultCriticalPathTimeout'.

getServerName

public String getServerName()

Returns the value of field 'serverName'.

Returns:

the value of field 'ServerName'.

getVerifyServer

public String getVerifyServer()

Returns the value of field 'verifyServer'. The field 'verifyServer' has the following description: A flag to indicate if poller has to identify the nms server to restrict services to poll.

Returns:

the value of field 'VerifyServer'.

hasDefaultCriticalPathRetries

public boolean hasDefaultCriticalPathRetries()

Method hasDefaultCriticalPathRetries.

Returns:

true if at least one DefaultCriticalPathRetries has been added

hasDefaultCriticalPathTimeout

public boolean hasDefaultCriticalPathTimeout()

Method hasDefaultCriticalPathTimeout.

Returns:

true if at least one DefaultCriticalPathTimeout 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

setDefaultCriticalPathIp

public void setDefaultCriticalPathIp(String defaultCriticalPathIp)

Sets the value of field 'defaultCriticalPathIp'.

Parameters:

defaultCriticalPathIp - the value of field 'defaultCriticalPathIp'.

setDefaultCriticalPathRetries

public void setDefaultCriticalPathRetries(int defaultCriticalPathRetries)

Sets the value of field 'defaultCriticalPathRetries'.

Parameters:

defaultCriticalPathRetries - the value of field 'defaultCriticalPathRetries'.

setDefaultCriticalPathService

public void setDefaultCriticalPathService(String defaultCriticalPathService)

Sets the value of field 'defaultCriticalPathService'.

Parameters:

defaultCriticalPathService - the value of field 'defaultCriticalPathService'.

setDefaultCriticalPathTimeout

public void setDefaultCriticalPathTimeout(int defaultCriticalPathTimeout)

Sets the value of field 'defaultCriticalPathTimeout'.

Parameters:

defaultCriticalPathTimeout - the value of field 'defaultCriticalPathTimeout'.

setServerName

public void setServerName(String serverName)

Sets the value of field 'serverName'.

Parameters:

serverName - the value of field 'serverName'.

setVerifyServer

public void setVerifyServer(String verifyServer)

Sets the value of field 'verifyServer'. The field 'verifyServer' has the following description: A flag to indicate if poller has to identify the nms server to restrict services to poll.

Parameters:

verifyServer - the value of field 'verifyServer'.

unmarshal

public static LocalServer 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.server.LocalServer

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