org.jboss.shrinkwrap.impl.base.container
Class WebContainerBase<T extends Archive<T>>

java.lang.Object
  org.jboss.shrinkwrap.impl.base.AssignableBase<Archive<?>>
      org.jboss.shrinkwrap.impl.base.container.ContainerBase<T>
          org.jboss.shrinkwrap.impl.base.container.WebContainerBase<T>

Type Parameters:

T -

All Implemented Interfaces:

Archive<T>, Assignable, ClassContainer<T>, LibraryContainer<T>, ManifestContainer<T>, ResourceContainer<T>, ServiceProviderContainer<T>, WebContainer<T>, ArchiveFormatAssociable

Direct Known Subclasses:

WebArchiveImpl

public abstract class WebContainerBase<T extends Archive<T>>
extends ContainerBase<T>
implements WebContainer<T>

WebContainerBase Abstract class that helps implement the WebContainer. Used by specs that extends the WebContainer.

Version:

$Revision: $

Author:

Aslak Knutsen

Field Summary

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

DEFAULT_MANIFEST_NAME

Constructor Summary

protected

WebContainerBase(Class<T> actualType, Archive<?> archive)

Method Summary

T	addAsServiceProvider(Class<?> serviceInterface, Class<?>... serviceImpls)
T	addAsServiceProvider(String serviceInterface, String... serviceImpls)
T	addAsServiceProviderAndClasses(Class<?> serviceInterface, Class<?>... serviceImpls)
T	addAsWebInfResource(Asset resource, ArchivePath target)
T	addAsWebInfResource(Asset resource, String target)
T	addAsWebInfResource(File resource)
T	addAsWebInfResource(File resource, ArchivePath target)
T	addAsWebInfResource(File resource, String target)
T	addAsWebInfResource(Package resourcePackage, String resourceName)
T	addAsWebInfResource(Package resourcePackage, String resourceName, ArchivePath target)
T	addAsWebInfResource(Package resourcePackage, String resourceName, String target)
T	addAsWebInfResource(String resourceName)
T	addAsWebInfResource(String resourceName, ArchivePath target)
T	addAsWebInfResource(String resourceName, String target)
T	addAsWebInfResource(URL resource, ArchivePath target)
T	addAsWebInfResource(URL resource, String target)
T	addAsWebInfResources(Package resourcePackage, String... resourceNames)
T	addAsWebResource(Asset resource, ArchivePath target)
T	addAsWebResource(Asset resource, String target)
T	addAsWebResource(File resource)
T	addAsWebResource(File resource, ArchivePath target)
T	addAsWebResource(File resource, String target)
T	addAsWebResource(Package resourcePackage, String resourceName)
T	addAsWebResource(Package resourcePackage, String resourceName, ArchivePath target)
T	addAsWebResource(Package resourcePackage, String resourceName, String target)
T	addAsWebResource(String resourceName)
T	addAsWebResource(String resourceName, ArchivePath target)
T	addAsWebResource(String resourceName, String target)
T	addAsWebResource(URL resource, ArchivePath target)
T	addAsWebResource(URL resource, String target)
T	addAsWebResources(Package resourcePackage, String... resourceNames)
protected abstract ArchivePath	getServiceProvidersPath() Returns the path to web container service providers
protected abstract ArchivePath	getWebInfPath() Returns the path to WEB-INF
protected abstract ArchivePath	getWebPath() Returns the path to web resources
T	setWebXML(Asset resource)
T	setWebXML(File resource)
T	setWebXML(Package resourcePackage, String resourceName)
T	setWebXML(String resourceName)
T	setWebXML(URL resource)

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, 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, getClassesPath, getContent, getContent, getLibraryPath, getManifestPath, getName, getResourcePath, 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.Assignable

as

Constructor Detail

WebContainerBase

protected WebContainerBase(Class<T> actualType,
                           Archive<?> archive)

Method Detail

getWebPath

protected abstract ArchivePath getWebPath()

Returns the path to web resources

Returns:

Base Path for the web resources

getWebInfPath

protected abstract ArchivePath getWebInfPath()

Returns the path to WEB-INF

Returns:

the path to WEB-INF

getServiceProvidersPath

protected abstract ArchivePath getServiceProvidersPath()

Returns the path to web container service providers

Returns:

the path to web container service providers

setWebXML

public T setWebXML(String resourceName)
                               throws IllegalArgumentException

Specified by:

setWebXML in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

setWebXML

public T setWebXML(File resource)
                               throws IllegalArgumentException

Specified by:

setWebXML in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

setWebXML

public T setWebXML(URL resource)
                               throws IllegalArgumentException

Specified by:

setWebXML in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

setWebXML

public T setWebXML(Asset resource)
                               throws IllegalArgumentException

Specified by:

setWebXML in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

setWebXML

public T setWebXML(Package resourcePackage,
                   String resourceName)
                               throws IllegalArgumentException

Specified by:

setWebXML in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsWebResource

public T addAsWebResource(String resourceName)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsWebResource

public T addAsWebResource(File resource)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsWebResource

