|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
T
- public interface WebContainer<T extends Archive<T>>
Defines the contract for a component capable of storing
web-related resources.
The actual path to the Web resources within the Archive
is up to the implementations/specifications.
Method Summary | |
---|---|
T |
addAsWebInfResource(Asset resource,
ArchivePath target)
Adds the Asset as a WEB-INF resource to the container, returning the container itself. |
T |
addAsWebInfResource(Asset resource,
String target)
Adds the Asset as a WEB-INF resource to the container, returning the container itself. |
T |
addAsWebInfResource(File resource)
Adds the File as a WEB-INF resource to the container, returning the container itself. |
T |
addAsWebInfResource(File resource,
ArchivePath target)
Adds the File as a WEB-INF resource to the container, returning the container itself. |
T |
addAsWebInfResource(File resource,
String target)
Adds the File as a WEB-INF resource to the container, returning the container itself. |
T |
addAsWebInfResource(Package resourcePackage,
String resourceName)
Adds the resource as a WEB-INF resource to the container, returning the container itself. |
T |
addAsWebInfResource(Package resourcePackage,
String resourceName,
ArchivePath target)
Adds the resource as a WEB-INF resource to a specific path inside the container, returning the container itself. |
T |
addAsWebInfResource(Package resourcePackage,
String resourceName,
String target)
Adds the resource as a WEB-INF resource to a specific path inside the container, returning the container itself. |
T |
addAsWebInfResource(String resourceName)
Adds the resource as a WEB-INF resource to the container, returning the container itself. |
T |
addAsWebInfResource(String resourceName,
ArchivePath target)
Adds the resource as a WEB-INF resource to the container, returning the container itself. |
T |
addAsWebInfResource(String resourceName,
String target)
Adds the resource as a WEB-INF resource to the container, returning the container itself. |
T |
addAsWebInfResource(URL resource,
ArchivePath target)
Adds the URL as a WEB-INF resource to the container, returning the container itself. |
T |
addAsWebInfResource(URL resource,
String target)
Adds the URL as a WEB-INF resource to the container, returning the container itself. |
T |
addAsWebInfResources(Package resourcePackage,
String... resourceNames)
Adds the resources inside the package as multiple WEB-INF resources to the container, returning the container itself. |
T |
addAsWebResource(Asset resource,
ArchivePath target)
Adds the Asset as a Web resource to the container, returning the container itself. |
T |
addAsWebResource(Asset resource,
String target)
Adds the Asset as a Web resource to the container, returning the container itself. |
T |
addAsWebResource(File resource)
Adds the File as a Web resource to the container, returning the container itself. |
T |
addAsWebResource(File resource,
ArchivePath target)
Adds the File as a Web resource to the container, returning the container itself. |
T |
addAsWebResource(File resource,
String target)
Adds the File as a Web resource to the container, returning the container itself. |
T |
addAsWebResource(Package resourcePackage,
String resourceName)
Adds the resource as a resource to the container, returning the container itself. |
T |
addAsWebResource(Package resourcePackage,
String resourceName,
ArchivePath target)
Adds the resource as a resource to a specific path inside the container, returning the container itself. |
T |
addAsWebResource(Package resourcePackage,
String resourceName,
String target)
Adds the resource as a resource to a specific path inside the container, returning the container itself. |
T |
addAsWebResource(String resourceName)
Adds the resource as a Web resource to the container, returning the container itself. |
T |
addAsWebResource(String resourceName,
ArchivePath target)
Adds the resource as a Web resource to the container, returning the container itself. |
T |
addAsWebResource(String resourceName,
String target)
Adds the resource as a Web resource to the container, returning the container itself. |
T |
addAsWebResource(URL resource,
ArchivePath target)
Adds the URL as a Web resource to the container, returning the container itself. |
T |
addAsWebResource(URL resource,
String target)
Adds the URL as a Web resource to the container, returning the container itself. |
T |
addAsWebResources(Package resourcePackage,
String... resourceNames)
Adds the resources inside the package as multiple resources to the container, returning the container itself. |
T |
setWebXML(Asset resource)
Adds the Asset as web.xml to the container, returning the container itself. |
T |
setWebXML(File resource)
Adds the File as web.xml to the container, returning the container itself. |
T |
setWebXML(Package resourcePackage,
String resourceName)
Adds the resource inside the package as web.xml to the container, returning the container itself. |
T |
setWebXML(String resourceName)
Adds the resource as web.xml to the container, returning the container itself. |
T |
setWebXML(URL resource)
Adds the URL as web.xml to the container, returning the container itself. |
Method Detail |
---|
T setWebXML(String resourceName) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourceName
- resource to add
IllegalArgumentException
- if resourceName is nullsetWebXML(Asset)
T setWebXML(File resource) throws IllegalArgumentException
File
as web.xml to the container, returning the container itself.
resource
- File
resource to add
IllegalArgumentException
- if resource is nullsetWebXML(Asset)
T setWebXML(URL resource) throws IllegalArgumentException
URL
as web.xml to the container, returning the container itself.
resource
- URL
resource to add
IllegalArgumentException
- if resource is nullsetWebXML(Asset)
T setWebXML(Asset resource) throws IllegalArgumentException
Asset
as web.xml to the container, returning the container itself.
resource
- Asset
resource to add
IllegalArgumentException
- if resource is nulladdAsWebResource(Asset, ArchivePath)
T setWebXML(Package resourcePackage, String resourceName) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourcePackage
- The package of the resourcesresourceName
- The name of the resources inside resourcePackage
IllegalArgumentException
- if resourcePackage is null
IllegalArgumentException
- if resourceName is nullT addAsWebResource(String resourceName) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourceName
- resource to add
IllegalArgumentException
- if resourceName is null
IllegalArgumentException
- if target is nulladdAsWebResource(Asset, ArchivePath)
T addAsWebResource(File resource) throws IllegalArgumentException
File
as a Web resource to the container, returning the container itself.
File
will be placed into the Container Web path under File.getName()
.
resource
- resource to add
IllegalArgumentException
- if File
resource is null
IllegalArgumentException
- if target is nulladdAsWebResource(Asset, ArchivePath)
T addAsWebResource(String resourceName, String target) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourceName
- resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s web path.
IllegalArgumentException
- if resourceName is null
IllegalArgumentException
- if target is nulladdAsWebResource(Asset, ArchivePath)
T addAsWebResource(File resource, String target) throws IllegalArgumentException
File
as a Web resource to the container, returning the container itself.
resource
- File
resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s web path.
IllegalArgumentException
- if resource is null
IllegalArgumentException
- if target is nulladdAsWebResource(Asset, ArchivePath)
T addAsWebResource(URL resource, String target) throws IllegalArgumentException
URL
as a Web resource to the container, returning the container itself.
resource
- URL
resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s web path.
IllegalArgumentException
- if resource is null
IllegalArgumentException
- if target is nulladdAsWebResource(Asset, ArchivePath)
T addAsWebResource(Asset resource, String target) throws IllegalArgumentException
Asset
as a Web resource to the container, returning the container itself.
resource
- Asset
resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s web path.
IllegalArgumentException
- if resource is null
IllegalArgumentException
- if target is nulladdAsWebResource(Asset, ArchivePath)
T addAsWebResource(String resourceName, ArchivePath target) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourceName
- resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s web path.
IllegalArgumentException
- if resourceName is null
IllegalArgumentException
- if target is nulladdAsWebResource(Asset, ArchivePath)
T addAsWebResource(File resource, ArchivePath target) throws IllegalArgumentException
File
as a Web resource to the container, returning the container itself.
resource
- File
resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s web path.
IllegalArgumentException
- if resource is null
IllegalArgumentException
- if target is nulladdAsWebResource(Asset, ArchivePath)
T addAsWebResource(URL resource, ArchivePath target) throws IllegalArgumentException
URL
as a Web resource to the container, returning the container itself.
resource
- URL
resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s web path.
IllegalArgumentException
- if resource is null
IllegalArgumentException
- if target is nulladdAsWebResource(Asset, ArchivePath)
T addAsWebResource(Asset resource, ArchivePath target) throws IllegalArgumentException
Asset
as a Web resource to the container, returning the container itself.
resource
- Asset
resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s web path.
IllegalArgumentException
- if resource is null
IllegalArgumentException
- if target is nullT addAsWebResources(Package resourcePackage, String... resourceNames) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourcePackage
- The package of the resourcesresourceNames
- The names of the resources inside resoucePackage
IllegalArgumentException
- if resourcePackage is null
IllegalArgumentException
- if no resourceNames are specified or containing nullT addAsWebResource(Package resourcePackage, String resourceName) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourcePackage
- The package of the resourceresourceName
- The name of the resource inside resoucePackage
IllegalArgumentException
- if resourcePackage is null
IllegalArgumentException
- if resourceName is nullT addAsWebResource(Package resourcePackage, String resourceName, String target) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourcePackage
- The package of the resourceresourceName
- The name of the resource inside resoucePackagetarget
- The target location inside the container
IllegalArgumentException
- if resourcePackage is null
IllegalArgumentException
- if resourceName is null
IllegalArgumentException
- if target is nullT addAsWebResource(Package resourcePackage, String resourceName, ArchivePath target) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourcePackage
- The package of the resourceresourceName
- The name of the resource inside resoucePackagetarget
- The target location inside the container
IllegalArgumentException
- if resourcePackage is null
IllegalArgumentException
- if resourceName is null
IllegalArgumentException
- if target is nullT addAsWebInfResource(String resourceName) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourceName
- resource to add
Archive
IllegalArgumentException
- if resourceName is not specifiedT addAsWebInfResource(File resource) throws IllegalArgumentException
File
as a WEB-INF resource to the container, returning the container itself.
File
will be placed into the Container WEB-INF path under File.getName()
.
resource
- Resource to add
Archive
IllegalArgumentException
- if File
resource is nullT addAsWebInfResource(String resourceName, String target) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourceName
- resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s WEB-INF path.
Archive
IllegalArgumentException
- if resourceName or target is not specifiedT addAsWebInfResource(File resource, String target) throws IllegalArgumentException
File
as a WEB-INF resource to the container, returning the container itself.
resource
- File
resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s WEB-INF path.
Archive
IllegalArgumentException
- If the resource or target is not specifiedT addAsWebInfResource(URL resource, String target) throws IllegalArgumentException
URL
as a WEB-INF resource to the container, returning the container itself.
resource
- URL
resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s WEB-INF path.
Archive
IllegalArgumentException
- If the resource or target is not specifiedT addAsWebInfResource(Asset resource, String target) throws IllegalArgumentException
Asset
as a WEB-INF resource to the container, returning the container itself.
resource
- Asset
resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s WEB-INF path.
Archive
IllegalArgumentException
- If the resource or target is not specifiedT addAsWebInfResource(String resourceName, ArchivePath target) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourceName
- resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s WEB-INF path.
Archive
IllegalArgumentException
- If the resource or target is not specifiedT addAsWebInfResource(File resource, ArchivePath target) throws IllegalArgumentException
File
as a WEB-INF resource to the container, returning the container itself.
resource
- File
resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s WEB-INF path.
Archive
IllegalArgumentException
- If the resource or target is not specifiedT addAsWebInfResource(URL resource, ArchivePath target) throws IllegalArgumentException
URL
as a WEB-INF resource to the container, returning the container itself.
resource
- URL
resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s WEB-INF path.
Archive
IllegalArgumentException
- If the resource or target is not specifiedT addAsWebInfResource(Asset resource, ArchivePath target) throws IllegalArgumentException
Asset
as a WEB-INF resource to the container, returning the container itself.
resource
- Asset
resource to addtarget
- The target path within the archive in which to add the resource, relative to the Archive
s WEB-INF path.
Archive
IllegalArgumentException
- If the resource or target is not specifiedT addAsWebInfResources(Package resourcePackage, String... resourceNames) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourcePackage
- The package of the resourcesresourceNames
- The names of the resources inside resourcePackage
Archive
IllegalArgumentException
- If resourcePackage is null, or if no resourceNames are specified or containing nullT addAsWebInfResource(Package resourcePackage, String resourceName) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourcePackage
- The package of the resourceresourceName
- The name of the resource inside resourcePackage
Archive
IllegalArgumentException
- If the package or resource name is not specifiedT addAsWebInfResource(Package resourcePackage, String resourceName, String target) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourcePackage
- The package of the resourceresourceName
- The name of the resource inside resoucePackagetarget
- The target location inside the container
Archive
IllegalArgumentException
- If the package, resource name, or target is not specifiedT addAsWebInfResource(Package resourcePackage, String resourceName, ArchivePath target) throws IllegalArgumentException
ClassLoader
used to obtain the resource is up to the implementation.
resourcePackage
- The package of the resourceresourceName
- The name of the resource inside resoucePackagetarget
- The target location inside the container
Archive
IllegalArgumentException
- If the package, resource name, or target is not specified
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |