weblogic.diagnostics.descriptor
Interface WLDFHarvestedTypeBean

All Superinterfaces:

WLDFBean

public interface WLDFHarvestedTypeBean
extends WLDFBean

Defines the set of types (beans) that are harvested. The WLDF framework allows the harvesting of all designated server-local Weblogic Server runtime MBeans, and most customer MBeans that are registered in the local server's runtime MBean server. Configuration MBeans cannot be harvested.

Access limited to the following security roles:

Deployer

getName

String getName()

The type name. For WebLogic Server runtime MBeans, the type name is the fully qualified name of the defining interface. For customer MBeans, the type name is the fully qualified MBean implementation class.

Specified by:

getName in interface WLDFBean

setName

void setName(String name)

Sets the value of the Name attribute.

See Also:

WLDFHarvestedTypeBean.getName()

This method can NOT set a null value.

isEnabled

boolean isEnabled()

Specifies whether this type is enabled. Note that enabling a type will have no effect unless the Harvester component is also enabled.

A true value means that this type is harvested. A false value indicates that that this type is not harvested.

Default Value:

true

setEnabled

void setEnabled(boolean enabled)

Sets the value of the Enabled attribute.

Parameters:

enabled - The enabled state of the Harvester type.

See Also:

WLDFHarvestedTypeBean.isEnabled()

isKnownType

boolean isKnownType()

Specifies whether this type is known at startup. Normally, if a type is not available, the Harvester will keep looking for it. If a type is designated as "known", the Harvester issues a validation fault if the type cannot be immediately resolved.

A true value means that this type is known. A false value indicates that this type may not be known.

This flag is useful for WebLogic Server types, where the type information is always available. In this case, setting the flag to true results in earlier detection and reporting of problems.

This flag is optional, but is recommended for WebLogic Server types.

Default Value:

false

setKnownType

void setKnownType(boolean isKnownType)

Sets the value of the KnownType attribute.

Parameters:

isKnownType - Whether or not this is a known server type.

See Also:

WLDFHarvestedTypeBean.isKnownType()

getHarvestedAttributes

String[] getHarvestedAttributes()

The harvested attributes for this type. If a list of attributes is provided, only those attributes are harvested; otherwise all harvestable attributes are harvested.

Returns:

the harvested attributes for this type

Default Value:

null

setHarvestedAttributes

void setHarvestedAttributes(String[] attributes)

Sets the value of the harvestedAttributes attribute.

Parameters:

attributes - the new set of harvested attributes for this type

Throws:

InvalidAttributeValueException

See Also:

WLDFHarvestedTypeBean.getHarvestedAttributes()

getHarvestedInstances

String[] getHarvestedInstances()

The harvested instances of this type.

The configuration of a type can optionally provide a set of identifiers for specific instances. If this list is provided, only the provided instances are harvested; otherwise all instances of the type are harvested.

The identifier for an instance must be a valid JMX ObjectName or an ObjectName pattern.

Returns:

the harvested instances for this type

Default Value:

null

setHarvestedInstances

void setHarvestedInstances(String[] instances)

Sets the value of the HarvestedInstances attribute.

Parameters:

instances - the new set of harvested instances for this type

Throws:

InvalidAttributeValueException

See Also:

WLDFHarvestedTypeBean.getHarvestedInstances()

getNamespace

String getNamespace()

The namespace for the harvested type definition.

Returns:

The identifier for the namespace for this type

This method can NOT set a null value.

This method can NOT set a value of zero length.

Default Value:

HarvesterConstants.DEFAULT_NAMESPACE

Valid Values:

HarvesterConstants.SERVERRUNTIME_NAMESPACE, HarvesterConstants.DOMAINRUNTIME_NAMESPACE

setNamespace

void setNamespace(String namespace)

Sets the namespace for the harvested type definition.

Parameters:

namespace - The target namespace of the harvested type definition

See Also:

WLDFHarvestedTypeBean.getNamespace()