Package de.espirit.firstspirit.module.descriptor

Class WebAppDescriptor

java.lang.Object

de.espirit.firstspirit.module.descriptor.AbstractDescriptor

de.espirit.firstspirit.module.descriptor.WebAppDescriptor

All Implemented Interfaces:

ComponentDescriptor, Descriptor, Serializable

public class WebAppDescriptor
extends de.espirit.firstspirit.module.descriptor.AbstractDescriptor
implements ComponentDescriptor

A descriptor for a web app.

Since:

4.1

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebAppDescriptor.FilterDescriptor	Contains filter definition based on an include and exclude list of paths.
static enum	WebAppDescriptor.WebAppScope	The scope describes the place where the component is available: global or project-local webapps.

Nested classes/interfaces inherited from class de.espirit.firstspirit.module.descriptor.AbstractDescriptor

de.espirit.firstspirit.module.descriptor.AbstractDescriptor.ResourceDescriptor

Nested classes/interfaces inherited from interface de.espirit.firstspirit.module.descriptor.ComponentDescriptor

ComponentDescriptor.Scope, ComponentDescriptor.Type

Method Summary

Modifier and Type	Method	Description
static WebAppDescriptor	create(Element serviceElement, @NotNull 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.
@NotNull EnumSet<WebAppDescriptor.WebAppScope>	getWebAppScopes()	Returns a set of supported WebAppDescriptor.WebAppScopes based on xml definition.
String	getWebDir()	Get the path to the web directory.
@Nullable 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 location of the web.xml.
int	getXmlSchemaMajorVersion()	Returns the major version of the xml schema, e.g. '5' for "5.0"
@NotNull String	getXmlSchemaVersion()	Returns the supported xml schema version for this web application, e.g. 5.0
void	validate(@NotNull ZipFile file)	Validate the given ZipFile

Methods inherited from class de.espirit.firstspirit.module.descriptor.AbstractDescriptor

compareVersion, getAttribute, getComponentClass, getConfiguration, getConfigurationClass, getDependencies, getDescription, getDisplayName, getModuleName, getName, getNodeValue, getNodeValue, getResources, getScope, getScope, getVersion, getVersion, isHidden, isSystem, isUnknown, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.espirit.firstspirit.module.descriptor.ComponentDescriptor

getComponentClass, getConfiguration, getConfigurationClass, getDescription, getDisplayName, getModuleName, getName, getResources, getVersion, isHidden, isUnknown

Method Details

create

public static WebAppDescriptor create(Element serviceElement,
 @NotNull
 @NotNull String moduleName,
 String version)

Creates a instance of WebAppDescriptor

Parameters:

serviceElement - Element

moduleName - The name of the module

version - The version of the module

Returns:

An instance of WebAppDescriptor

Since:

4.1

getXmlSchemaVersion

@NotNull
public @NotNull String getXmlSchemaVersion()

Returns the supported xml schema version for this web application, e.g. 5.0

Returns:

the xml schema version, defaults to "3.0" if unspecified

Since:

5.2.230905

getXmlSchemaMajorVersion

public int getXmlSchemaMajorVersion()

Returns the major version of the xml schema, e.g. '5' for "5.0"

Returns:

the major version of the xml schema, defaults to '3' if unspecified or a parsing error occurs

Since:

5.2.230905

getWebResources

public de.espirit.firstspirit.module.descriptor.AbstractDescriptor.ResourceDescriptor[] getWebResources()

Get the web resources.

Returns:

An array of ResourceDescriptor

Since:

4.1

getWebXml

public String getWebXml()

Get the location of the web.xml.

Returns:

The location of the web.xml.

Since:

4.1

getWebDir

public String getWebDir()

Get the path to the web directory.

Returns:

Path to web directory.

Since:

4.1

getWebDirFilter

@Nullable
public @Nullable WebAppDescriptor.FilterDescriptor getWebDirFilter()

Returns WebAppDescriptor.FilterDescriptor instance based on xml filter definition if specified, or null if not.

Returns:

a WebAppDescriptor.FilterDescriptor instance

Since:

4.2.441

getWebAppScopes

@NotNull
public @NotNull EnumSet<WebAppDescriptor.WebAppScope> getWebAppScopes()

Returns a set of supported WebAppDescriptor.WebAppScopes based on xml definition.

Returns:

an EnumSet of supported WebAppDescriptor.WebAppScope

Since:

4.2.448

getType

public ComponentDescriptor.Type getType()

The type of this project app descriptor which is Type#WEBAPP.

Specified by:

getType in interface ComponentDescriptor

Returns:

ComponentDescriptor.Type

Since:

4.1

getScope

public ComponentDescriptor.Scope getScope()

The scope of this project app description. Returns Scope.WEB

Specified by:

getScope in interface ComponentDescriptor

Returns:

ComponentDescriptor.Scope

Since:

4.1

validate

public void validate(@NotNull
 @NotNull ZipFile file)
              throws IOException

Validate the given ZipFile

Overrides:

validate in class de.espirit.firstspirit.module.descriptor.AbstractDescriptor

Throws:

FileNotFoundException

IOException

Since:

4.1