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, Serializable

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

Since:

4.1

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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.

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

Field Summary

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

EMTPY_DEPENDENCIES, EMTPY_RESOURCES, NAME_ALLOWED_CHARACTERS

Method Summary

Methods

Modifier and Type	Method and Description
static WebAppDescriptor	create(Element serviceElement, String moduleName, String version)
ComponentDescriptor.Scope	getScope() Returns component scope.
ComponentDescriptor.Type	getType() Returns component type.
EnumSet<WebAppDescriptor.WebAppScope>	getWebAppScopes() Returns a set of supported WebAppDescriptor.WebAppScopes based on xml definition.
String	getWebDir()
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()
String	getWebXml()
void	validate(ZipFile file)

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

compareVersion, getAttribute, getComponentClass, getConfiguration, getConfigurationClass, getDependencies, getDescription, getDirectChildNodeValue, getDisplayName, getModuleName, getName, getNodeValue, getNodeValue, getRequiredClasses, getResources, getScope, getScope, getVersion, getVersion, isHidden, 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 Detail

create

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

Since:

4.1

getWebResources

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

Since:

4.1

getWebXml

public String getWebXml()

Since:

4.1

getWebDir

public String getWebDir()

Since:

4.1

getWebDirFilter

@Nullable
public 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 EnumSet<WebAppDescriptor.WebAppScope> getWebAppScopes()

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

Returns:

a EnumSet of supported WebAppDescriptor.WebAppScopes

Since:

4.2.448

getType

public ComponentDescriptor.Type getType()

Description copied from interface: ComponentDescriptor

Returns component type.

Specified by:

getType in interface ComponentDescriptor

Returns:

component type.

Since:

4.1

getScope

public ComponentDescriptor.Scope getScope()

Description copied from interface: ComponentDescriptor

Returns component scope.

Specified by:

getScope in interface ComponentDescriptor

Returns:

component scope.

Since:

4.1

validate

public void validate(ZipFile file)
              throws IOException

Overrides:

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

Throws:

IOException

Since:

4.1