Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
org.netbeans.modules.j2ee.dd/1 1.13.0 2
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.j2ee.dd.api.web
Interface WebApp

All Superinterfaces:
CommonDDBean, ComponentInterface, CreateCapability, DescriptionInterface, DisplayNameInterface, FindCapability, IconInterface, RootInterface
public interface WebApp
extends RootInterface

Generated interface for WebApp element.
The WebApp object is the root of bean graph generated
for deployment descriptor(web.xml) file.
For getting the root (WebApp object) use the DDProvider.getDDRoot(org.openide.filesystems.FileObject) method.

Important note: Do not provide an implementation of this interface unless you are a DD API provider!

Field Summary
static String PROPERTY_STATUS
           
static String PROPERTY_VERSION
           
static int STATE_INVALID_PARSABLE
           
static int STATE_INVALID_UNPARSABLE
           
static int STATE_VALID
           
static String VERSION_2_3
           
static String VERSION_2_4
           
static String VERSION_2_5
           
 
Fields inherited from interface org.netbeans.modules.j2ee.dd.api.common.RootInterface
MERGE_INTERSECT, MERGE_UNION, MERGE_UPDATE
 
Method Summary
 int addContextParam(InitParam valueInterface)
           
 int addEjbLocalRef(EjbLocalRef valueInterface)
           
 int addEjbRef(EjbRef valueInterface)
           
 int addEnvEntry(EnvEntry valueInterface)
           
 int addErrorPage(ErrorPage valueInterface)
           
 int addFilter(Filter valueInterface)
           
 int addFilterMapping(FilterMapping valueInterface)
           
 int addJspConfig(JspConfig valueInterface)
           
 int addListener(Listener valueInterface)
           
 int addMessageDestination(MessageDestination valueInterface)
           
 int addMessageDestinationRef(MessageDestinationRef valueInterface)
           
 int addMimeMapping(MimeMapping valueInterface)
           
 int addResourceEnvRef(ResourceEnvRef valueInterface)
           
 int addResourceRef(ResourceRef valueInterface)
           
 int addSecurityConstraint(SecurityConstraint valueInterface)
           
 int addSecurityRole(SecurityRole valueInterface)
           
 int addServiceRef(ServiceRef valueInterface)
           
 int addServlet(Servlet valueInterface)
           
 int addServletMapping(ServletMapping valueInterface)
           
 int addTaglib(Taglib valueInterface)
           
 InitParam[] getContextParam()
           
 InitParam getContextParam(int index)
           
 EjbLocalRef[] getEjbLocalRef()
           
 EjbLocalRef getEjbLocalRef(int index)
           
 EjbRef[] getEjbRef()
           
 EjbRef getEjbRef(int index)
           
 EnvEntry[] getEnvEntry()
           
 EnvEntry getEnvEntry(int index)
           
 SAXParseException getError()
          Getter for SAX Parse Error property.
 ErrorPage[] getErrorPage()
           
 ErrorPage getErrorPage(int index)
           
 Filter[] getFilter()
           
 Filter getFilter(int index)
           
 FilterMapping[] getFilterMapping()
           
 FilterMapping getFilterMapping(int index)
           
 Listener[] getListener()
           
 Listener getListener(int index)
           
 MessageDestination[] getMessageDestination()
           
 MessageDestination getMessageDestination(int index)
           
 MessageDestinationRef[] getMessageDestinationRef()
           
 MessageDestinationRef getMessageDestinationRef(int index)
           
 MimeMapping[] getMimeMapping()
           
 MimeMapping getMimeMapping(int index)
           
 ResourceEnvRef[] getResourceEnvRef()
           
 ResourceEnvRef getResourceEnvRef(int index)
           
 ResourceRef[] getResourceRef()
           
 ResourceRef getResourceRef(int index)
           
 SecurityConstraint[] getSecurityConstraint()
           
 SecurityConstraint getSecurityConstraint(int index)
           
 SecurityRole[] getSecurityRole()
           
 SecurityRole getSecurityRole(int index)
           
 ServiceRef[] getServiceRef()
           
 ServiceRef getServiceRef(int index)
           
 Servlet[] getServlet()
           
 Servlet getServlet(int index)
           
 ServletMapping[] getServletMapping()
           
 ServletMapping getServletMapping(int index)
           
 JspConfig getSingleJspConfig()
           
 LocaleEncodingMappingList getSingleLocaleEncodingMappingList()
           
 LoginConfig getSingleLoginConfig()
           
 SessionConfig getSingleSessionConfig()
           
 WelcomeFileList getSingleWelcomeFileList()
           
 int getStatus()
          Getter for status property.
 Taglib[] getTaglib()
           
 Taglib getTaglib(int index)
           
 String getVersion()
          Getter for version property.
 boolean isDistributable()
          Getter for distributable property.
 boolean isMetadataComplete()
           
 int removeContextParam(InitParam valueInterface)
           
 int removeEjbLocalRef(EjbLocalRef valueInterface)
           
 int removeEjbRef(EjbRef valueInterface)
           
 int removeEnvEntry(EnvEntry valueInterface)
           
 int removeErrorPage(ErrorPage valueInterface)
           
 int removeFilter(Filter valueInterface)
           
 int removeFilterMapping(FilterMapping valueInterface)
           
 int removeJspConfig(JspConfig valueInterface)
           
 int removeListener(Listener valueInterface)
           
 int removeMessageDestination(MessageDestination valueInterface)
           
 int removeMessageDestinationRef(MessageDestinationRef valueInterface)
           
 int removeMimeMapping(MimeMapping valueInterface)
           
 int removeResourceEnvRef(ResourceEnvRef valueInterface)
           
 int removeResourceRef(ResourceRef valueInterface)
           
 int removeSecurityConstraint(SecurityConstraint valueInterface)
           
 int removeSecurityRole(SecurityRole valueInterface)
           
 int removeServiceRef(ServiceRef valueInterface)
           
 int removeServlet(Servlet valueInterface)
           
 int removeServletMapping(ServletMapping valueInterface)
           
 int removeTaglib(Taglib valueInterface)
           
 void setContextParam(InitParam[] value)
           
 void setContextParam(int index, InitParam valueInterface)
           
 void setDistributable(boolean value)
          Setter for distributable property.
 void setEjbLocalRef(EjbLocalRef[] value)
           
 void setEjbLocalRef(int index, EjbLocalRef valueInterface)
           
 void setEjbRef(EjbRef[] value)
           
 void setEjbRef(int index, EjbRef valueInterface)
           
 void setEnvEntry(EnvEntry[] value)
           
 void setEnvEntry(int index, EnvEntry valueInterface)
           
 void setErrorPage(ErrorPage[] value)
           
 void setErrorPage(int index, ErrorPage valueInterface)
           
 void setFilter(Filter[] value)
           
 void setFilter(int index, Filter valueInterface)
           
 void setFilterMapping(FilterMapping[] value)
           
 void setFilterMapping(int index, FilterMapping valueInterface)
           
 void setJspConfig(JspConfig value)
           
 void setListener(int index, Listener valueInterface)
           
 void setListener(Listener[] value)
           
 void setLocaleEncodingMappingList(LocaleEncodingMappingList value)
           
 void setLoginConfig(LoginConfig value)
           
 void setMessageDestination(int index, MessageDestination valueInterface)
           
 void setMessageDestination(MessageDestination[] value)
           
 void setMessageDestinationRef(int index, MessageDestinationRef valueInterface)
           
 void setMessageDestinationRef(MessageDestinationRef[] value)
           
 void setMetadataComplete(boolean value)
           
 void setMimeMapping(int index, MimeMapping valueInterface)
           
 void setMimeMapping(MimeMapping[] value)
           
 void setResourceEnvRef(int index, ResourceEnvRef valueInterface)
           
 void setResourceEnvRef(ResourceEnvRef[] value)
           
 void setResourceRef(int index, ResourceRef valueInterface)
           
 void setResourceRef(ResourceRef[] value)
           
 void setSecurityConstraint(int index, SecurityConstraint valueInterface)
           
 void setSecurityConstraint(SecurityConstraint[] value)
           
 void setSecurityRole(int index, SecurityRole valueInterface)
           
 void setSecurityRole(SecurityRole[] value)
           
 void setServiceRef(int index, ServiceRef valueInterface)
           
 void setServiceRef(ServiceRef[] value)
           
 void setServlet(int index, Servlet valueInterface)
           
 void setServlet(Servlet[] value)
           
 void setServletMapping(int index, ServletMapping valueInterface)
           
 void setServletMapping(ServletMapping[] value)
           
 void setSessionConfig(SessionConfig value)
           
 void setTaglib(int index, Taglib valueInterface)
           
 void setTaglib(Taglib[] value)
           
 void setWelcomeFileList(WelcomeFileList value)
           
 int sizeContextParam()
           
 int sizeEjbLocalRef()
           
 int sizeEjbRef()
           
 int sizeEnvEntry()
           
 int sizeErrorPage()
           
 int sizeFilter()
           
 int sizeFilterMapping()
           
 int sizeListener()
           
 int sizeMessageDestination()
           
 int sizeMessageDestinationRef()
           
 int sizeMimeMapping()
           
 int sizeResourceEnvRef()
           
 int sizeResourceRef()
           
 int sizeSecurityConstraint()
           
 int sizeSecurityRole()
           
 int sizeServiceRef()
           
 int sizeServlet()
           
 int sizeServletMapping()
           
 int sizeTaglib()
           
 
Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.RootInterface
merge, write
 
Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.CommonDDBean
addPropertyChangeListener, clone, getId, getValue, removePropertyChangeListener, setId, write
 
Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.DescriptionInterface
getAllDescriptions, getDefaultDescription, getDescription, removeAllDescriptions, removeDescription, removeDescriptionForLocale, setAllDescriptions, setDescription, setDescription
 
Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.DisplayNameInterface
getAllDisplayNames, getDefaultDisplayName, getDisplayName, removeAllDisplayNames, removeDisplayName, removeDisplayNameForLocale, setAllDisplayNames, setDisplayName, setDisplayName
 
Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.CreateCapability
addBean, addBean, createBean
 
Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.FindCapability
findBeanByName
 
