public class WebAppDescriptor extends de.espirit.firstspirit.module.descriptor.AbstractDescriptor implements ComponentDescriptor
web app
.Modifier and Type | Class and Description |
---|---|
static class |
WebAppDescriptor.FilterDescriptor
Contains filter definition based on an include and exclude list of paths.
|
static class |
WebAppDescriptor.WebAppScope
The scope describes the place where the component is available: global or project-local webapps.
|
de.espirit.firstspirit.module.descriptor.AbstractDescriptor.ResourceDescriptor
ComponentDescriptor.Scope, ComponentDescriptor.Type
Modifier and Type | Method and Description |
---|---|
static WebAppDescriptor |
create(Element serviceElement,
String moduleName,
String version)
Creates a instance of
WebAppDescriptor |
ComponentDescriptor.Scope |
getScope()
The scope of this project app description.
|
ComponentDescriptor.Type |
getType()
The type of this project app descriptor which is
Type#WEBAPP . |
EnumSet<WebAppDescriptor.WebAppScope> |
getWebAppScopes()
Returns a set of supported
WebAppDescriptor.WebAppScope s based on xml definition. |
String |
getWebDir()
Get the path to the web directory.
|
WebAppDescriptor.FilterDescriptor |
getWebDirFilter()
Returns
WebAppDescriptor.FilterDescriptor instance based on xml filter definition if specified, or null if not. |
de.espirit.firstspirit.module.descriptor.AbstractDescriptor.ResourceDescriptor[] |
getWebResources()
Get the web resources.
|
String |
getWebXml()
Get the the web.xml.
|
void |
validate(ZipFile file)
Validate the given
ZipFile |
compareVersion, getAttribute, getComponentClass, getConfiguration, getConfigurationClass, getDependencies, getDescription, getDisplayName, getModuleName, getName, getNodeValue, getNodeValue, getResources, getScope, getScope, getVersion, getVersion, isHidden, isSystem, isUnknown, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getComponentClass, getConfiguration, getConfigurationClass, getDescription, getDisplayName, getModuleName, getName, getResources, getVersion, isHidden, isUnknown
public static WebAppDescriptor create(Element serviceElement, String moduleName, String version)
WebAppDescriptor
serviceElement
- Element
moduleName
- The name of the moduleversion
- The version of the moduleWebAppDescriptor
public de.espirit.firstspirit.module.descriptor.AbstractDescriptor.ResourceDescriptor[] getWebResources()
ResourceDescriptor
public String getWebXml()
public String getWebDir()
@Nullable public WebAppDescriptor.FilterDescriptor getWebDirFilter()
WebAppDescriptor.FilterDescriptor
instance based on xml filter definition if specified, or null if not.WebAppDescriptor.FilterDescriptor
instance@NotNull public EnumSet<WebAppDescriptor.WebAppScope> getWebAppScopes()
WebAppDescriptor.WebAppScope
s based on xml definition.WebAppDescriptor.WebAppScope
public ComponentDescriptor.Type getType()
Type#WEBAPP
.getType
in interface ComponentDescriptor
Type
public ComponentDescriptor.Scope getScope()
Scope.WEB
getScope
in interface ComponentDescriptor
Scope
public void validate(@NotNull ZipFile file) throws IOException
ZipFile
validate
in class de.espirit.firstspirit.module.descriptor.AbstractDescriptor
{@link
- FileNotFoundException FileNotFoundException}IOException
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210