org.rhq.test.shrinkwrap

Interface RhqAgentPluginDescriptorContainer<T extends org.jboss.shrinkwrap.api.Archive<T>>

All Known Subinterfaces:

RhqAgentPluginArchive

All Known Implementing Classes:

RhqAgentPluginArchiveImpl

public interface RhqAgentPluginDescriptorContainer<T extends org.jboss.shrinkwrap.api.Archive<T>>

Defines the contract for archives capable of storing the RHQ agent's plugin descriptor.

Author:

Lukas Krejci

Method Summary

Methods

Modifier and Type	Method and Description
List<org.jboss.shrinkwrap.api.Archive<?>>	getRequiredPlugins() Returns the list of archives containing the plugins that this plugin is dependent on.
org.jboss.shrinkwrap.api.ArchivePath	getRequiredPluginsPath() The RHQ plugin archive can carry along another set of plugins that it is dependent upon (these can be determined for example by using withRequiredPluginsFrom(Collection) method).
T	setPluginDescriptor(org.jboss.shrinkwrap.api.asset.Asset asset) Sets the plugin descriptor using the provided asset.
T	setPluginDescriptor(File file) Sets the plugin descriptor using the given file.
T	setPluginDescriptor(String resourceName) Sets the plugin descriptor using the resource name.
T	setPluginDescriptor(URL url) Sets the plugin descriptor using the provided URL.
T	setPluginDescriptorFromTemplate(String resourceName, Map<String,String> replacementValues) Sets the plugin descriptor using the plugin descriptor template resource, making a copy of that resource and replacing templatized variables in that file with replacement values that are passed into this method.
T	withRequiredPluginsFrom(org.jboss.shrinkwrap.api.Archive<?>... archives) An overloaded version of withRequiredPluginsFrom(Collection)
T	withRequiredPluginsFrom(Collection<? extends org.jboss.shrinkwrap.api.Archive<?>> archives) Using this method, one can supply a single RHQ plugin together with the plugins that the plugin is dependent upon.

Method Detail

getRequiredPluginsPath

org.jboss.shrinkwrap.api.ArchivePath getRequiredPluginsPath()

The RHQ plugin archive can carry along another set of plugins that it is dependent upon (these can be determined for example by using withRequiredPluginsFrom(Collection) method).

These are internally stored under the path returned from this method. When creating a JAR archive file out of the shrinkwrap representation of the archive, it is important to excelude this path from the resulting JAR.

You can do this by casting the archive to a FilteredView for example.

Returns:

the path where the archive internally stores the required libraries if those were collected using the withRequiredPluginsFrom(Collection) method.

setPluginDescriptorFromTemplate

T setPluginDescriptorFromTemplate(String resourceName,
                                Map<String,String> replacementValues)
                                                                              throws IllegalArgumentException

Sets the plugin descriptor using the plugin descriptor template resource, making a copy of that resource and replacing templatized variables in that file with replacement values that are passed into this method. The ClassLoader is used to obtain the plugin descriptor template resource, but it is assumed to be a file on the file system.

Parameters:

resourceName - the name of the plugin descriptor template resource as accessible by the class loader

replacementValues - map with keys of template replacement variable names with their replacement values

Returns:

the archive itself

Throws:

IllegalArgumentException - if resourceName or replacementValues is null

setPluginDescriptor

T setPluginDescriptor(String resourceName)
                                                                  throws IllegalArgumentException

Sets the plugin descriptor using the resource name. The ClassLoader is used to obtain the resource.

Parameters:

resourceName - the name of the resource as accessible by the class loader

Returns:

the archive itself

Throws:

IllegalArgumentException - if resourceName is null

setPluginDescriptor

T setPluginDescriptor(File file)
                                                                  throws IllegalArgumentException

Sets the plugin descriptor using the given file.

Parameters:

file - the plugin descriptor file

Returns:

the archive itself

Throws:

IllegalArgumentException - if file is null or not readable

setPluginDescriptor

T setPluginDescriptor(URL url)
                                                                  throws IllegalArgumentException

Sets the plugin descriptor using the provided URL.

Parameters:

url - the URL to obtain the plugin descriptor from

Returns:

the archive itself

Throws:

IllegalArgumentException - if url is null

setPluginDescriptor

T setPluginDescriptor(org.jboss.shrinkwrap.api.asset.Asset asset)
                                                                  throws IllegalArgumentException

Sets the plugin descriptor using the provided asset.

Parameters:

asset - the asset representing the plugin descriptor

Returns:

the archive itself

Throws:

IllegalArgumentException - if asset is null

withRequiredPluginsFrom

T withRequiredPluginsFrom(Collection<? extends org.jboss.shrinkwrap.api.Archive<?>> archives)
                                                                      throws IllegalArgumentException

Using this method, one can supply a single RHQ plugin together with the plugins that the plugin is dependent upon. The list of archives is just a list of archives resolved by some means (i.e. maven resolver or some other means).

This method is only effective after the plugin descriptor has been set using one of the setPluginDescriptor methods (or by placing the plugin descriptor directly into "META-INF/rhq-plugin.xml" manually).

Parameters:

archives - the archives to look for the required RHQ plugins in

Returns:

the archive itself

Throws:

IllegalArgumentException - if the collection is null

withRequiredPluginsFrom

T withRequiredPluginsFrom(org.jboss.shrinkwrap.api.Archive<?>... archives)
                                                                      throws IllegalArgumentException

An overloaded version of withRequiredPluginsFrom(Collection)

Throws:

IllegalArgumentException

getRequiredPlugins

List<org.jboss.shrinkwrap.api.Archive<?>> getRequiredPlugins()

Returns the list of archives containing the plugins that this plugin is dependent on. The plugins are found during the withRequiredPluginsFrom(Collection) call.

Returns:

the list of required plugin archives in the correct deployment order or null if not set