org.rhq.core.clientapi.descriptor.plugin
Class ResourceDescriptor

java.lang.Object
  org.rhq.core.clientapi.descriptor.plugin.ResourceDescriptor

Direct Known Subclasses:

PlatformDescriptor, ServerDescriptor, ServiceDescriptor

public abstract class ResourceDescriptor
extends Object

Java class for resource complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="resource">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:xmlns:rhq-plugin}version" minOccurs="0"/>
         <element name="runs-inside" type="{urn:xmlns:rhq-plugin}runsInsideType" minOccurs="0"/>
         <element name="subcategories" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element ref="{urn:xmlns:rhq-plugin}subcategory" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="plugin-configuration" type="{urn:xmlns:rhq-configuration}configuration" minOccurs="0"/>
         <element name="process-scan" type="{urn:xmlns:rhq-plugin}processScan" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:xmlns:rhq-plugin}operation" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:xmlns:rhq-plugin}metric" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:xmlns:rhq-plugin}event" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:xmlns:rhq-plugin}content" maxOccurs="unbounded" minOccurs="0"/>
         <element name="resource-configuration" type="{urn:xmlns:rhq-configuration}configuration" minOccurs="0"/>
         <element ref="{urn:xmlns:rhq-plugin}help" minOccurs="0"/>
       </sequence>
       <attribute name="class" type="{urn:xmlns:rhq-plugin}classNameType" />
       <attribute name="classLoader" default="shared">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="shared"/>
             <enumeration value="instance"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="discovery" type="{urn:xmlns:rhq-plugin}classNameType" />
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="singleton" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="subCategory" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" />
       <attribute name="supportsManualAdd" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

static class

ResourceDescriptor.Subcategories Java class for anonymous complex type.

Field Summary

protected String	classLoader
protected String	clazz
protected List<ContentDescriptor>	content
protected String	description
protected String	discovery
protected List<EventDescriptor>	event
protected Help	help
protected List<MetricDescriptor>	metric
protected String	name
protected List<OperationDescriptor>	operation
protected ConfigurationDescriptor	pluginConfiguration
protected List<ProcessScanDescriptor>	processScan
protected ConfigurationDescriptor	resourceConfiguration
protected RunsInsideType	runsInside
protected Boolean	singleton
protected ResourceDescriptor.Subcategories	subcategories
protected String	subCategory
protected Boolean	supportsManualAdd
protected Version	version

Constructor Summary

ResourceDescriptor()

Method Summary

String	getClassLoader() Gets the value of the classLoader property.
String	getClazz() Gets the value of the clazz property.
List<ContentDescriptor>	getContent() Gets the value of the content property.
String	getDescription() Gets the value of the description property.
String	getDiscovery() Gets the value of the discovery property.
List<EventDescriptor>	getEvent() Gets the value of the event property.
Help	getHelp() Gets the value of the help property.
List<MetricDescriptor>	getMetric() Gets the value of the metric property.
String	getName() Gets the value of the name property.
List<OperationDescriptor>	getOperation() Gets the value of the operation property.
Map<QName,String>	getOtherAttributes() Gets a map that contains attributes that aren't bound to any typed property on this class.
ConfigurationDescriptor	getPluginConfiguration() Gets the value of the pluginConfiguration property.
List<ProcessScanDescriptor>	getProcessScan() Gets the value of the processScan property.
ConfigurationDescriptor	getResourceConfiguration() Gets the value of the resourceConfiguration property.
RunsInsideType	getRunsInside() Gets the value of the runsInside property.
ResourceDescriptor.Subcategories	getSubcategories() Gets the value of the subcategories property.
String	getSubCategory() Gets the value of the subCategory property.
Version	getVersion() Gets the value of the version property.
boolean	isSingleton() Gets the value of the singleton property.
boolean	isSupportsManualAdd() Gets the value of the supportsManualAdd property.
void	setClassLoader(String value) Sets the value of the classLoader property.
void	setClazz(String value) Sets the value of the clazz property.
void	setDescription(String value) Sets the value of the description property.
void	setDiscovery(String value) Sets the value of the discovery property.
void	setHelp(Help value) Sets the value of the help property.
void	setName(String value) Sets the value of the name property.
void	setPluginConfiguration(ConfigurationDescriptor value) Sets the value of the pluginConfiguration property.
void	setResourceConfiguration(ConfigurationDescriptor value) Sets the value of the resourceConfiguration property.
void	setRunsInside(RunsInsideType value) Sets the value of the runsInside property.
void	setSingleton(Boolean value) Sets the value of the singleton property.
void	setSubcategories(ResourceDescriptor.Subcategories value) Sets the value of the subcategories property.
void	setSubCategory(String value) Sets the value of the subCategory property.
void	setSupportsManualAdd(Boolean value) Sets the value of the supportsManualAdd property.
void	setVersion(Version value) Sets the value of the version property.

Methods inherited from class java.lang.Object

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

Field Detail

version

protected Version version

runsInside

protected RunsInsideType runsInside

subcategories

protected ResourceDescriptor.Subcategories subcategories

pluginConfiguration

protected ConfigurationDescriptor pluginConfiguration

processScan

protected List<ProcessScanDescriptor> processScan

operation

protected List<OperationDescriptor> operation

metric

protected List<MetricDescriptor> metric

event

protected List<EventDescriptor> event

