org.apache.pluto.om.servlet
Interface WebApplicationDefinition

All Superinterfaces:
Model

public interface WebApplicationDefinition
extends Model

This interface provides access to a web application and its attributes. A web application is defined in the web.xml of a portlet application archive file. Portlet application information defined in the portlet.xml is also accessible in this interface when the information is bound to the application code.
Additionally, this interface allows to retrieve containing elements such as servlets.

This interface defines the model as known from the MVC pattern. Its purpose is to provide read access to the data stored in the model.


Method Summary
 java.lang.String getContextRoot()
          Returns the context root of the web application.
 Description getDescription(java.util.Locale locale)
          Returns the description of this web application for the given locale.
 DisplayName getDisplayName(java.util.Locale locale)
          Returns the display name for the given locale of this web application.
 ObjectID getId()
          Returns the identifier of this web application.
 ParameterSet getInitParameterSet()
          Returns all parameters of this web application.
 SecurityRoleSet getSecurityRoles()
          Returns the security roles defined for the web application.
 javax.servlet.ServletContext getServletContext(javax.servlet.ServletContext servletContext)
          Returns the servlet context of this web application.
 ServletDefinitionList getServletDefinitionList()
          Returns all servlets contained in this web application.
 

Method Detail

getId

public ObjectID getId()
Returns the identifier of this web application. The return value cannot be NULL.

Returns:
the identifier

getDisplayName

public DisplayName getDisplayName(java.util.Locale locale)
Returns the display name for the given locale of this web application. The return value may be NULL.

Returns:
the localized display name

getDescription

public Description getDescription(java.util.Locale locale)
Returns the description of this web application for the given locale. The return value may be NULL.

Returns:
the localized description

getInitParameterSet

public ParameterSet getInitParameterSet()
Returns all parameters of this web application. The return value cannot be NULL.

Returns:
the parameter set

getServletDefinitionList

public ServletDefinitionList getServletDefinitionList()
Returns all servlets contained in this web application. The return value cannot be NULL.

Returns:
a collection containing ServletModel objects

getServletContext

public javax.servlet.ServletContext getServletContext(javax.servlet.ServletContext servletContext)
Returns the servlet context of this web application. The return value cannot be NULL.

Parameters:
servletContext - a servlet context
Returns:
the servlet context of this web application

getContextRoot

public java.lang.String getContextRoot()
Returns the context root of the web application. The return value cannot be NULL.

Returns:
the context root

getSecurityRoles

public SecurityRoleSet getSecurityRoles()
Returns the security roles defined for the web application. The returned value cannot be NULL.

Returns:
a set containing SecurityRole objects


Copyright © 2003-2005 . All Rights Reserved.