Methods inherited from interface org.netbeans.modules.j2ee.dd.api.common.IconInterface
getAllIcons, getDefaultIcon, getLargeIcon, getLargeIcon, getSmallIcon, getSmallIcon, removeAllIcons, removeIcon, removeIcon, removeLargeIcon, removeLargeIcon, removeSmallIcon, removeSmallIcon, setAllIcons, setIcon, setLargeIcon, setLargeIcon, setSmallIcon, setSmallIcon
 

Field Detail

PROPERTY_VERSION

static final String PROPERTY_VERSION
See Also:
Constant Field Values

VERSION_2_3

static final String VERSION_2_3
See Also:
Constant Field Values

VERSION_2_4

static final String VERSION_2_4
See Also:
Constant Field Values

VERSION_2_5

static final String VERSION_2_5
See Also:
Constant Field Values

STATE_VALID

static final int STATE_VALID
See Also:
Constant Field Values

STATE_INVALID_PARSABLE

static final int STATE_INVALID_PARSABLE
See Also:
Constant Field Values

STATE_INVALID_UNPARSABLE

static final int STATE_INVALID_UNPARSABLE
See Also:
Constant Field Values

PROPERTY_STATUS

static final String PROPERTY_STATUS
See Also:
Constant Field Values
Method Detail

