org.shrinkwrap.springboot.api.container

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

All Known Subinterfaces:

SpringBootArchive

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

Defines the contract for a component capable of storing spring-boot-related resources. The actual path to the BOOT-INF resources within the Archive is up to the implementations/specifications.

Author:

Ramon Rivas

Method Summary

Modifier and Type	Method and Description
T	addAsBootInfResource(org.jboss.shrinkwrap.api.asset.Asset resource, org.jboss.shrinkwrap.api.ArchivePath target) Adds the Asset as a BOOT-INF resource to the container, returning the container itself.
T	addAsBootInfResource(org.jboss.shrinkwrap.api.asset.Asset resource, String target) Adds the Asset as a BOOT-INF resource to the container, returning the container itself.
T	addAsBootInfResource(File resource) Adds the File as a BOOT-INF resource to the container, returning the container itself.
T	addAsBootInfResource(File resource, org.jboss.shrinkwrap.api.ArchivePath target) Adds the File as a BOOT-INF resource to the container, returning the container itself.
T	addAsBootInfResource(File resource, String target) Adds the File as a BOOT-INF resource to the container, returning the container itself.
T	addAsBootInfResource(Package resourcePackage, String resourceName) Adds the resource as a BOOT-INF resource to the container, returning the container itself.
T	addAsBootInfResource(Package resourcePackage, String resourceName, org.jboss.shrinkwrap.api.ArchivePath target) Adds the resource as a BOOT-INF resource to a specific path inside the container, returning the container itself.
T	addAsBootInfResource(Package resourcePackage, String resourceName, String target) Adds the resource as a BOOT-INF resource to a specific path inside the container, returning the container itself.
T	addAsBootInfResource(String resourceName) Adds the resource as a BOOT-INF resource to the container, returning the container itself.
T	addAsBootInfResource(String resourceName, org.jboss.shrinkwrap.api.ArchivePath target) Adds the resource as a BOOT-INF resource to the container, returning the container itself.
T	addAsBootInfResource(String resourceName, String target) Adds the resource as a BOOT-INF resource to the container, returning the container itself.
T	addAsBootInfResource(URL resource, org.jboss.shrinkwrap.api.ArchivePath target) Adds the URL as a BOOT-INF resource to the container, returning the container itself.
T	addAsBootInfResource(URL resource, String target) Adds the URL as a BOOT-INF resource to the container, returning the container itself.
T	addAsBootInfResources(Package resourcePackage, String... resourceNames) Adds the resources inside the package as multiple BOOT-INF resources to the container, returning the container itself.
T	addAsLauncherLibraries(org.jboss.shrinkwrap.api.Archive<?>... archives) Add multiple Archives to this Archive as launcher libraries, returning the container itself.
T	addAsLauncherLibraries(org.jboss.shrinkwrap.api.Archive<?>[]... archives) Add multiple Archives to this Archive as llauncher libraries, returning the container itself.
T	addAsLauncherLibraries(Collection<? extends org.jboss.shrinkwrap.api.Archive<?>> archives) Add multiple Archives to this Archive as launcher libraries, returning the container itself.
T	addAsLauncherLibrary(org.jboss.shrinkwrap.api.Archive<?> archive) Add another Archive to this Archive as a launcher library, returning the container itself.
T	addDefaultLauncherPackage() Adds all classes in the default Package to the Archive as part of the launcher class path. SubPackages are excluded.
T	addLauncherClass(Class<?> clazz) Adds the Class, and all member (inner) Classes to the Archive as part of the launcher class path.
T	addLauncherClass(String fullyQualifiedClassName) Adds the Class, and all member (inner) Classes, with the specified fully-qualified name, loaded by the Thread Context ClassLoader, to the Archive as part of the launcher class path.
T	addLauncherClass(String fullyQualifiedClassName, ClassLoader cl) Adds the Class, and all member (inner) @link{Class}es, with the specified fully-qualified name, loaded by the specified ClassLoader, to the Archive as part of the launcher class path.
T	addLauncherClasses(Class<?>... classes) Adds the Classes, and all member (inner) Classes to the Archive as part of the launcher class path.
T	addLauncherPackage(String pack) Adds all classes in the specified Package to the Archive as part of the launcher class path. SubPackages are excluded.
T	addLauncherPackages(boolean recursive, org.jboss.shrinkwrap.api.Filter<org.jboss.shrinkwrap.api.ArchivePath> filter, Package... packages) Adds all classes accepted by the filter in the specified Packages to the Archive as part of the launcher class path. The ArchivePath returned to the filter is the ArchivePath of the class, not the final location.
T	addLauncherPackages(boolean recursive, org.jboss.shrinkwrap.api.Filter<org.jboss.shrinkwrap.api.ArchivePath> filter, String... packages) Adds all classes accepted by the filter in the specified Packages to the Archive as part of the launcher class path. The ArchivePath returned to the filter is the ArchivePath of the class, not the final location.
T	addLauncherPackages(boolean recursive, Package... packages) Adds all classes in the specified Packages to the Archive as part of the launcher class path.
T	addLauncherPackages(boolean recursive, String... packages) Adds all classes in the specified Packages to the Archive as part of the launcher class path.
T	addPackage(Package pack) Adds all classes in the specified Package to the Archive as part of the launcher class path. SubPackages are excluded.
T	deleteDefaultLauncherPackage() Deletes all classes in the default Package from the Archive launcher class path. SubPackages are excluded.
T	deleteLauncherClass(Class<?> clazz) Deletes the Class, and all member (inner) Classes from the Archive launcher class path.
T	deleteLauncherClass(String fullyQualifiedClassName) Deletes the Class, and all member (inner) Classes, with the specified fully-qualified name, loaded by the Thread Context ClassLoader, from the Archive launcher class path.
T	deleteLauncherClasses(Class<?>... classes) Deletes the Classes, and all member (inner) Classes from the Archive launcher class path.
T	deleteLauncherPackage(Package pack) Deletes all classes in the specified Package from the Archive launcher class path. SubPackages are excluded.
T	deleteLauncherPackage(String pack) Deletes all classes in the specified Package from the Archive launcher class path. SubPackages are excluded.
T	deleteLauncherPackages(boolean recursive, org.jboss.shrinkwrap.api.Filter<org.jboss.shrinkwrap.api.ArchivePath> filter, Package... packages) Deletes all classes accepted by the filter in the specified Packages from the Archive launcher class path. The ArchivePath returned to the filter is the ArchivePath of the class, not the final location.
T	deleteLauncherPackages(boolean recursive, org.jboss.shrinkwrap.api.Filter<org.jboss.shrinkwrap.api.ArchivePath> filter, String... packages) Delete all classes accepted by the filter in the specified Packages from the Archive launcher class path. The ArchivePath returned to the filter is the ArchivePath of the class, not the final location.
T	deleteLauncherPackages(boolean recursive, Package... packages) Deletes all classes in the specified Packages from the Archive launcher class path.
T	deleteLauncherPackages(boolean recursive, String... packages) Delete all classes in the specified Packages from the Archive launcher class path.
T	setSpringBootLayout(SpringBootLayout layout)
T	setSpringBootManifest(String applicationClassName)
T	setSpringBootManifest(String applicationClassName, String springBootVersion)

