Package de.espirit.firstspirit.module

Interface WebEnvironment

All Superinterfaces:

ProjectEnvironment, ServerEnvironment

public interface WebEnvironment
extends ProjectEnvironment

A web based project environment.

Since:

4.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	WebEnvironment.WebScope	In which web scope is the component available: preview, staging, live, webedit or global.

Method Summary

Modifier and Type	Method	Description
WebEnvironment.WebScope	getWebScope()	Returns the webscope
@Nullable String	getWebXml()	gets the content of current web.xml
boolean	hasCustomWebXml()	Returns true if the web.xml was edited by user, false otherwise
void	setCustomWebXml(boolean customWebXml)	Saves the "web.xml was edited by user" state
void	setWebXml(String webXml)	saves the given string to web.xml file

Methods inherited from interface de.espirit.firstspirit.module.ProjectEnvironment

getInstalledVersion, getProject, getProjectId

Methods inherited from interface de.espirit.firstspirit.module.ServerEnvironment

getBroker, getConfDir, getConnection, getDataDir, getLogDir, getScope

Method Details

getWebScope

WebEnvironment.WebScope getWebScope()

Returns the webscope

Returns:

webscope

Since:

4.1

hasCustomWebXml

boolean hasCustomWebXml()

Returns true if the web.xml was edited by user, false otherwise

Returns:

true if edited otherwise false

Since:

4.1

setCustomWebXml

void setCustomWebXml(boolean customWebXml)

Saves the "web.xml was edited by user" state

Parameters:

customWebXml - true if web.xml was edited by user, false otherwise

Since:

4.1

getWebXml

@Nullable
@Nullable String getWebXml()

gets the content of current web.xml

Returns:

the content of current web.xml

Since:

4.1

setWebXml

void setWebXml(String webXml)

saves the given string to web.xml file

Parameters:

webXml - web.xml content, that should be saved

Since:

4.1