getVersion

String getVersion()
Getter for version property.

Returns:
property value

getError

SAXParseException getError()
Getter for SAX Parse Error property. Used when deployment descriptor is in invalid state.

Returns:
property value or null if in valid state

getStatus

int getStatus()
Getter for status property.

Returns:
property value

setDistributable

void setDistributable(boolean value)
Setter for distributable property.

Parameters:
value - property value

isDistributable

boolean isDistributable()
Getter for distributable property.

Returns:
property value

setContextParam

void setContextParam(int index,
                     InitParam valueInterface)

getContextParam

InitParam getContextParam(int index)

setContextParam

void setContextParam(InitParam[] value)

getContextParam

InitParam[] getContextParam()

sizeContextParam

int sizeContextParam()

addContextParam

int addContextParam(InitParam valueInterface)

removeContextParam

int removeContextParam(InitParam valueInterface)

setFilter

void setFilter(int index,
               Filter valueInterface)

getFilter

Filter getFilter(int index)

setFilter

void setFilter(Filter[] value)

getFilter

Filter[] getFilter()

sizeFilter

int sizeFilter()

addFilter

int addFilter(Filter valueInterface)

removeFilter

int removeFilter(Filter valueInterface)

setFilterMapping

void setFilterMapping(int index,
                      FilterMapping valueInterface)

