org.jboss.shrinkwrap.api.container

Interface EnterpriseContainer<T extends Archive<T>>

All Known Subinterfaces:

EnterpriseArchive

public interface EnterpriseContainer<T extends Archive<T>>

Defines the contract for a component capable of storing Enterprise related resources.

The actual path to the Enterprise resources within the Archive is up to the implementations/specifications.

Version:

$Revision: $

Author:

Aslak Knutsen

Method Summary

Modifier and Type	Method and Description
T	addAsApplicationResource(Asset resource, ArchivePath target) Adds a Asset to this Archives application context.
T	addAsApplicationResource(Asset resource, String target) Adds a Asset to this Archives application context.
T	addAsApplicationResource(File resource) Adds a File to this Archives application context.
T	addAsApplicationResource(File resource, ArchivePath target) Adds a File to this Archives application context.
T	addAsApplicationResource(File resource, String target) Adds a File to this Archives application context.
T	addAsApplicationResource(Package resourcePackage, String resourceName) Adds the resource as a resource to the container, returning the container itself.
T	addAsApplicationResource(Package resourcePackage, String resourceName, ArchivePath target) Adds the resource as a resource to a specific path inside the container, returning the container itself.
T	addAsApplicationResource(Package resourcePackage, String resourceName, String target) Adds the resource as a resource to a specific path inside the container, returning the container itself.
T	addAsApplicationResource(String resourceName) Adds a resource to this Archives application context.
T	addAsApplicationResource(String resourceName, ArchivePath target) Adds a resource to this Archives application context.
T	addAsApplicationResource(String resourceName, String target) Adds a resource to this Archives application context.
T	addAsApplicationResource(URL resource, ArchivePath target) Adds a URL to this Archives application context.
T	addAsApplicationResource(URL resource, String target) Adds a URL to this Archives application context.
T	addAsApplicationResources(Package resourcePackage, String... resourceNames) Adds the resources inside the package as multiple resources to the container, returning the container itself.
T	addAsModule(Archive<?> archive) Adds an archive to this Archives module context.
T	addAsModule(Asset resource, ArchivePath targetPath) Adds a Asset to this Archives module context.
T	addAsModule(Asset resource, String targetPath) Adds a Asset to this Archives module context.
T	addAsModule(File resource) Adds a File to this Archives module context.
T	addAsModule(File resource, ArchivePath targetPath) Adds a File to this Archives module context.
T	addAsModule(File resource, String targetPath) Adds a File to this Archives module context.
T	addAsModule(String resourceName) Adds a resource to this Archives module context.
T	addAsModule(String resourceName, ArchivePath targetPath) Adds a resource to this Archives module context.
T	addAsModule(String resourceName, String targetPath) Adds a resource to this Archives module context.
T	addAsModule(URL resource, ArchivePath targetPath) Adds a URL to this Archives module context.
T	addAsModule(URL resource, String targetPath) Adds a URL to this Archives module context.
T	addAsModules(Archive<?>... archives) Adds the specified archives to this Archives module context.
T	addAsModules(File... resources) Adds the specified Files to this Archives module context.
T	addAsModules(String... resourceNames) Adds the specified resources to this Archives module context.
T	setApplicationXML(Asset resource) Adds a Asset to this Archive as application.xml.
T	setApplicationXML(File resource) Adds a File to this Archive as application.xml.
T	setApplicationXML(Package resourcePackage, String resourceName) Adds a resource inside the package to this Archive as application.xml.
T	setApplicationXML(String resourceName) Adds a resource to this Archive as application.xml.
T	setApplicationXML(URL resource) Adds a URL to this Archive as application.xml.

Method Detail

setApplicationXML

T setApplicationXML(String resourceName)
             throws IllegalArgumentException

Adds a resource to this Archive as application.xml.

The ClassLoader used to obtain the resource is up to the implementation.
For instance a resourceName of "test/example.xml" could be placed in "/META-INF/application.xml"

Parameters:

resourceName - Name of the ClassLoader resource to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resourceName is null

See Also:

setApplicationXML(Asset)

setApplicationXML

T setApplicationXML(File resource)
             throws IllegalArgumentException

