jrun.servlet.metadata
Class WebAppMetaData

java.lang.Object
  |
  +--jrunx.xml.XMLMetaData
        |
        +--jrun.j2ee.metadata.DescriptionMetaData
              |
              +--jrun.j2ee.metadata.J2EEMetaData
                    |
                    +--jrun.j2ee.metadata.ServerJ2EEMetaData
                          |
                          +--jrun.servlet.metadata.WebAppMetaData

public class WebAppMetaData

extends ServerJ2EEMetaData

The web-app element is the root of the deployment descriptor for a web application.

Author:

Paul Reilly, Karl Moss

Inner classes inherited from class jrunx.xml.XMLMetaData

XMLMetaData.BaseException, XMLMetaData.CouldNotCreateDocumentException, XMLMetaData.CreateInstanceException, XMLMetaData.ElementRequiredException, XMLMetaData.IntegerExpectedException, XMLMetaData.InvalidElementException, XMLMetaData.InvalidObjectException, XMLMetaData.MetaDataExportIOException, XMLMetaData.NoLocationException, XMLMetaData.NoStringConstructorException, XMLMetaData.UnsupportedArrayTypeException

Fields inherited from class jrun.j2ee.metadata.J2EEMetaData

FALSE, TRUE

Fields inherited from class jrunx.xml.XMLMetaData

logger

Constructor Summary

WebAppMetaData()

Method Summary

void	addContextParam(ContextParamMetaData contextParam)
void	addErrorPage(ErrorPageMetaData errorPage)
void	addFilter(FilterMetaData filter)
void	addFilterMapping(FilterMappingMetaData filterMapping)
void	addListener(ListenerMetaData listener)
void	addMimeMapping(MimeMappingMetaData mimeMapping)
void	addSecurityConstraint(SecurityConstraintMetaData securityConstraint)
void	addSecurityRole(SecurityRoleMetaData securityRole)
void	addServlet(ServletMetaData servlet)
void	addServletMapping(ServletMappingMetaData servletMapping)
void	addTaglib(TaglibMetaData Taglib)
java.util.Iterator	getContextParams()
WebAppMetaData	getDefaultMetaData()
ErrorPageMetaData	getErrorPage(int code) Given an error code, return the error-page metadata
ErrorPageMetaData	getErrorPage(java.lang.String className) Given an error class, return the error-page metadata
java.util.Iterator	getErrorPages()
FilterMetaData	getFilter(java.lang.String name) Given a filter name, return the filter metadata
java.util.Iterator	getFilterMappings()
java.util.List	getFilterMappingsList()
java.util.Iterator	getFilterMetaData()
java.util.List	getFiltersList()
java.util.Iterator	getListeners()
java.util.List	getListenersList()
LoginConfigMetaData	getLoginConfig()
java.util.Iterator	getMimeMappings()
java.lang.String	getMimeType(java.lang.String extension) Given a mime type extension, return the mime type
java.util.Iterator	getSecurityConstraints()
java.util.Iterator	getSecurityRoles()
ServletMetaData	getServlet(java.lang.String name) Given a servlet name, return the ServletMetaData
java.util.Iterator	getServletMappings()
java.util.List	getServletMappingsList()
java.util.Iterator	getServlets()
java.util.List	getServletsList()
SessionConfigMetaData	getSessionConfig()
java.util.Set	getSortedServlets() Returns a list of servletMetaData (ServletMetaData objects) sorted in the order that they should be loaded on startup.
java.util.Iterator	getTaglibMetaData()
WelcomeFileListMetaData	getWelcomeFileList()
void	init()
boolean	isDistributable()
void	removeServlet(java.lang.String name)
void	setDefaultMetaData(WebAppMetaData defaultMetaData)
void	setDistributable(boolean distributable)
void	setLoginConfig(LoginConfigMetaData loginConfig)
void	setSessionConfig(SessionConfigMetaData sessionConfig)
void	setWelcomeFileList(WelcomeFileListMetaData welcomeFileList)

Methods inherited from class jrun.j2ee.metadata.ServerJ2EEMetaData

addEJBLocalRef, clearEJBLocalRefs, getEJBLocalRefByName, getEJBLocalRefs, removeEJBLocalRef

Methods inherited from class jrun.j2ee.metadata.J2EEMetaData

addEJBRef, addEnvEntry, addResourceEnvRef, addResourceRef, clearEJBRefs, clearEnvEntries, clearResourceEnvRefs, clearResourceRefs, getDisplayName, getEJBRefByName, getEJBRefs, getEnvEntries, getEnvEntryByName, getIconMetaData, getJRunMetaData, getResourceEnvRefByName, getResourceEnvRefs, getResourceRefByName, getResourceRefs, removeEJBRef, removeEnvEntry, removeResourceEnvRef, removeResourceRef, setDisplayName, setIconMetaData, setJRunMetaData

