org.exolab.jms.config
Class GarbageCollectionConfiguration

java.lang.Object
  |
  +--org.exolab.jms.config.GarbageCollectionConfiguration

All Implemented Interfaces:

java.io.Serializable

public class GarbageCollectionConfiguration

extends java.lang.Object

implements java.io.Serializable

This element defines items specific to the garbage collection service.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

GarbageCollectionConfiguration()

Method Summary

void	deleteGarbageCollectionInterval() Method deleteGarbageCollectionInterval
void	deleteGarbageCollectionThreadPriority() Method deleteGarbageCollectionThreadPriority
void	deleteLowWaterThreshold() Method deleteLowWaterThreshold
void	deleteMemoryCheckInterval() Method deleteMemoryCheckInterval
int	getGarbageCollectionInterval() Returns the value of field 'garbageCollectionInterval'.
int	getGarbageCollectionThreadPriority() Returns the value of field 'garbageCollectionThreadPriority'.
int	getLowWaterThreshold() Returns the value of field 'lowWaterThreshold'.
int	getMemoryCheckInterval() Returns the value of field 'memoryCheckInterval'.
boolean	hasGarbageCollectionInterval() Method hasGarbageCollectionInterval
boolean	hasGarbageCollectionThreadPriority() Method hasGarbageCollectionThreadPriority
boolean	hasLowWaterThreshold() Method hasLowWaterThreshold
boolean	hasMemoryCheckInterval() Method hasMemoryCheckInterval
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setGarbageCollectionInterval(int garbageCollectionInterval) Sets the value of field 'garbageCollectionInterval'.
void	setGarbageCollectionThreadPriority(int garbageCollectionThreadPriority) Sets the value of field 'garbageCollectionThreadPriority'.
void	setLowWaterThreshold(int lowWaterThreshold) Sets the value of field 'lowWaterThreshold'.
void	setMemoryCheckInterval(int memoryCheckInterval) Sets the value of field 'memoryCheckInterval'.
static GarbageCollectionConfiguration	unmarshal(java.io.Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

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

Constructor Detail

GarbageCollectionConfiguration

public GarbageCollectionConfiguration()

Method Detail

deleteGarbageCollectionInterval

public void deleteGarbageCollectionInterval()

Method deleteGarbageCollectionInterval

deleteGarbageCollectionThreadPriority

public void deleteGarbageCollectionThreadPriority()

Method deleteGarbageCollectionThreadPriority

deleteLowWaterThreshold

public void deleteLowWaterThreshold()

Method deleteLowWaterThreshold

deleteMemoryCheckInterval

public void deleteMemoryCheckInterval()

Method deleteMemoryCheckInterval

getGarbageCollectionInterval

public int getGarbageCollectionInterval()

Returns the value of field 'garbageCollectionInterval'. The field 'garbageCollectionInterval' has the following description: This indicates how often the garbage collector will run to remove processed messages from the cache. A value of zero will disable this capability. The value is specified in seconds, and defaults to 600 seconds if a value is not set.

Returns:

the value of field 'garbageCollectionInterval'.

getGarbageCollectionThreadPriority

public int getGarbageCollectionThreadPriority()

Returns the value of field 'garbageCollectionThreadPriority'. The field 'garbageCollectionThreadPriority' has the following description: This is the priority assigned to the garbage collection thread. It ranges from 1-10, and defaults to 5 if a value is not set.

Returns:

the value of field 'garbageCollectionThreadPriority'.

getLowWaterThreshold

public int getLowWaterThreshold()

Returns the value of field 'lowWaterThreshold'. The field 'lowWaterThreshold' has the following description: This is the ratio of free memory to total memory, specified as a percentage, which will trigger garbage collection. The default value of 20 indicates that when free memory falls below 20% of total memory (i.e. total VM memory) then garbage collection will be triggered. The range of valid values is 10-50.

Returns:

the value of field 'lowWaterThreshold'.

getMemoryCheckInterval

public int getMemoryCheckInterval()

Returns the value of field 'memoryCheckInterval'. The field 'memoryCheckInterval' has the following description: This indicates how often the server will check the memory utilization of the server. It will check to ensure that the ratio of free memory to total memory doesn't fall below the lowWaterThreshold. The value is specified in seconds, and defaults to 30 seconds if not set.

Returns:

the value of field 'memoryCheckInterval'.

hasGarbageCollectionInterval

public boolean hasGarbageCollectionInterval()

Method hasGarbageCollectionInterval

hasGarbageCollectionThreadPriority

public boolean hasGarbageCollectionThreadPriority()

Method hasGarbageCollectionThreadPriority

hasLowWaterThreshold

public boolean hasLowWaterThreshold()

Method hasLowWaterThreshold

hasMemoryCheckInterval

public boolean hasMemoryCheckInterval()

Method hasMemoryCheckInterval

isValid

public boolean isValid()

Method isValid

marshal

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

Method marshal

Parameters:

out -

marshal

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

Method marshal

Parameters:

handler -

setGarbageCollectionInterval

public void setGarbageCollectionInterval(int garbageCollectionInterval)

Sets the value of field 'garbageCollectionInterval'. The field 'garbageCollectionInterval' has the following description: This indicates how often the garbage collector will run to remove processed messages from the cache. A value of zero will disable this capability. The value is specified in seconds, and defaults to 600 seconds if a value is not set.

Parameters:

garbageCollectionInterval - the value of field 'garbageCollectionInterval'.

setGarbageCollectionThreadPriority

public void setGarbageCollectionThreadPriority(int garbageCollectionThreadPriority)

Sets the value of field 'garbageCollectionThreadPriority'. The field 'garbageCollectionThreadPriority' has the following description: This is the priority assigned to the garbage collection thread. It ranges from 1-10, and defaults to 5 if a value is not set.

Parameters:

garbageCollectionThreadPriority - the value of field 'garbageCollectionThreadPriority'.

setLowWaterThreshold

public void setLowWaterThreshold(int lowWaterThreshold)

Sets the value of field 'lowWaterThreshold'. The field 'lowWaterThreshold' has the following description: This is the ratio of free memory to total memory, specified as a percentage, which will trigger garbage collection. The default value of 20 indicates that when free memory falls below 20% of total memory (i.e. total VM memory) then garbage collection will be triggered. The range of valid values is 10-50.

Parameters:

lowWaterThreshold - the value of field 'lowWaterThreshold'.

setMemoryCheckInterval

public void setMemoryCheckInterval(int memoryCheckInterval)

Sets the value of field 'memoryCheckInterval'. The field 'memoryCheckInterval' has the following description: This indicates how often the server will check the memory utilization of the server. It will check to ensure that the ratio of free memory to total memory doesn't fall below the lowWaterThreshold. The value is specified in seconds, and defaults to 30 seconds if not set.

Parameters:

memoryCheckInterval - the value of field 'memoryCheckInterval'.

unmarshal

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

Method unmarshal

Parameters:

reader -

validate

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

Method validate