Adds a File to this Archive as application.xml.

For instance a File "test/example.xml" could be placed in "/META-INF/application.xml"

Parameters:

resource - File resource to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

See Also:

setApplicationXML(Asset)

setApplicationXML

T setApplicationXML(URL resource)
             throws IllegalArgumentException

Adds a URL to this Archive as application.xml.

For instance a URL "http://my.com/example.xml" could be placed in "/META-INF/application.xml"

Parameters:

resource - URL resource to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

See Also:

setApplicationXML(Asset)

setApplicationXML

T setApplicationXML(Asset resource)
             throws IllegalArgumentException

Adds a Asset to this Archive as application.xml.

Parameters:

resource - Asset resource to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

setApplicationXML

T setApplicationXML(Package resourcePackage,
                    String resourceName)
             throws IllegalArgumentException

Adds a resource inside the package to this Archive as application.xml.

The ClassLoader used to obtain the resource is up to the implementation.

Parameters:

resourcePackage - The package of the resources

resourceName - The name of the resource inside resourcePackage

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resourcePackage is null

IllegalArgumentException - if resourceName is null

See Also:

setApplicationXML(String)

addAsApplicationResource

T addAsApplicationResource(String resourceName)
                    throws IllegalArgumentException

Adds a resource to this Archives application context.

The ClassLoader used to obtain the resource is up to the implementation.
For instance a resourceName of "test/example.xml" could be placed in "/META-INF/test/example.xml"

Parameters:

resourceName - Name of the ClassLoader resource to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resourceName is null

See Also:

addAsApplicationResource(Asset, ArchivePath)

addAsApplicationResource

T addAsApplicationResource(File resource)
                    throws IllegalArgumentException

Adds a File to this Archives application context.

For instance a File of "test/example.xml" could be placed in "/META-INF/test/example.xml"

Parameters:

resource - File resource to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

See Also:

addAsApplicationResource(Asset, ArchivePath)

addAsApplicationResource

T addAsApplicationResource(String resourceName,
                           String target)
                    throws IllegalArgumentException

Adds a resource to this Archives application context.

The ClassLoader used to obtain the resource is up to the implementation.
For instance a resourceName of "test/example.xml" and a target of "example/myexample.xml" could be placed in "/META-INF/example/myexample.xml"

Parameters:

resourceName - Name of the ClassLoader resource to add

target - The target relative to application path within the archive into which we'll place the resource

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

IllegalArgumentException - if target is null

See Also:

addAsApplicationResource(Asset, ArchivePath)

addAsApplicationResource

T addAsApplicationResource(File resource,
                           String target)
                    throws IllegalArgumentException

Adds a File to this Archives application context.

For instance a File of "test/example.xml" and a target of "example/myexample.xml" could be placed in "/META-INF/example/myexample.xml"

Parameters:

resource - File resource to add

target - The target relative to application path within the archive into which we'll place the resource

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

IllegalArgumentException - if target is null

See Also:

addAsApplicationResource(Asset, ArchivePath)

addAsApplicationResource

T addAsApplicationResource(URL resource,
                           String target)
                    throws IllegalArgumentException

Adds a URL to this Archives application context.


For instance a URL of "http://my.com/example.xml" and a target of "example/myexample.xml" could be placed in "/META-INF/example/myexample.xml"

Parameters:

resource - URL resource to add

target - The target relative to application path within the archive into which we'll place the resource

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

IllegalArgumentException - if target is null

See Also:

addAsApplicationResource(Asset, ArchivePath)

addAsApplicationResource

T addAsApplicationResource(Asset resource,
                           String target)
                    throws IllegalArgumentException

Adds a Asset to this Archives application context.

Parameters:

resource - Asset resource to add

target - The target relative to application path within the archive into which we'll place the resource

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

IllegalArgumentException - if target is null

See Also:

addAsApplicationResource(Asset, ArchivePath)

addAsApplicationResource

T addAsApplicationResource(String resourceName,
                           ArchivePath target)
                    throws IllegalArgumentException

Adds a resource to this Archives application context.