Method Detail

setSpringBootLayout

T setSpringBootLayout(SpringBootLayout layout)

setSpringBootManifest

T setSpringBootManifest(String applicationClassName)

setSpringBootManifest

T setSpringBootManifest(String applicationClassName,
                        String springBootVersion)

addAsBootInfResource

T addAsBootInfResource(String resourceName)
                throws IllegalArgumentException

Adds the resource as a BOOT-INF resource to the container, returning the container itself.

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

Parameters:

resourceName - resource to add

Returns:

This Archive

Throws:

IllegalArgumentException - if resourceName is not specified

addAsBootInfResource

T addAsBootInfResource(File resource)
                throws IllegalArgumentException

Adds the File as a BOOT-INF resource to the container, returning the container itself.
The File will be placed into the Container BOOT-INF path under File.getName().

Parameters:

resource - Resource to add

Returns:

This Archive

Throws:

IllegalArgumentException - if File resource is null

addAsBootInfResource

T addAsBootInfResource(String resourceName,
                       String target)
                throws IllegalArgumentException

Adds the resource as a BOOT-INF resource to the container, returning the container itself.
The ClassLoader used to obtain the resource is up to the implementation.

Parameters:

resourceName - resource to add

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

Returns:

This Archive

Throws:

IllegalArgumentException - if resourceName or target is not specified

addAsBootInfResource

T addAsBootInfResource(File resource,
                       String target)
                throws IllegalArgumentException

Adds the File as a BOOT-INF resource to the container, returning the container itself.

Parameters:

resource - File resource to add

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

Returns:

This Archive

Throws:

IllegalArgumentException - If the resource or target is not specified

addAsBootInfResource

T addAsBootInfResource(URL resource,
                       String target)
                throws IllegalArgumentException

Adds the URL as a BOOT-INF resource to the container, returning the container itself.

