WLDFHarvesterBean (Java API Reference for Oracle WebLogic Server)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.diagnostics.descriptor
Interface WLDFHarvesterBean

All Superinterfaces:: WLDFBean

public interface WLDFHarvesterBean
extends WLDFBean
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
`WLDFHarvestedTypeBean`	`createHarvestedType(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(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

setEnabled

void setEnabled(boolean enabled)

Sets the value of the Enabled attribute.

Parameters:: enabled - The enabled state of the Harvester component.
See Also:: WLDFHarvesterBean.isEnabled()

getSamplePeriod

long getSamplePeriod()

The interval, in milliseconds, between samples.

Returns:: the sample interval
Default Value:: 300000
Minimum Value:: 1000

setSamplePeriod

void setSamplePeriod(long newValue)
                     throws IllegalArgumentException

Sets the value of the SamplePeriod attribute.

Parameters:: newValue - the new interval value
Throws:: IllegalArgumentException
See Also:: WLDFHarvesterBean.getSamplePeriod()

getHarvestedTypes

WLDFHarvestedTypeBean[] getHarvestedTypes()

The list of MBeans representing the harvested types.

Returns:: the harvested types

createHarvestedType

WLDFHarvestedTypeBean createHarvestedType(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(String name)

Looks up an instance from the list of harvested types.

Parameters:: name - the name of the entry to be looked up