org.rhq.test.shrinkwrap

Class RhqAgentPluginArchiveImpl

java.lang.Object

org.jboss.shrinkwrap.impl.base.AssignableBase<org.jboss.shrinkwrap.api.Archive<?>>

org.jboss.shrinkwrap.impl.base.container.ContainerBase<RhqAgentPluginArchive>

org.rhq.test.shrinkwrap.RhqAgentPluginArchiveImpl

All Implemented Interfaces:

org.jboss.shrinkwrap.api.Archive<RhqAgentPluginArchive>, org.jboss.shrinkwrap.api.Assignable, org.jboss.shrinkwrap.api.container.ClassContainer<RhqAgentPluginArchive>, org.jboss.shrinkwrap.api.container.LibraryContainer<RhqAgentPluginArchive>, org.jboss.shrinkwrap.api.container.ManifestContainer<RhqAgentPluginArchive>, org.jboss.shrinkwrap.api.container.ResourceContainer<RhqAgentPluginArchive>, org.jboss.shrinkwrap.api.container.ServiceProviderContainer<RhqAgentPluginArchive>, org.jboss.shrinkwrap.spi.ArchiveFormatAssociable, RhqAgentPluginArchive, RhqAgentPluginDescriptorContainer<RhqAgentPluginArchive>

public class RhqAgentPluginArchiveImpl
extends org.jboss.shrinkwrap.impl.base.container.ContainerBase<RhqAgentPluginArchive>
implements RhqAgentPluginArchive

Author:

Lukas Krejci

Field Summary

Fields inherited from interface org.jboss.shrinkwrap.api.container.ManifestContainer

DEFAULT_MANIFEST_NAME

Constructor Summary

Constructors

Constructor and Description
RhqAgentPluginArchiveImpl(org.jboss.shrinkwrap.api.Archive<?> delegate)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.jboss.shrinkwrap.api.ArchivePath	getClassesPath()
org.jboss.shrinkwrap.api.ArchivePath	getLibraryPath()
protected org.jboss.shrinkwrap.api.ArchivePath	getManifestPath()
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 RhqAgentPluginDescriptorContainer.withRequiredPluginsFrom(Collection) method).
protected org.jboss.shrinkwrap.api.ArchivePath	getResourcePath()
RhqAgentPluginArchive	setPluginDescriptor(org.jboss.shrinkwrap.api.asset.Asset asset) Sets the plugin descriptor using the provided asset.
RhqAgentPluginArchive	setPluginDescriptor(File file) Sets the plugin descriptor using the given file.
RhqAgentPluginArchive	setPluginDescriptor(String resourceName) Sets the plugin descriptor using the resource name.
RhqAgentPluginArchive	setPluginDescriptor(URL url) Sets the plugin descriptor using the provided URL.
RhqAgentPluginArchive	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.
RhqAgentPluginArchive	withRequiredPluginsFrom(org.jboss.shrinkwrap.api.Archive<?>... archives) An overloaded version of RhqAgentPluginDescriptorContainer.withRequiredPluginsFrom(Collection)
RhqAgentPluginArchive	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.

Methods inherited from class org.jboss.shrinkwrap.impl.base.container.ContainerBase

add, add, add, add, add, add, add, addAsDirectories, addAsDirectories, addAsDirectory, addAsDirectory, addAsLibraries, addAsLibraries, addAsLibraries, addAsLibraries, addAsLibraries, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResources, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResources, addAsServiceProvider, addAsServiceProvider, addAsServiceProviderAndClasses, addClass, addClass, addClass, addClasses, addDefaultPackage, addManifest, addPackage, addPackage, addPackages, addPackages, addPackages, addPackages, contains, contains, covarientReturn, delete, delete, equals, get, get, getActualClass, getArchiveFormat, getAsType, getAsType, getAsType, getAsType, getAsType, getAsType, getContent, getContent, getName, hashCode, merge, merge, merge, merge, merge, merge, setManifest, setManifest, setManifest, setManifest, setManifest, toString, toString, toString, writeTo

Methods inherited from class org.jboss.shrinkwrap.impl.base.AssignableBase

as, getArchive

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jboss.shrinkwrap.api.Archive

add, add, add, add, add, add, add, addAsDirectories, addAsDirectories, addAsDirectory, addAsDirectory, contains, contains, delete, delete, get, get, getAsType, getAsType, getAsType, getAsType, getAsType, getAsType, getContent, getContent, getName, merge, merge, merge, merge, merge, merge, toString, toString, toString, writeTo

Methods inherited from interface org.jboss.shrinkwrap.api.Assignable

as

Methods inherited from interface org.jboss.shrinkwrap.api.container.ManifestContainer

addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResource, addAsManifestResources, addAsServiceProvider, addAsServiceProvider, addManifest, setManifest, setManifest, setManifest, setManifest, setManifest

Methods inherited from interface org.jboss.shrinkwrap.api.container.ClassContainer

addClass, addClass, addClass, addClasses, addDefaultPackage, addPackage, addPackage, addPackages, addPackages, addPackages, addPackages

