Package org.jboss.shrinkwrap.api.container

Interface EnterpriseContainer<T extends Archive<T>>

  • All Known Subinterfaces:
    EnterpriseArchive
    All Known Implementing Classes:
    EnterpriseArchiveImpl, EnterpriseContainerBase
    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: $

    • Method Detail

      • setApplicationXML

        T setApplicationXML​(java.lang.String resourceName)
             throws java.lang.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:
        java.lang.IllegalArgumentException - if resourceName is null
        See Also:
        setApplicationXML(Asset)

      • setApplicationXML

        T setApplicationXML​(java.io.File resource)
             throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        See Also:
        setApplicationXML(Asset)

      • setApplicationXML

        T setApplicationXML​(java.net.URL resource)
             throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        See Also:
        setApplicationXML(Asset)

      • setApplicationXML

        T setApplicationXML​(Asset resource)
             throws java.lang.IllegalArgumentException
        Adds a Asset to this Archive as application.xml.
        Parameters:
        resource - Asset resource to add
        Returns:
        This virtual archive
        Throws:
        java.lang.IllegalArgumentException - if resource is null

      • setApplicationXML

        T setApplicationXML​(java.lang.Package resourcePackage,
                    java.lang.String resourceName)
             throws java.lang.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:
        java.lang.IllegalArgumentException - if resourcePackage is null
        java.lang.IllegalArgumentException - if resourceName is null
        See Also:
        setApplicationXML(String)

      • addAsApplicationResource

        T addAsApplicationResource​(java.lang.String resourceName)
                    throws java.lang.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:
        java.lang.IllegalArgumentException - if resourceName is null
        See Also:
        addAsApplicationResource(Asset, ArchivePath)

      • addAsApplicationResource

        T addAsApplicationResource​(java.io.File resource)
                    throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        See Also:
        addAsApplicationResource(Asset, ArchivePath)

      • addAsApplicationResource

        T addAsApplicationResource​(java.lang.String resourceName,
                           java.lang.String target)
                    throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        java.lang.IllegalArgumentException - if target is null
        See Also:
        addAsApplicationResource(Asset, ArchivePath)

      • addAsApplicationResource

        T addAsApplicationResource​(java.io.File resource,
                           java.lang.String target)
                    throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        java.lang.IllegalArgumentException - if target is null
        See Also:
        addAsApplicationResource(Asset, ArchivePath)

      • addAsApplicationResource

        T addAsApplicationResource​(java.net.URL resource,
                           java.lang.String target)
                    throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        java.lang.IllegalArgumentException - if target is null
        See Also:
        addAsApplicationResource(Asset, ArchivePath)

      • addAsApplicationResource

        T addAsApplicationResource​(Asset resource,
                           java.lang.String target)
                    throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        java.lang.IllegalArgumentException - if target is null
        See Also:
        addAsApplicationResource(Asset, ArchivePath)

      • addAsApplicationResource

        T addAsApplicationResource​(java.lang.String resourceName,
                           ArchivePath target)
                    throws java.lang.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:
        java.lang.IllegalArgumentException - if resourceName is null
        java.lang.IllegalArgumentException - if target is null
        See Also:
        addAsApplicationResource(Asset, ArchivePath)

      • addAsApplicationResource

        T addAsApplicationResource​(java.io.File resource,
                           ArchivePath target)
                    throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        java.lang.IllegalArgumentException - if target is null
        See Also:
        addAsApplicationResource(Asset, ArchivePath)

      • addAsApplicationResource

        T addAsApplicationResource​(java.net.URL resource,
                           ArchivePath target)
                    throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        java.lang.IllegalArgumentException - if target is null
        See Also:
        addAsApplicationResource(Asset, ArchivePath)

      • addAsApplicationResource

        T addAsApplicationResource​(Asset resource,
                           ArchivePath target)
                    throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        java.lang.IllegalArgumentException - if target is null

      • addAsApplicationResources

        T addAsApplicationResources​(java.lang.Package resourcePackage,
                            java.lang.String... resourceNames)
                     throws java.lang.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 resoucePackage
        Returns:
        This virtual archive
        Throws:
        java.lang.IllegalArgumentException - if resourcePackage is null
        java.lang.IllegalArgumentException - if no resourceNames are specified or containing null

      • addAsApplicationResource

        T addAsApplicationResource​(java.lang.Package resourcePackage,
                           java.lang.String resourceName)
                    throws java.lang.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 resoucePackage
        Returns:
        This virtual archive
        Throws:
        java.lang.IllegalArgumentException - if resourcePackage is null
        java.lang.IllegalArgumentException - if resourceName is null

      • addAsApplicationResource

        T addAsApplicationResource​(java.lang.Package resourcePackage,
                           java.lang.String resourceName,
                           java.lang.String target)
                    throws java.lang.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 resoucePackage
        target - The target location inside the container
        Returns:
        This virtual archive
        Throws:
        java.lang.IllegalArgumentException - if resourcePackage is null
        java.lang.IllegalArgumentException - if resourceName is null
        java.lang.IllegalArgumentException - if target is null

      • addAsApplicationResource

        T addAsApplicationResource​(java.lang.Package resourcePackage,
                           java.lang.String resourceName,
                           ArchivePath target)
                    throws java.lang.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 resoucePackage
        target - The target location inside the container
        Returns:
        This virtual archive
        Throws:
        java.lang.IllegalArgumentException - if resourcePackage is null
        java.lang.IllegalArgumentException - if resourceName is null
        java.lang.IllegalArgumentException - if target is null

      • addAsModule

        T addAsModule​(Archive<?> archive)
       throws java.lang.IllegalArgumentException
        Adds a archive to this Archives module context.

        The Archive name is used as path.
        Parameters:
        archive - The archive to use
        Returns:
        This virtual archive
        Throws:
        java.lang.IllegalArgumentException - if archive is null

      • addAsModules

        T addAsModules​(Archive<?>... archives)
        throws java.lang.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:
        java.lang.IllegalArgumentException - if not archives are specified

      • addAsModule

        T addAsModule​(java.lang.String resourceName)
       throws java.lang.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:
        java.lang.IllegalArgumentException - if resourceName is null
        See Also:
        addAsModule(Asset, ArchivePath)

      • addAsModules

        T addAsModules​(java.lang.String... resourceNames)
        throws java.lang.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:
        java.lang.IllegalArgumentException - if resourceNames are not specified
        See Also:
        addAsModule(Asset, ArchivePath)

      • addAsModule

        T addAsModule​(java.io.File resource)
       throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        See Also:
        addAsModule(Asset, ArchivePath)

      • addAsModules

        T addAsModules​(java.io.File... resources)
        throws java.lang.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:
        java.lang.IllegalArgumentException - if resources are not specified
        See Also:
        addAsModule(Asset, ArchivePath)

      • addAsModule

        T addAsModule​(java.lang.String resourceName,
              java.lang.String targetPath)
       throws java.lang.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:
        java.lang.IllegalArgumentException - if resourceName is null
        java.lang.IllegalArgumentException - if targetPath is null
        See Also:
        addAsModule(Asset, ArchivePath)

      • addAsModule

        T addAsModule​(java.io.File resource,
              java.lang.String targetPath)
       throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        java.lang.IllegalArgumentException - if targetPath is null
        See Also:
        addAsModule(Asset, ArchivePath)

      • addAsModule

        T addAsModule​(java.net.URL resource,
              java.lang.String targetPath)
       throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        java.lang.IllegalArgumentException - if targetPath is null
        See Also:
        addAsModule(Asset, ArchivePath)

      • addAsModule

        T addAsModule​(Asset resource,
              java.lang.String targetPath)
       throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        java.lang.IllegalArgumentException - if targetPath is null
        See Also:
        addAsModule(Asset, ArchivePath)

      • addAsModule

        T addAsModule​(java.lang.String resourceName,
              ArchivePath targetPath)
       throws java.lang.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:
        java.lang.IllegalArgumentException - if resourceName is null
        java.lang.IllegalArgumentException - if targetPath is null
        See Also:
        addAsModule(Asset, ArchivePath)

      • addAsModule

        T addAsModule​(java.io.File resource,
              ArchivePath targetPath)
       throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        java.lang.IllegalArgumentException - if targetPath is null
        See Also:
        addAsModule(Asset, ArchivePath)

      • addAsModule

        T addAsModule​(java.net.URL resource,
              ArchivePath targetPath)
       throws java.lang.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:
        java.lang.IllegalArgumentException - if resource is null
        java.lang.IllegalArgumentException - if targetPath is null
        See Also:
        addAsModule(Asset, ArchivePath)

      • addAsModule

        T addAsModule​(Asset resource,
              ArchivePath targetPath)
       throws java.lang.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:
        java.lang.IllegalArgumentException - if targetPath is null
        java.lang.IllegalArgumentException - if resource is null