Parameters:

resource - URL resource to add

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

Returns:

This Archive

Throws:

IllegalArgumentException - If the resource or target is not specified

addAsBootInfResource

T addAsBootInfResource(org.jboss.shrinkwrap.api.asset.Asset resource,
                       String target)
                throws IllegalArgumentException

Adds the Asset as a BOOT-INF resource to the container, returning the container itself.

Parameters:

resource - Asset resource to add

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

Returns:

This Archive

Throws:

IllegalArgumentException - If the resource or target is not specified

addAsBootInfResource

T addAsBootInfResource(String resourceName,
                       org.jboss.shrinkwrap.api.ArchivePath target)
                throws IllegalArgumentException

Adds the resource as a BOOT-INF resource to the container, returning the container itself.

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

Parameters:

resourceName - resource to add

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

Returns:

This Archive

Throws:

IllegalArgumentException - If the resource or target is not specified

addAsBootInfResource

T addAsBootInfResource(File resource,
                       org.jboss.shrinkwrap.api.ArchivePath target)
                throws IllegalArgumentException

Adds the File as a BOOT-INF resource to the container, returning the container itself.

Parameters:

resource - File resource to add

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

Returns:

This Archive

Throws:

IllegalArgumentException - If the resource or target is not specified

addAsBootInfResource

T addAsBootInfResource(URL resource,
                       org.jboss.shrinkwrap.api.ArchivePath target)
                throws IllegalArgumentException

Adds the URL as a BOOT-INF resource to the container, returning the container itself.

Parameters:

resource - URL resource to add

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

Returns:

This Archive

Throws:

IllegalArgumentException - If the resource or target is not specified

addAsBootInfResource

T addAsBootInfResource(org.jboss.shrinkwrap.api.asset.Asset resource,
                       org.jboss.shrinkwrap.api.ArchivePath target)
                throws IllegalArgumentException

Adds the Asset as a BOOT-INF resource to the container, returning the container itself.

Parameters:

resource - Asset resource to add

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

Returns:

This Archive

Throws:

IllegalArgumentException - If the resource or target is not specified

addAsBootInfResources

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

Adds the resources inside the package as multiple BOOT-INF 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 Archive

Throws:

IllegalArgumentException - If resourcePackage is null, or if no resourceNames are specified or containing null

addAsBootInfResource

T addAsBootInfResource(Package resourcePackage,
                       String resourceName)
                throws IllegalArgumentException

Adds the resource as a BOOT-INF 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 Archive

Throws:

IllegalArgumentException - If the package or resource name is not specified

addAsBootInfResource

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

Adds the resource as a BOOT-INF 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 resoucePackage

target - The target location inside the container

Returns:

This Archive

Throws:

IllegalArgumentException - If the package, resource name, or target is not specified

addAsBootInfResource

T addAsBootInfResource(Package resourcePackage,
                       String resourceName,
                       org.jboss.shrinkwrap.api.ArchivePath target)
                throws IllegalArgumentException

Adds the resource as a BOOT-INF 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 resoucePackage

target - The target location inside the container

Returns:

This Archive

Throws:

IllegalArgumentException - If the package, resource name, or target is not specified

addLauncherClass

T addLauncherClass(Class<?> clazz)
            throws IllegalArgumentException

Adds the Class, and all member (inner) Classes to the Archive as part of the launcher class path.

Parameters:

clazz - The class to add to the Archive

Returns:

This archive

Throws:

IllegalArgumentException - If no class were specified

addLauncherClass

T addLauncherClass(String fullyQualifiedClassName)
            throws IllegalArgumentException

Adds the Class, and all member (inner) Classes, with the specified fully-qualified name, loaded by the Thread Context ClassLoader, to the Archive as part of the launcher class path.

Parameters:

fullyQualifiedClassName - The name of the Class to add

Returns:

This archive

Throws:

IllegalArgumentException - If no class name was specified

IllegalArgumentException - If the Class could not be loaded

addLauncherClass

T addLauncherClass(String fullyQualifiedClassName,
                   ClassLoader cl)
            throws IllegalArgumentException

Adds the Class, and all member (inner) @link{Class}es, with the specified fully-qualified name, loaded by the specified ClassLoader, to the Archive as part of the launcher class path.

Parameters:

fullyQualifiedClassName - The name of the Class to add

cl - The ClassLoader used to load the Class

Returns:

This archive

Throws:

IllegalArgumentException - If no class name was specified

IllegalArgumentException - If no ClassLoader was specified

IllegalArgumentException - If the Class could not be loaded by the target ClassLoader

addLauncherClasses

