org.rhq.core.clientapi.descriptor.plugin

Class PluginDescriptor

java.lang.Object

org.rhq.core.clientapi.descriptor.plugin.PluginDescriptor

public class PluginDescriptor
extends Object

Root of a plugin representing an ON plugin definition and the resource model of supported managed systems and their components

Java class for plugin element declaration.

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

 <element name="plugin">
   <complexType>
     <complexContent>
       <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
         <sequence>
           <element name="depends" maxOccurs="unbounded" minOccurs="0">
             <complexType>
               <complexContent>
                 <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                   <attribute name="plugin" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
                   <attribute name="useClasses" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
                 </restriction>
               </complexContent>
             </complexType>
           </element>
           <element ref="{urn:xmlns:rhq-plugin}discovery-callbacks" minOccurs="0"/>
           <element ref="{urn:xmlns:rhq-plugin}platform" maxOccurs="unbounded" minOccurs="0"/>
           <element ref="{urn:xmlns:rhq-plugin}server" maxOccurs="unbounded" minOccurs="0"/>
           <element ref="{urn:xmlns:rhq-plugin}service" maxOccurs="unbounded" minOccurs="0"/>
           <element ref="{urn:xmlns:rhq-plugin}help" minOccurs="0"/>
         </sequence>
         <attribute name="ampsVersion" type="{http://www.w3.org/2001/XMLSchema}string" />
         <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
         <attribute name="displayName" type="{http://www.w3.org/2001/XMLSchema}string" />
         <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
         <attribute name="package" type="{urn:xmlns:rhq-plugin}classNameType" />
         <attribute name="pluginLifecycleListener" type="{urn:xmlns:rhq-plugin}classNameType" />
         <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" />
       </restriction>
     </complexContent>
   </complexType>
 </element>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginDescriptor.Depends Java class for anonymous complex type.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_package
protected String	ampsVersion
protected List<PluginDescriptor.Depends>	depends
protected String	description
protected DiscoveryCallbacksType	discoveryCallbacks
protected String	displayName
protected Help	help
protected String	name
protected List<PlatformDescriptor>	platforms
protected String	pluginLifecycleListener
protected List<ServerDescriptor>	servers
protected List<ServiceDescriptor>	services
protected String	version

Constructor Summary

Constructors

Constructor and Description
PluginDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAmpsVersion() Gets the value of the ampsVersion property.
List<PluginDescriptor.Depends>	getDepends() Gets the value of the depends property.
String	getDescription() Gets the value of the description property.
DiscoveryCallbacksType	getDiscoveryCallbacks() Defines the types and discovery classes whose discovered resources must be funneled through this plugin's discovery classback classes.
String	getDisplayName() Gets the value of the displayName property.
Help	getHelp() Gets the value of the help property.
String	getName() Gets the value of the name property.
String	getPackage() Gets the value of the package property.
List<PlatformDescriptor>	getPlatforms() Defines a supported platform type (i.e.
String	getPluginLifecycleListener() Gets the value of the pluginLifecycleListener property.
List<ServerDescriptor>	getServers() Defines a supported server.
List<ServiceDescriptor>	getServices() Defines a supported service.
String	getVersion() Gets the value of the version property.
void	setAmpsVersion(String value) Sets the value of the ampsVersion property.
void	setDescription(String value) Sets the value of the description property.
void	setDiscoveryCallbacks(DiscoveryCallbacksType value) Defines the types and discovery classes whose discovered resources must be funneled through this plugin's discovery classback classes.
void	setDisplayName(String value) Sets the value of the displayName property.
void	setHelp(Help value) Sets the value of the help property.
void	setName(String value) Sets the value of the name property.
void	setPackage(String value) Sets the value of the package property.
void	setPluginLifecycleListener(String value) Sets the value of the pluginLifecycleListener property.
void	setVersion(String 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

depends

protected List<PluginDescriptor.Depends> depends

discoveryCallbacks

protected DiscoveryCallbacksType discoveryCallbacks

platforms

protected List<PlatformDescriptor> platforms

servers

protected List<ServerDescriptor> servers

services

protected List<ServiceDescriptor> services

help

protected Help help

ampsVersion

protected String ampsVersion

description

protected String description

displayName

protected String displayName

name

protected String name

_package

protected String _package

pluginLifecycleListener

protected String pluginLifecycleListener

version

protected String version

Constructor Detail

PluginDescriptor

public PluginDescriptor()

Method Detail

getDepends

public List<PluginDescriptor.Depends> getDepends()

Gets the value of the depends 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 depends property.

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

    getDepends().add(newItem);
 

Objects of the following type(s) are allowed in the list PluginDescriptor.Depends

getDiscoveryCallbacks

public DiscoveryCallbacksType getDiscoveryCallbacks()

Defines the types and discovery classes whose discovered resources must be funneled through this plugin's discovery classback classes.

Returns:

possible object is DiscoveryCallbacksType

setDiscoveryCallbacks

public void setDiscoveryCallbacks(DiscoveryCallbacksType value)

Defines the types and discovery classes whose discovered resources must be funneled through this plugin's discovery classback classes.

Parameters:

value - allowed object is DiscoveryCallbacksType

getPlatforms

public List<PlatformDescriptor> getPlatforms()

Defines a supported platform type (i.e. operating system). Platforms are already defined in the standard platform plugin deployed with the plugin container itself; custom plugins typically do not have to define new platforms. Gets the value of the platforms 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 platforms property.

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

    getPlatforms().add(newItem);
 

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

getServers

public List<ServerDescriptor> getServers()

Defines a supported server. A server is typically a standalone product that can be managed and monitored. Servers may be auto-discovered via process scans. Gets the value of the servers 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 servers property.

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

    getServers().add(newItem);
 

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

getServices

public List<ServiceDescriptor> getServices()

Defines a supported service. A service is typically a child of server and provides distinct functionality within the parent server. Services are usually discovered by their parent servers. Gets the value of the services 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 services property.

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

    getServices().add(newItem);
 

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

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

getAmpsVersion

public String getAmpsVersion()

Gets the value of the ampsVersion property.

Returns:

possible object is String

setAmpsVersion

public void setAmpsVersion(String value)

Sets the value of the ampsVersion 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

getDisplayName

public String getDisplayName()

Gets the value of the displayName property.

Returns:

possible object is String

setDisplayName

public void setDisplayName(String value)

Sets the value of the displayName 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

getPackage

public String getPackage()

Gets the value of the package property.

Returns:

possible object is String

setPackage

public void setPackage(String value)

Sets the value of the package property.

Parameters:

value - allowed object is String

getPluginLifecycleListener

public String getPluginLifecycleListener()

Gets the value of the pluginLifecycleListener property.

Returns:

possible object is String

setPluginLifecycleListener

public void setPluginLifecycleListener(String value)

Sets the value of the pluginLifecycleListener property.

Parameters:

value - allowed object is String

getVersion

public String getVersion()

Gets the value of the version property.

Returns:

possible object is String

setVersion

public void setVersion(String value)

Sets the value of the version property.

Parameters:

value - allowed object is String