The ClassLoader used to obtain the resource is up to the implementation.
For instance a resourceName of "test/example.xml" and a target of "example/myexample.xml" could be placed in "/META-INF/example/myexample.xml"

Parameters:

resourceName - Name of the ClassLoader resource to add

target - The target relative to application path within the archive into which we'll place the resource

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resourceName is null

IllegalArgumentException - if target is null

See Also:

addAsApplicationResource(Asset, ArchivePath)

addAsApplicationResource

T addAsApplicationResource(File resource,
                           ArchivePath target)
                    throws IllegalArgumentException

Adds a File to this Archives application context.

For instance a File of "test/example.xml" and a target of "example/myexample.xml" could be placed in "/META-INF/example/myexample.xml"

Parameters:

resource - File resource to add

target - The target relative to application path within the archive into which we'll place the resource

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

IllegalArgumentException - if target is null

See Also:

addAsApplicationResource(Asset, ArchivePath)

addAsApplicationResource

T addAsApplicationResource(URL resource,
                           ArchivePath target)
                    throws IllegalArgumentException

Adds a URL to this Archives application context.

For instance a File of "test/example.xml" and a target of "example/myexample.xml" could be placed in "/META-INF/example/myexample.xml"

Parameters:

resource - URL resource to add

target - The target relative to application path within the archive into which we'll place the resource

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

IllegalArgumentException - if target is null

See Also:

addAsApplicationResource(Asset, ArchivePath)

addAsApplicationResource

T addAsApplicationResource(Asset resource,
                           ArchivePath target)
                    throws IllegalArgumentException

Adds a Asset to this Archives application context.

Parameters:

resource - Asset resource to add

target - The target relative to application path within the archive into which we'll place the resource

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

IllegalArgumentException - if target is null

addAsApplicationResources

T addAsApplicationResources(Package resourcePackage,
                            String... resourceNames)
                     throws IllegalArgumentException

Adds the resources inside the package as multiple resources to the container, returning the container itself.

The ClassLoader used to obtain the resource is up to the implementation.

Parameters:

resourcePackage - The package of the resources

resourceNames - The names of the resources inside resourcePackage

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resourcePackage is null

IllegalArgumentException - if no resourceNames are specified or containing null

addAsApplicationResource

T addAsApplicationResource(Package resourcePackage,
                           String resourceName)
                    throws IllegalArgumentException

Adds the resource as a resource to the container, returning the container itself.

The ClassLoader used to obtain the resource is up to the implementation.

Parameters:

resourcePackage - The package of the resource

resourceName - The name of the resource inside resourcePackage

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resourcePackage is null

IllegalArgumentException - if resourceName is null

addAsApplicationResource

T addAsApplicationResource(Package resourcePackage,
                           String resourceName,
                           String target)
                    throws IllegalArgumentException

Adds the resource as a resource to a specific path inside the container, returning the container itself.

The ClassLoader used to obtain the resource is up to the implementation.

Parameters:

resourcePackage - The package of the resource

resourceName - The name of the resource inside resourcePackage

target - The target location inside the container

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resourcePackage is null

IllegalArgumentException - if resourceName is null

IllegalArgumentException - if target is null

addAsApplicationResource

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

Adds the resource as a resource to a specific path inside the container, returning the container itself.

The ClassLoader used to obtain the resource is up to the implementation.

Parameters:

resourcePackage - The package of the resource

resourceName - The name of the resource inside resourcePackage

target - The target location inside the container

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resourcePackage is null

IllegalArgumentException - if resourceName is null

IllegalArgumentException - if target is null

addAsModule

T addAsModule(Archive<?> archive)
       throws IllegalArgumentException

Adds an archive to this Archives module context.

The Archive name is used as path.

Parameters:

archive - The archive to use

Returns:

This virtual archive

Throws:

IllegalArgumentException - if archive is null

addAsModules

T addAsModules(Archive<?>... archives)
        throws IllegalArgumentException

Adds the specified archives to this Archives module context.

The Archive names are used as paths.

Parameters:

archives - The archives to use

Returns:

This virtual archive

Throws:

IllegalArgumentException - if not archives are specified

addAsModule

T addAsModule(String resourceName)
       throws IllegalArgumentException

