Package weblogic.diagnostics.descriptor

Interface WLDFHarvesterBean

All Superinterfaces:

SettableBean, WLDFBean

public interface WLDFHarvesterBean
extends WLDFBean

Configures the behavior of the Harvester component of the WebLogic Diagnostic Framework (WLDF).

Access limited to the following security roles:

Deployer

Method Summary

Modifier and Type	Method	Description
WLDFHarvestedTypeBean	createHarvestedType(java.lang.String name)	Creates a harvested type.
void	destroyHarvestedType(WLDFHarvestedTypeBean entry)	Removes an entry from the list of harvested types.
WLDFHarvestedTypeBean[]	getHarvestedTypes()	The list of MBeans representing the harvested types.
long	getSamplePeriod()	The interval, in milliseconds, between samples.
boolean	isEnabled()	Specifies whether the Harvester component is enabled.
WLDFHarvestedTypeBean	lookupHarvestedType(java.lang.String name)	Looks up an instance from the list of harvested types.
void	setEnabled(boolean enabled)	Sets the value of the Enabled attribute.
void	setSamplePeriod(long newValue)	Sets the value of the SamplePeriod attribute.

Methods inherited from interface weblogic.diagnostics.descriptor.WLDFBean

getId, getName

Method Detail

isEnabled

boolean isEnabled()

Specifies whether the Harvester component is enabled.

If true, all types that are both configured and enabled are harvested. If false, nothing is harvested.

Default Value:

true

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setEnabled

void setEnabled(boolean enabled)

Sets the value of the Enabled attribute.

Parameters:

enabled - The enabled state of the Harvester component.

See Also:

isEnabled()

getSamplePeriod

long getSamplePeriod()

The interval, in milliseconds, between samples.

Returns:

the sample interval

Default Value:

300000

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

Minimum Value:

1000

setSamplePeriod

void setSamplePeriod(long newValue)
              throws java.lang.IllegalArgumentException

Sets the value of the SamplePeriod attribute.

Parameters:

newValue - the new interval value

Throws:

java.lang.IllegalArgumentException

See Also:

getSamplePeriod()

getHarvestedTypes

WLDFHarvestedTypeBean[] getHarvestedTypes()

The list of MBeans representing the harvested types.

Returns:

the harvested types

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

createHarvestedType

WLDFHarvestedTypeBean createHarvestedType(java.lang.String name)

Creates a harvested type.

Parameters:

name - the name of the entity being created

Returns:

The created bean

destroyHarvestedType

void destroyHarvestedType(WLDFHarvestedTypeBean entry)

Removes an entry from the list of harvested types.

Parameters:

entry - the entry to be deleted

lookupHarvestedType

WLDFHarvestedTypeBean lookupHarvestedType(java.lang.String name)

Looks up an instance from the list of harvested types.

Parameters:

name - the name of the entry to be looked up