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.
Modifier and Type | Method | Description |
---|---|---|
java.lang.String[] |
getHarvestedAttributes() |
The harvested attributes for this type.
|
java.lang.String[] |
getHarvestedInstances() |
The harvested instances of this type.
|
java.lang.String |
getName() |
The type name.
|
java.lang.String |
getNamespace() |
The namespace for the harvested type definition.
|
boolean |
isEnabled() |
Specifies whether this type is enabled.
|
boolean |
isKnownType() |
Specifies whether this type is known at startup.
|
void |
setEnabled(boolean enabled) |
Sets the value of the Enabled attribute.
|
void |
setHarvestedAttributes(java.lang.String[] attributes) |
Sets the value of the harvestedAttributes attribute.
|
void |
setHarvestedInstances(java.lang.String[] instances) |
Sets the value of the HarvestedInstances attribute.
|
void |
setKnownType(boolean isKnownType) |
Sets the value of the KnownType attribute.
|
void |
setName(java.lang.String name) |
Sets the value of the Name attribute.
|
void |
setNamespace(java.lang.String namespace) |
Sets the namespace for the harvested type definition.
|
java.lang.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.
void setName(java.lang.String name)
Sets the value of the Name attribute.
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.
void setEnabled(boolean enabled)
Sets the value of the Enabled attribute.
enabled
- The enabled state of the Harvester type.isEnabled()
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.
void setKnownType(boolean isKnownType)
Sets the value of the KnownType attribute.
isKnownType
- Whether or not this is a known server type.isKnownType()
java.lang.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.
void setHarvestedAttributes(java.lang.String[] attributes)
Sets the value of the harvestedAttributes attribute.
attributes
- the new set of harvested attributes for this typeInvalidAttributeValueException
getHarvestedAttributes()
java.lang.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.
void setHarvestedInstances(java.lang.String[] instances)
Sets the value of the HarvestedInstances attribute.
instances
- the new set of harvested instances for this typeInvalidAttributeValueException
getHarvestedInstances()
java.lang.String getNamespace()
The namespace for the harvested type definition.
void setNamespace(java.lang.String namespace)
Sets the namespace for the harvested type definition.
namespace
- The target namespace of the harvested type definitiongetNamespace()