T addLauncherClasses(Class<?>... classes)
              throws IllegalArgumentException

Adds the Classes, and all member (inner) Classes to the Archive as part of the launcher class path.

Parameters:

classes - The classes to add to the Archive

Returns:

This archive

Throws:

IllegalArgumentException - If no classes were specified

addPackage

T addPackage(Package pack)
      throws IllegalArgumentException

Adds all classes in the specified Package to the Archive as part of the launcher class path.
SubPackages are excluded.

Parameters:

pack - The Package to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - If no package were specified

See Also:

addLauncherPackages(boolean, Package...)

addDefaultLauncherPackage

T addDefaultLauncherPackage()

Adds all classes in the default Package to the Archive as part of the launcher class path.
SubPackages are excluded.

Returns:

This virtual archive

addLauncherPackages

T addLauncherPackages(boolean recursive,
                      Package... packages)
               throws IllegalArgumentException

Adds all classes in the specified Packages to the Archive as part of the launcher class path.

Parameters:

recursive - Should the sub packages be added

packages - All the packages to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - If no packages were specified

See Also:

addLauncherPackages(boolean, Filter, Package...)

addLauncherPackages

T addLauncherPackages(boolean recursive,
                      org.jboss.shrinkwrap.api.Filter<org.jboss.shrinkwrap.api.ArchivePath> filter,
                      Package... packages)
               throws IllegalArgumentException

Adds all classes accepted by the filter in the specified Packages to the Archive as part of the launcher class path.
The ArchivePath returned to the filter is the ArchivePath of the class, not the final location.
package.MyClass = /package/MyClass.class
not: package.MyClass = /WEB-INF/classes/package/MyClass.class

Parameters:

recursive - Should the sub packages be added

filter - filter out specific classes

packages - All the packages to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - If no packages were specified

addLauncherPackage

T addLauncherPackage(String pack)
              throws IllegalArgumentException

Adds all classes in the specified Package to the Archive as part of the launcher class path.
SubPackages are excluded.

Parameters:

pack - Package to add represented by a String ("my/package")

Returns:

This virtual archive

Throws:

IllegalArgumentException - If no package were specified

See Also:

addLauncherPackages(boolean, Package...)

addLauncherPackages

T addLauncherPackages(boolean recursive,
                      String... packages)
               throws IllegalArgumentException

Adds all classes in the specified Packages to the Archive as part of the launcher class path.

Parameters:

recursive - Should the sub packages be added

packages - All the packages to add represented by a String ("my/package")

Returns:

This virtual archive

Throws:

IllegalArgumentException - If no packages were specified

See Also:

addLauncherPackages(boolean, Filter, Package...)

addLauncherPackages

T addLauncherPackages(boolean recursive,
                      org.jboss.shrinkwrap.api.Filter<org.jboss.shrinkwrap.api.ArchivePath> filter,
                      String... packages)
               throws IllegalArgumentException

Adds all classes accepted by the filter in the specified Packages to the Archive as part of the launcher class path.
The ArchivePath returned to the filter is the ArchivePath of the class, not the final location.
package.MyClass = /package/MyClass.class
not: package.MyClass = /WEB-INF/classes/package/MyClass.class

Parameters:

recursive - Should the sub packages be added

filter - filter out specific classes

packages - All the packages to add represented by a String ("my/package")

Returns:

This virtual archive

Throws:

IllegalArgumentException - If no packages were specified

deleteLauncherClass

T deleteLauncherClass(Class<?> clazz)
               throws IllegalArgumentException

Deletes the Class, and all member (inner) Classes from the Archive launcher class path.

Parameters:

clazz - The class to be deleted from the Archive

Returns:

This archive

Throws:

IllegalArgumentException - If no class was specified

deleteLauncherClass

T deleteLauncherClass(String fullyQualifiedClassName)
               throws IllegalArgumentException

Deletes the Class, and all member (inner) Classes, with the specified fully-qualified name, loaded by the Thread Context ClassLoader, from the Archive launcher class path.

Parameters:

fullyQualifiedClassName - The name of the Class to be deleted

Returns:

This archive

Throws:

IllegalArgumentException - If no class name was specified

IllegalArgumentException - If the Class could not be loaded

deleteLauncherClasses

T deleteLauncherClasses(Class<?>... classes)
                 throws IllegalArgumentException

Deletes the Classes, and all member (inner) Classes from the Archive launcher class path.

Parameters:

classes - The classes to be removed from the Archive

Returns:

This archive

Throws:

IllegalArgumentException - If no classes were specified

deleteLauncherPackage