Methods inherited from class jrun.j2ee.metadata.DescriptionMetaData

getDescription, setDescription

Methods inherited from class jrunx.xml.XMLMetaData

addAcronym, addAcronyms, addPackagePrefix, addPackagePrefixes, exportDocument, getAttribute, getMetaDataSource, getParent, getPersistenceContext, getText, importXML, importXML, remove, removeAttribute, setAttribute, setMetaDataSource, setMetaDataSource, setParent, setParent, setPersistenceContext, setPublicID, setSystemID, setText, sync, sync, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WebAppMetaData

public WebAppMetaData()

Method Detail

setDefaultMetaData

public void setDefaultMetaData(WebAppMetaData defaultMetaData)

getDefaultMetaData

public WebAppMetaData getDefaultMetaData()

isDistributable

public boolean isDistributable()

setDistributable

public void setDistributable(boolean distributable)

getContextParams

public java.util.Iterator getContextParams()

addContextParam

public void addContextParam(ContextParamMetaData contextParam)

getFilterMetaData

public java.util.Iterator getFilterMetaData()

getFiltersList

public java.util.List getFiltersList()

addFilter

public void addFilter(FilterMetaData filter)

getFilterMappings

public java.util.Iterator getFilterMappings()

getFilterMappingsList

public java.util.List getFilterMappingsList()

addFilterMapping

public void addFilterMapping(FilterMappingMetaData filterMapping)

getListeners

public java.util.Iterator getListeners()

getListenersList

public java.util.List getListenersList()

addListener

public void addListener(ListenerMetaData listener)

getServlets

public java.util.Iterator getServlets()

getServletsList

public java.util.List getServletsList()

addServlet

public void addServlet(ServletMetaData servlet)

getServletMappings

public java.util.Iterator getServletMappings()

getServletMappingsList

public java.util.List getServletMappingsList()

addServletMapping

public void addServletMapping(ServletMappingMetaData servletMapping)

getSessionConfig

public SessionConfigMetaData getSessionConfig()

setSessionConfig

public void setSessionConfig(SessionConfigMetaData sessionConfig)

getMimeMappings

public java.util.Iterator getMimeMappings()

addMimeMapping

public void addMimeMapping(MimeMappingMetaData mimeMapping)

getWelcomeFileList

public WelcomeFileListMetaData getWelcomeFileList()

setWelcomeFileList

public void setWelcomeFileList(WelcomeFileListMetaData welcomeFileList)

getErrorPages

public java.util.Iterator getErrorPages()

addErrorPage

public void addErrorPage(ErrorPageMetaData errorPage)

getTaglibMetaData

public java.util.Iterator getTaglibMetaData()

addTaglib

public void addTaglib(TaglibMetaData Taglib)

getSecurityConstraints

public java.util.Iterator getSecurityConstraints()

addSecurityConstraint

public void addSecurityConstraint(SecurityConstraintMetaData securityConstraint)

getLoginConfig

public LoginConfigMetaData getLoginConfig()

setLoginConfig

public void setLoginConfig(LoginConfigMetaData loginConfig)

getSecurityRoles

public java.util.Iterator getSecurityRoles()

addSecurityRole

public void addSecurityRole(SecurityRoleMetaData securityRole)

getSortedServlets

public java.util.Set getSortedServlets()

Returns a list of servletMetaData (ServletMetaData objects) sorted in the order that they should be loaded on startup. The caller must check to see if the servlet has a load-on-startup element present; if so the servlet should be preloaded.

Returns:

A new Set of ServletMetaData objects

getServlet

public ServletMetaData getServlet(java.lang.String name)

Given a servlet name, return the ServletMetaData

Parameters:

name - The servlet name

Returns:

The metadata or null if not found

removeServlet

public void removeServlet(java.lang.String name)

getFilter

public FilterMetaData getFilter(java.lang.String name)

Given a filter name, return the filter metadata

Parameters:

name - The filter name

Returns:

The metadata or null if not found

getErrorPage

public ErrorPageMetaData getErrorPage(java.lang.String className)

Given an error class, return the error-page metadata

Parameters:

name - The class name

Returns:

The metadata or null if not found

getErrorPage

public ErrorPageMetaData getErrorPage(int code)

Given an error code, return the error-page metadata

Parameters:

code - The error code

Returns:

The metadata or null if not found

getMimeType

public java.lang.String getMimeType(java.lang.String extension)

Given a mime type extension, return the mime type

Parameters:

extension - The mime type extension

Returns:

The mime type or null if not found

init

public void init()
          throws DeploymentException

Overrides:

init in class ServerJ2EEMetaData