Methods inherited from interface org.jboss.shrinkwrap.api.container.ResourceContainer

addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResource, addAsResources

Methods inherited from interface org.jboss.shrinkwrap.api.container.LibraryContainer

addAsLibraries, addAsLibraries, addAsLibraries, addAsLibraries, addAsLibraries, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary, addAsLibrary

Constructor Detail

RhqAgentPluginArchiveImpl

public RhqAgentPluginArchiveImpl(org.jboss.shrinkwrap.api.Archive<?> delegate)

Method Detail

getRequiredPluginsPath

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

Description copied from interface: RhqAgentPluginDescriptorContainer

The RHQ plugin archive can carry along another set of plugins that it is dependent upon (these can be determined for example by using RhqAgentPluginDescriptorContainer.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.

Specified by:

getRequiredPluginsPath in interface RhqAgentPluginDescriptorContainer<RhqAgentPluginArchive>

Returns:

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

getManifestPath

protected org.jboss.shrinkwrap.api.ArchivePath getManifestPath()

Specified by:

getManifestPath in class org.jboss.shrinkwrap.impl.base.container.ContainerBase<RhqAgentPluginArchive>

getClassesPath

protected org.jboss.shrinkwrap.api.ArchivePath getClassesPath()

Specified by:

getClassesPath in class org.jboss.shrinkwrap.impl.base.container.ContainerBase<RhqAgentPluginArchive>

getResourcePath

protected org.jboss.shrinkwrap.api.ArchivePath getResourcePath()

Specified by:

getResourcePath in class org.jboss.shrinkwrap.impl.base.container.ContainerBase<RhqAgentPluginArchive>

getLibraryPath

public org.jboss.shrinkwrap.api.ArchivePath getLibraryPath()

Specified by:

getLibraryPath in class org.jboss.shrinkwrap.impl.base.container.ContainerBase<RhqAgentPluginArchive>

setPluginDescriptorFromTemplate

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

Description copied from interface: RhqAgentPluginDescriptorContainer

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.

Specified by:

setPluginDescriptorFromTemplate in interface RhqAgentPluginDescriptorContainer<RhqAgentPluginArchive>

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

public RhqAgentPluginArchive setPluginDescriptor(String resourceName)
                                          throws IllegalArgumentException

Description copied from interface: RhqAgentPluginDescriptorContainer

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

Specified by:

setPluginDescriptor in interface RhqAgentPluginDescriptorContainer<RhqAgentPluginArchive>

Parameters:

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

Returns:

the archive itself

Throws:

IllegalArgumentException - if resourceName is null

setPluginDescriptor

public RhqAgentPluginArchive setPluginDescriptor(File file)
                                          throws IllegalArgumentException

Description copied from interface: RhqAgentPluginDescriptorContainer

Sets the plugin descriptor using the given file.

Specified by:

setPluginDescriptor in interface RhqAgentPluginDescriptorContainer<RhqAgentPluginArchive>

Parameters:

file - the plugin descriptor file

Returns:

the archive itself

Throws:

IllegalArgumentException - if file is null or not readable

setPluginDescriptor

public RhqAgentPluginArchive setPluginDescriptor(URL url)
                                          throws IllegalArgumentException

Description copied from interface: RhqAgentPluginDescriptorContainer

Sets the plugin descriptor using the provided URL.

Specified by:

setPluginDescriptor in interface RhqAgentPluginDescriptorContainer<RhqAgentPluginArchive>

Parameters:

url - the URL to obtain the plugin descriptor from

Returns:

the archive itself

Throws:

IllegalArgumentException - if url is null

setPluginDescriptor

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

Description copied from interface: RhqAgentPluginDescriptorContainer

Sets the plugin descriptor using the provided asset.

Specified by:

setPluginDescriptor in interface RhqAgentPluginDescriptorContainer<RhqAgentPluginArchive>

Parameters:

asset - the asset representing the plugin descriptor

Returns:

the archive itself

Throws:

IllegalArgumentException - if asset is null

withRequiredPluginsFrom

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

Description copied from interface: RhqAgentPluginDescriptorContainer

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).

Specified by:

withRequiredPluginsFrom in interface RhqAgentPluginDescriptorContainer<RhqAgentPluginArchive>

Parameters:

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

Returns:

the archive itself

Throws:

IllegalArgumentException - if the collection is null

withRequiredPluginsFrom

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

Description copied from interface: RhqAgentPluginDescriptorContainer

An overloaded version of RhqAgentPluginDescriptorContainer.withRequiredPluginsFrom(Collection)

Specified by:

withRequiredPluginsFrom in interface RhqAgentPluginDescriptorContainer<RhqAgentPluginArchive>

Throws:

IllegalArgumentException

getRequiredPlugins

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

Description copied from interface: RhqAgentPluginDescriptorContainer

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

Specified by:

getRequiredPlugins in interface RhqAgentPluginDescriptorContainer<RhqAgentPluginArchive>

Returns:

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