T deleteLauncherPackage(Package pack)
                 throws IllegalArgumentException

Deletes all classes in the specified Package from the Archive launcher class path.
SubPackages are excluded.

Parameters:

pack - The Package to be deleted

Returns:

This archive

Throws:

IllegalArgumentException - If no package was specified

See Also:

deleteLauncherPackages(boolean, Package...)

deleteLauncherPackage

T deleteLauncherPackage(String pack)
                 throws IllegalArgumentException

Deletes all classes in the specified Package from the Archive launcher class path.
SubPackages are excluded.

Parameters:

pack - Package to be delete represented by a String ("my/package")

Returns:

This archive

Throws:

IllegalArgumentException - If no package was specified

See Also:

deleteLauncherPackages(boolean, Package...)

deleteDefaultLauncherPackage

T deleteDefaultLauncherPackage()

Deletes all classes in the default Package from the Archive launcher class path.
SubPackages are excluded.

Returns:

This archive

deleteLauncherPackages

T deleteLauncherPackages(boolean recursive,
                         Package... packages)
                  throws IllegalArgumentException

Deletes all classes in the specified Packages from the Archive launcher class path.

Parameters:

recursive - Should the sub packages be deleted?

packages - All the packages to be deleted

Returns:

This archive

Throws:

IllegalArgumentException - If no packages were specified

See Also:

deleteLauncherPackages(boolean, Filter, Package...)

deleteLauncherPackages

T deleteLauncherPackages(boolean recursive,
                         String... packages)
                  throws IllegalArgumentException

Delete all classes in the specified Packages from the Archive launcher class path.

Parameters:

recursive - Should the sub packages be deleted?

packages - All the packages to be deleted represented by a String ("my/package")

Returns:

This archive

Throws:

IllegalArgumentException - If no packages were specified

See Also:

deleteLauncherPackages(boolean, Filter, Package...)

deleteLauncherPackages

T deleteLauncherPackages(boolean recursive,
                         org.jboss.shrinkwrap.api.Filter<org.jboss.shrinkwrap.api.ArchivePath> filter,
                         Package... packages)
                  throws IllegalArgumentException

Deletes all classes accepted by the filter in the specified Packages from the Archive launcher class path.
The ArchivePath returned to the filter is the ArchivePath of the class, not the final location.
package.MyClass = /package/MyClass.class
not: package.MyClass = /WEB-INF/classes/package/MyClass.class

Parameters:

recursive - Should the sub packages be deleted?

filter - filter out specific classes

packages - All the packages to be deleted

Returns:

This archive

Throws:

IllegalArgumentException - If no packages were specified or if no filter was specified

deleteLauncherPackages

T deleteLauncherPackages(boolean recursive,
                         org.jboss.shrinkwrap.api.Filter<org.jboss.shrinkwrap.api.ArchivePath> filter,
                         String... packages)
                  throws IllegalArgumentException

Delete all classes accepted by the filter in the specified Packages from the Archive launcher class path.
The ArchivePath returned to the filter is the ArchivePath of the class, not the final location.
package.MyClass = /package/MyClass.class
not: package.MyClass = /WEB-INF/classes/package/MyClass.class

Parameters:

recursive - Should the sub packages be deleted?

filter - filter out specific classes

packages - All the packages to be deleted represented by a String ("my/package")

Returns:

This archive

Throws:

IllegalArgumentException - If no packages were specified or if no filter was specified

addAsLauncherLibrary

T addAsLauncherLibrary(org.jboss.shrinkwrap.api.Archive<?> archive)
                throws IllegalArgumentException

Add another Archive to this Archive as a launcher library, returning the container itself.

Parameters:

archive - Archive resource to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if Archive is null

addAsLauncherLibraries

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

Add multiple Archives to this Archive as launcher libraries, returning the container itself.

Parameters:

archives - Archive resources to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if Archive resources are null

See Also:

addAsLauncherLibrary(Archive)

addAsLauncherLibraries

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

Add multiple Archives to this Archive as launcher libraries, returning the container itself.

Parameters:

archives - Archive resources to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if Collection of archives is null

See Also:

addAsLauncherLibrary(Archive)

addAsLauncherLibraries

T addAsLauncherLibraries(org.jboss.shrinkwrap.api.Archive<?>[]... archives)
                  throws IllegalArgumentException

Add multiple Archives to this Archive as llauncher libraries, returning the container itself.

Parameters:

archives - Archive resources to add

Returns:

This virtual archive

Throws:

IllegalArgumentException - if Collection of archives is null

See Also:

addAsLauncherLibrary(Archive)