content

protected List<ContentDescriptor> content

resourceConfiguration

protected ConfigurationDescriptor resourceConfiguration

help

protected Help help

clazz

protected String clazz

classLoader

protected String classLoader

description

protected String description

discovery

protected String discovery

name

protected String name

singleton

protected Boolean singleton

subCategory

protected String subCategory

supportsManualAdd

protected Boolean supportsManualAdd

Constructor Detail

ResourceDescriptor

public ResourceDescriptor()

Method Detail

getVersion

public Version getVersion()

Gets the value of the version property.

Returns:

possible object is Version

setVersion

public void setVersion(Version value)

Sets the value of the version property.

Parameters:

value - allowed object is Version

getRunsInside

public RunsInsideType getRunsInside()

Gets the value of the runsInside property.

Returns:

possible object is RunsInsideType

setRunsInside

public void setRunsInside(RunsInsideType value)

Sets the value of the runsInside property.

Parameters:

value - allowed object is RunsInsideType

getSubcategories

public ResourceDescriptor.Subcategories getSubcategories()

Gets the value of the subcategories property.

Returns:

possible object is ResourceDescriptor.Subcategories

setSubcategories

public void setSubcategories(ResourceDescriptor.Subcategories value)

Sets the value of the subcategories property.

Parameters:

value - allowed object is ResourceDescriptor.Subcategories

getPluginConfiguration

public ConfigurationDescriptor getPluginConfiguration()

Gets the value of the pluginConfiguration property.

Returns:

possible object is ConfigurationDescriptor

setPluginConfiguration

public void setPluginConfiguration(ConfigurationDescriptor value)

Sets the value of the pluginConfiguration property.

Parameters:

value - allowed object is ConfigurationDescriptor

getProcessScan

public List<ProcessScanDescriptor> getProcessScan()

Gets the value of the processScan property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the processScan property.

For example, to add a new item, do as follows:

    getProcessScan().add(newItem);
 

Objects of the following type(s) are allowed in the list ProcessScanDescriptor

getOperation

public List<OperationDescriptor> getOperation()

Gets the value of the operation property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the operation property.

For example, to add a new item, do as follows:

    getOperation().add(newItem);
 

Objects of the following type(s) are allowed in the list OperationDescriptor

getMetric

public List<MetricDescriptor> getMetric()

Gets the value of the metric property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the metric property.

For example, to add a new item, do as follows:

    getMetric().add(newItem);
 

Objects of the following type(s) are allowed in the list MetricDescriptor

getEvent

public List<EventDescriptor> getEvent()

Gets the value of the event property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the event property.

For example, to add a new item, do as follows:

    getEvent().add(newItem);
 

Objects of the following type(s) are allowed in the list EventDescriptor

getContent

public List<ContentDescriptor> getContent()

Gets the value of the content property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the content property.

For example, to add a new item, do as follows:

    getContent().add(newItem);
 

Objects of the following type(s) are allowed in the list ContentDescriptor

getResourceConfiguration

public ConfigurationDescriptor getResourceConfiguration()

Gets the value of the resourceConfiguration property.

Returns:

possible object is ConfigurationDescriptor

setResourceConfiguration

public void setResourceConfiguration(ConfigurationDescriptor value)

Sets the value of the resourceConfiguration property.

Parameters:

value - allowed object is ConfigurationDescriptor

getHelp

public Help getHelp()

Gets the value of the help property.

Returns:

possible object is Help

setHelp

public void setHelp(Help value)

Sets the value of the help property.

Parameters:

value - allowed object is Help

getClazz

public String getClazz()

Gets the value of the clazz property.

Returns:

possible object is String

setClazz

public void setClazz(String value)

Sets the value of the clazz property.

Parameters:

value - allowed object is String

getClassLoader

public String getClassLoader()

Gets the value of the classLoader property.

Returns:

possible object is String

setClassLoader

public void setClassLoader(String value)

Sets the value of the classLoader property.

Parameters:

value - allowed object is String

getDescription

public String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

public void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

getDiscovery

public String getDiscovery()

Gets the value of the discovery property.

Returns:

possible object is String

setDiscovery

public void setDiscovery(String value)

Sets the value of the discovery property.

Parameters:

value - allowed object is String

getName

public String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

isSingleton

public boolean isSingleton()

Gets the value of the singleton property.

Returns:

possible object is Boolean

setSingleton

public void setSingleton(Boolean value)

Sets the value of the singleton property.

Parameters:

value - allowed object is Boolean

getSubCategory

public String getSubCategory()

Gets the value of the subCategory property.

Returns:

possible object is String

setSubCategory

public void setSubCategory(String value)

Sets the value of the subCategory property.

Parameters:

value - allowed object is String

isSupportsManualAdd

public boolean isSupportsManualAdd()

Gets the value of the supportsManualAdd property.

Returns:

possible object is Boolean

setSupportsManualAdd

public void setSupportsManualAdd(Boolean value)

Sets the value of the supportsManualAdd property.

Parameters:

value - allowed object is Boolean

getOtherAttributes

public Map<QName,String> getOtherAttributes()

Gets a map that contains attributes that aren't bound to any typed property on this class.

the map is keyed by the name of the attribute and the value is the string value of the attribute. the map returned by this method is live, and you can add new attribute by updating the map directly. Because of this design, there's no setter.

Returns:

always non-null