org.jboss.shrinkwrap.api.container
Interface ManifestContainer<T extends Archive<T>>

Type Parameters:
T -
All Known Subinterfaces:
EnterpriseArchive, JavaArchive, ResourceAdapterArchive, WebArchive

public interface ManifestContainer<T extends Archive<T>>

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

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

Version:
$Revision: $
Author:
Aslak Knutsen

Method Summary
 T addManifestResource(Asset resource, ArchivePath target)
          Adds the Asset as a Manifest resource to the container, returning the container itself.
 T addManifestResource(Asset resource, String target)
          Adds the Asset as a Manifest resource to the container, returning the container itself.
 T addManifestResource(File resource)
          Adds the File as a Manifest resource to the container, returning the container itself.
 T addManifestResource(File resource, ArchivePath target)
          Adds the File as a Manifest resource to the container, returning the container itself.
 T addManifestResource(File resource, String target)
          Adds the File as a Manifest resource to the container, returning the container itself.
 T addManifestResource(String resourceName)
          Adds the resource as a Manifest resource to the container, returning the container itself.
 T addManifestResource(String resourceName, ArchivePath target)
          Adds the resource as a Manifest resource to the container, returning the container itself.
 T addManifestResource(String resourceName, String target)
          Adds the resource as a Manifest resource to the container, returning the container itself.
 T addManifestResource(URL resource, ArchivePath target)
          Adds the URL as a Manifest resource to the container, returning the container itself.
 T addManifestResource(URL resource, String target)
          Adds the URL as a Manifest resource to the container, returning the container itself.
 T addServiceProvider(Class<?> serviceInterface, Class<?>... serviceImpls)
          Adds a META-INF/services/ServiceInterfaceName Asset representing this service.
 T setManifest(Asset resource)
          Adds the Asset as MANIFEST.FM to the container, returning the container itself.
 T setManifest(File resource)
          Adds the File as MANIFEST.FM to the container, returning the container itself.
 T setManifest(String resourceName)
          Adds the resource as MANIFEST.FM to the container, returning the container itself.
 T setManifest(URL resource)
          Adds the URL as MANIFEST.FM to the container, returning the container itself.
 

Method Detail

setManifest

T setManifest(String resourceName)
                                 throws IllegalArgumentException
Adds the resource as MANIFEST.FM 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 virtual archive
Throws:
IllegalArgumentException - if resourceName is null
See Also:
setManifest(Asset)

setManifest

T setManifest(File resource)
                                 throws IllegalArgumentException
Adds the File as MANIFEST.FM to the container, returning the container itself.

Parameters:
resource - File resource to add
Returns:
This virtual archive
Throws:
IllegalArgumentException - if resource is null
See Also:
setManifest(Asset)

setManifest

T setManifest(URL resource)
                                 throws IllegalArgumentException
Adds the URL as MANIFEST.FM to the container, returning the container itself.

Parameters:
resource - URL resource to add
Returns:
This virtual archive
Throws:
IllegalArgumentException - if resource is null
See Also:
setManifest(Asset)

setManifest

T setManifest(Asset resource)
                                 throws IllegalArgumentException
Adds the Asset as MANIFEST.FM to the container, returning the container itself.

Parameters:
resource - File resource to add
Returns:
This virtual archive
Throws:
IllegalArgumentException - if resource is null
See Also:
addManifestResource(Asset, ArchivePath)

addManifestResource

T addManifestResource(String resourceName)
                                         throws IllegalArgumentException
Adds the resource as a Manifest resource to the container, returning the container itself.
The resource will be placed into the Container Manifest path under the same context from which it was retrieved.

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

Parameters:
resourceName - resource to add
Returns:
This virtual archive
Throws:
IllegalArgumentException - if resourceName is null
IllegalArgumentException - if target is null
See Also:
addManifestResource(Asset, ArchivePath)

addManifestResource

T addManifestResource(File resource)
                                         throws IllegalArgumentException
Adds the File as a Manifest resource to the container, returning the container itself.
The File will be placed into the Container Manifest path under File.getName().

Parameters:
resource - resource to add
Returns:
This virtual archive
Throws:
IllegalArgumentException - if File resource is null
IllegalArgumentException - if target is null
See Also:
addManifestResource(Asset, ArchivePath)

addManifestResource

T addManifestResource(String resourceName,
                      String target)
                                         throws IllegalArgumentException
Adds the resource as a Manifest 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 manifest path.
Returns:
This virtual archive
Throws:
IllegalArgumentException - if resourceName is null
IllegalArgumentException - if target is null
See Also:
addManifestResource(Asset, ArchivePath)

addManifestResource

T addManifestResource(File resource,
                      String target)
                                         throws IllegalArgumentException
Adds the File as a Manifest 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 manifest path.
Returns:
This virtual archive
Throws:
IllegalArgumentException - if resource is null
IllegalArgumentException - if target is null
See Also:
addManifestResource(Asset, ArchivePath)

addManifestResource

T addManifestResource(URL resource,
                      String target)
                                         throws IllegalArgumentException
Adds the URL as a Manifest 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 manifest path.
Returns:
This virtual archive
Throws:
IllegalArgumentException - if resource is null
IllegalArgumentException - if target is null
See Also:
addManifestResource(Asset, ArchivePath)

addManifestResource

T addManifestResource(Asset resource,
                      String target)
                                         throws IllegalArgumentException
Adds the Asset as a Manifest 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 manifest path.
Returns:
This virtual archive
Throws:
IllegalArgumentException - if resource is null
IllegalArgumentException - if target is null
See Also:
addManifestResource(Asset, ArchivePath)

addManifestResource

T addManifestResource(String resourceName,
                      ArchivePath target)
                                         throws IllegalArgumentException
Adds the resource as a Manifest 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 manifest path.
Returns:
This virtual archive
Throws:
IllegalArgumentException - if resourceName is null
IllegalArgumentException - if target is null
See Also:
addManifestResource(Asset, ArchivePath)

addManifestResource

T addManifestResource(File resource,
                      ArchivePath target)
                                         throws IllegalArgumentException
Adds the File as a Manifest 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 manifest path.
Returns:
This virtual archive
Throws:
IllegalArgumentException - if resource is null
IllegalArgumentException - if target is null
See Also:
addManifestResource(Asset, ArchivePath)

addManifestResource

T addManifestResource(URL resource,
                      ArchivePath target)
                                         throws IllegalArgumentException
Adds the URL as a Manifest 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 manifest path.
Returns:
This virtual archive
Throws:
IllegalArgumentException - if resource is null
IllegalArgumentException - if target is null
See Also:
addManifestResource(Asset, ArchivePath)

addManifestResource

T addManifestResource(Asset resource,
                      ArchivePath target)
                                         throws IllegalArgumentException
Adds the Asset as a Manifest 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 manifest path.
Returns:
This virtual archive
Throws:
IllegalArgumentException - if resource is null
IllegalArgumentException - if target is null

addServiceProvider

T addServiceProvider(Class<?> serviceInterface,
                     Class<?>... serviceImpls)
                                        throws IllegalArgumentException
Adds a META-INF/services/ServiceInterfaceName Asset representing this service. Warning: this method does not add the specified classes to the archive.

Parameters:
serviceInterface - The Service Interface class
serviceImpls - The Service Interface Implementations
Returns:
This virtual archive
Throws:
IllegalArgumentException - if serviceInterface is null
IllegalArgumentException - if serviceImpls is null or contain null values


Copyright © 2010 JBoss, a division of Red Hat, Inc.. All Rights Reserved.