org.jahia.data.applications

Class WebAppContext

java.lang.Object

org.jahia.data.applications.WebAppContext

All Implemented Interfaces:

Serializable

public class WebAppContext
extends Object
implements Serializable

Holds information for a given web application context. Some of them are: servlets, roles, servlet mapping, welcome files.

Author:

Khue Nguyen khue@jahia.com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WebAppContext(String context) Constructor
WebAppContext(String context, String displayName, String descr, List<ServletBean> servlets, Map<String,String> servletMappings, List<String> roles, List<String> welcomeFiles) Constructor

Method Summary

Modifier and Type	Method and Description
void	addRole(String role) Add a new security role.
void	addServlet(ServletBean servlet) Add a new servlet bean.
void	addServletMapping(String pattern, String name) Add a new servlet mapping and replace old mapping with same pattern.
void	addServlets(List<ServletBean> servlets) Add a List of ServletBean.
void	addWelcomeFile(String filename) Add a new welcome file.
boolean	findRole(String role) Return true if a given role is already in the list.
String	findServletMapping(String pattern) Return the servlet name mapped by the given pattern otherwise return null.
String	getContext() Return the context
String	getDescr() Return the descr
String	getDisplayName() Return the display name
List<EntryPointDefinition>	getEntryPointDefinitions()
List<String>	getRoles() Return the security roles defined for this application.
ServletBean	getServlet(String name) Get a servlet looking at it name.
Map<String,ServletBean>	getServlets() Return the List of servlets.
List<String>	getWelcomeFiles() Return the list of welcome file.
void	setContext(String val) Set the context
void	setDescr(String val) Set the descr
void	setDisplayName(String val) Set the display name
void	setEntryPointDefinitions(List<EntryPointDefinition> entryPointDefinitions)
void	setRoles(List<String> roles) Set roles.
void	setServletMappings(Map<String,String> servletMappings) Set the map of servlet mapping.
void	setWelcomeFiles(List<String> welcomeFiles) Set the welcome files.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebAppContext

public WebAppContext(String context)

Constructor

WebAppContext

public WebAppContext(String context,
                     String displayName,
                     String descr,
                     List<ServletBean> servlets,
                     Map<String,String> servletMappings,
                     List<String> roles,
                     List<String> welcomeFiles)

Constructor

Parameters:

context - , the application context

displayName - , the application display name

descr, - the application description

servlets, - a List ServletBean

servletMappings, - a map of servletMappings keyed with the url pappern and value = the servlet name

welcomeFiles, - a List of welcome files (String)

Method Detail

addServlets

public void addServlets(List<ServletBean> servlets)

Add a List of ServletBean.

Parameters:

servlets - the ServletBeans to add

addServlet

public void addServlet(ServletBean servlet)

Add a new servlet bean.

Parameters:

servlet - the ServletBean to add

getServlet

public ServletBean getServlet(String name)

Get a servlet looking at it name.

Parameters:

name - , the servlet name

setServletMappings

public void setServletMappings(Map<String,String> servletMappings)

Set the map of servlet mapping.

Parameters:

servletMappings - a map of servlet mappings keyed with the url pattern and the servlet name as value

addServletMapping

public void addServletMapping(String pattern,
                              String name)

Add a new servlet mapping and replace old mapping with same pattern.

Parameters:

pattern - the URL pattern for which we want to add a mapping

name - the name of the servlet mapped to the specified URL pattern

findServletMapping

public String findServletMapping(String pattern)

Return the servlet name mapped by the given pattern otherwise return null.

Parameters:

pattern - the url-pattern

getServlets

public Map<String,ServletBean> getServlets()

Return the List of servlets.

Returns:

servlets

setRoles

public void setRoles(List<String> roles)

Set roles.

Parameters:

roles - a List of security roles

addRole

public void addRole(String role)

Add a new security role.

Parameters:

role - New security role

findRole

public boolean findRole(String role)

Return true if a given role is already in the list.

Parameters:

role - the security role to look for

getRoles

public List<String> getRoles()

Return the security roles defined for this application.

setWelcomeFiles

public void setWelcomeFiles(List<String> welcomeFiles)

Set the welcome files.

Parameters:

welcomeFiles - a List of welcome file names

addWelcomeFile

public void addWelcomeFile(String filename)

Add a new welcome file.

Parameters:

filename - New welcome file name

getEntryPointDefinitions

public List<EntryPointDefinition> getEntryPointDefinitions()

setEntryPointDefinitions

public void setEntryPointDefinitions(List<EntryPointDefinition> entryPointDefinitions)

getWelcomeFiles

public List<String> getWelcomeFiles()

Return the list of welcome file.

Returns:

welcomeFiles

getContext

public String getContext()

Return the context

setContext

public void setContext(String val)

Set the context

Parameters:

val - the new context

getDisplayName

public String getDisplayName()

Return the display name

setDisplayName

public void setDisplayName(String val)

Set the display name

Parameters:

val - the new display name

getDescr

public String getDescr()

Return the descr

setDescr

public void setDescr(String val)

Set the descr

Parameters:

val - the new description