public T addAsWebResource(String resourceName,
                          String target)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsWebResource

public T addAsWebResource(File resource,
                          String target)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsWebResource

public T addAsWebResource(URL resource,
                          String target)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsWebResource

public T addAsWebResource(Asset resource,
                          String target)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsWebResource

public T addAsWebResource(String resourceName,
                          ArchivePath target)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsWebResource

public T addAsWebResource(File resource,
                          ArchivePath target)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebResource(java.io.File, org.jboss.shrinkwrap.api.ArchivePath)

addAsWebResource

public T addAsWebResource(URL resource,
                          ArchivePath target)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsWebResource

public T addAsWebResource(Asset resource,
                          ArchivePath target)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebResource(org.jboss.shrinkwrap.api.asset.Asset, org.jboss.shrinkwrap.api.ArchivePath)

addAsWebResources

public T addAsWebResources(Package resourcePackage,
                           String... resourceNames)
                                       throws IllegalArgumentException

Specified by:

addAsWebResources in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebResources(java.lang.Package, java.lang.String[])

addAsWebResource

public T addAsWebResource(Package resourcePackage,
                          String resourceName)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsWebResource

public T addAsWebResource(Package resourcePackage,
                          String resourceName,
                          String target)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsWebResource

public T addAsWebResource(Package resourcePackage,
                          String resourceName,
                          ArchivePath target)
                                      throws IllegalArgumentException

Specified by:

addAsWebResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsWebInfResource

public T addAsWebInfResource(String resourceName)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(java.lang.String)

addAsWebInfResource

public T addAsWebInfResource(File resource)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(java.io.File)

addAsWebInfResource

public T addAsWebInfResource(String resourceName,
                             String target)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(java.lang.String, java.lang.String)

addAsWebInfResource

public T addAsWebInfResource(File resource,
                             String target)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(java.io.File, java.lang.String)

addAsWebInfResource

public T addAsWebInfResource(URL resource,
                             String target)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(java.net.URL, java.lang.String)

addAsWebInfResource

public T addAsWebInfResource(Asset resource,
                             String target)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(org.jboss.shrinkwrap.api.asset.Asset, java.lang.String)

addAsWebInfResource

public T addAsWebInfResource(String resourceName,
                             ArchivePath target)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(java.lang.String, org.jboss.shrinkwrap.api.ArchivePath)

addAsWebInfResource

public T addAsWebInfResource(File resource,
                             ArchivePath target)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(java.io.File, org.jboss.shrinkwrap.api.ArchivePath)

addAsWebInfResource

public T addAsWebInfResource(URL resource,
                             ArchivePath target)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(java.net.URL, org.jboss.shrinkwrap.api.ArchivePath)

addAsWebInfResource

public T addAsWebInfResource(Asset resource,
                             ArchivePath target)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(org.jboss.shrinkwrap.api.asset.Asset, org.jboss.shrinkwrap.api.ArchivePath)

addAsWebInfResources

public T addAsWebInfResources(Package resourcePackage,
                              String... resourceNames)
                                          throws IllegalArgumentException

Specified by:

addAsWebInfResources in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResources(java.lang.Package, java.lang.String[])

addAsWebInfResource

public T addAsWebInfResource(Package resourcePackage,
                             String resourceName)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(java.lang.Package, java.lang.String)

addAsWebInfResource

public T addAsWebInfResource(Package resourcePackage,
                             String resourceName,
                             String target)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(java.lang.Package, java.lang.String, java.lang.String)

addAsWebInfResource

public T addAsWebInfResource(Package resourcePackage,
                             String resourceName,
                             ArchivePath target)
                                         throws IllegalArgumentException

Specified by:

addAsWebInfResource in interface WebContainer<T extends Archive<T>>

Throws:

IllegalArgumentException

See Also:

WebContainer.addAsWebInfResource(java.lang.Package, java.lang.String, org.jboss.shrinkwrap.api.ArchivePath)

addAsServiceProvider

public T addAsServiceProvider(Class<?> serviceInterface,
                              Class<?>... serviceImpls)
                                          throws IllegalArgumentException

Specified by:

addAsServiceProvider in interface ManifestContainer<T extends Archive<T>>

Overrides:

addAsServiceProvider in class ContainerBase<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsServiceProvider

public T addAsServiceProvider(String serviceInterface,
                              String... serviceImpls)
                                          throws IllegalArgumentException

Specified by:

addAsServiceProvider in interface ManifestContainer<T extends Archive<T>>

Overrides:

addAsServiceProvider in class ContainerBase<T extends Archive<T>>

Throws:

IllegalArgumentException

addAsServiceProviderAndClasses

public T addAsServiceProviderAndClasses(Class<?> serviceInterface,
                                        Class<?>... serviceImpls)
                                                    throws IllegalArgumentException

Specified by:

addAsServiceProviderAndClasses in interface ServiceProviderContainer<T extends Archive<T>>

Overrides:

addAsServiceProviderAndClasses in class ContainerBase<T extends Archive<T>>

Throws:

IllegalArgumentException