getFilterMapping

FilterMapping getFilterMapping(int index)

setFilterMapping

void setFilterMapping(FilterMapping[] value)

getFilterMapping

FilterMapping[] getFilterMapping()

sizeFilterMapping

int sizeFilterMapping()

addFilterMapping

int addFilterMapping(FilterMapping valueInterface)

removeFilterMapping

int removeFilterMapping(FilterMapping valueInterface)

setListener

void setListener(int index,
                 Listener valueInterface)

getListener

Listener getListener(int index)

setListener

void setListener(Listener[] value)

getListener

Listener[] getListener()

sizeListener

int sizeListener()

addListener

int addListener(Listener valueInterface)

removeListener

int removeListener(Listener valueInterface)

setServlet

void setServlet(int index,
                Servlet valueInterface)

getServlet

Servlet getServlet(int index)

setServlet

void setServlet(Servlet[] value)

getServlet

Servlet[] getServlet()

sizeServlet

int sizeServlet()

addServlet

int addServlet(Servlet valueInterface)

removeServlet

int removeServlet(Servlet valueInterface)

setServletMapping

void setServletMapping(int index,
                       ServletMapping valueInterface)

getServletMapping

ServletMapping getServletMapping(int index)

setServletMapping

void setServletMapping(ServletMapping[] value)

getServletMapping

ServletMapping[] getServletMapping()

sizeServletMapping

int sizeServletMapping()

addServletMapping

int addServletMapping(ServletMapping valueInterface)

removeServletMapping

int removeServletMapping(ServletMapping valueInterface)

setSessionConfig

void setSessionConfig(SessionConfig value)

getSingleSessionConfig

SessionConfig getSingleSessionConfig()

setMimeMapping

void setMimeMapping(int index,
                    MimeMapping valueInterface)

getMimeMapping

MimeMapping getMimeMapping(int index)

setMimeMapping

void setMimeMapping(MimeMapping[] value)

getMimeMapping

MimeMapping[] getMimeMapping()

sizeMimeMapping

int sizeMimeMapping()

addMimeMapping

int addMimeMapping(MimeMapping valueInterface)

removeMimeMapping

int removeMimeMapping(MimeMapping valueInterface)

setWelcomeFileList

void setWelcomeFileList(WelcomeFileList value)

getSingleWelcomeFileList

WelcomeFileList getSingleWelcomeFileList()

setErrorPage

void setErrorPage(int index,
                  ErrorPage valueInterface)

getErrorPage

ErrorPage getErrorPage(int index)

setErrorPage

void setErrorPage(ErrorPage[] value)

getErrorPage

ErrorPage[] getErrorPage()
</