Adds a resource to this Archives module context.
The resource name is used as path.

Parameters:

resourceName - Name of the ClassLoader resource to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resourceName is null

See Also:

addAsModule(Asset, ArchivePath)

addAsModules

T addAsModules(String... resourceNames)
        throws IllegalArgumentException

Adds the specified resources to this Archives module context.
The resource names are used as paths.

Parameters:

resourceNames - Names of the ClassLoader resources to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resourceNames are not specified

See Also:

addAsModule(Asset, ArchivePath)

addAsModule

T addAsModule(File resource)
       throws IllegalArgumentException

Adds a File to this Archives module context.
The File name is used as path.

Parameters:

resource - File resource to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

See Also:

addAsModule(Asset, ArchivePath)

addAsModules

T addAsModules(File... resources)
        throws IllegalArgumentException

Adds the specified Files to this Archives module context.
The File names are used as paths.

Parameters:

resources - File resources to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resources are not specified

See Also:

addAsModule(Asset, ArchivePath)

addAsModule

T addAsModule(String resourceName,
              String targetPath)
       throws IllegalArgumentException

Adds a resource to this Archives module context.

Parameters:

resourceName - Name of the ClassLoader resource to add

targetPath - The target path within the archive in which to add the resource, relative to the Archives module path.

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resourceName is null

IllegalArgumentException - if targetPath is null

See Also:

addAsModule(Asset, ArchivePath)

addAsModule

T addAsModule(File resource,
              String targetPath)
       throws IllegalArgumentException

Adds a File to this Archives module context.

Parameters:

resource - File resource to add

targetPath - The target path within the archive in which to add the resource, relative to the Archives module path.

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

IllegalArgumentException - if targetPath is null

See Also:

addAsModule(Asset, ArchivePath)

addAsModule

T addAsModule(URL resource,
              String targetPath)
       throws IllegalArgumentException

Adds a URL to this Archives module context.

Parameters:

resource - URL resource to add

targetPath - The target path within the archive in which to add the resource, relative to the Archives module path.

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

IllegalArgumentException - if targetPath is null

See Also:

addAsModule(Asset, ArchivePath)

addAsModule

T addAsModule(Asset resource,
              String targetPath)
       throws IllegalArgumentException

Adds a Asset to this Archives module context.

Parameters:

resource - Asset resource to add

targetPath - The target path within the archive in which to add the resource, relative to the Archives module path.

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

IllegalArgumentException - if targetPath is null

See Also:

addAsModule(Asset, ArchivePath)

addAsModule

T addAsModule(String resourceName,
              ArchivePath targetPath)
       throws IllegalArgumentException

Adds a resource to this Archives module context.

Parameters:

resourceName - Name of the ClassLoader resource to add

targetPath - The target path within the archive in which to add the resource, relative to the Archives module path.

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resourceName is null

IllegalArgumentException - if targetPath is null

See Also:

addAsModule(Asset, ArchivePath)

addAsModule

T addAsModule(File resource,
              ArchivePath targetPath)
       throws IllegalArgumentException

Adds a File to this Archives module context.

Parameters:

resource - File resource to add

targetPath - The target path within the archive in which to add the resource, relative to the Archives module path.

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

IllegalArgumentException - if targetPath is null

See Also:

addAsModule(Asset, ArchivePath)

addAsModule

T addAsModule(URL resource,
              ArchivePath targetPath)
       throws IllegalArgumentException

Adds a URL to this Archives module context.

Parameters:

resource - URL resource to add

targetPath - The target path within the archive in which to add the resource, relative to the Archives module path.

Returns:

This virtual archive

Throws:

IllegalArgumentException - if resource is null

IllegalArgumentException - if targetPath is null

See Also:

addAsModule(Asset, ArchivePath)

addAsModule

T addAsModule(Asset resource,
              ArchivePath targetPath)
       throws IllegalArgumentException

Adds a Asset to this Archives module context.

Parameters:

resource - URL resource to add

targetPath - The target path within the archive in which to add the resource, relative to the Archives module path.

Returns:

This virtual archive

Throws:

IllegalArgumentException - if targetPath is null

IllegalArgumentException - if resource is null