Home » geronimo-eclipse-plugin-2.2-source-release » org.apache.geronimo.jee.web » [javadoc | source]
org.apache.geronimo.jee.web
public class: WebApp [javadoc | source]
java.lang.Object
   org.apache.geronimo.jee.web.WebApp

All Implemented Interfaces:
    Serializable

Java class for web-app complex type.

The following schema fragment specifies the expected content contained within this class.

<complexType name="web-app">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element ref="{http://geronimo.apache.org/xml/ns/deployment-1.2}environment" minOccurs="0"/>
        <element name="context-root" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
        <element name="work-dir" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
        <element ref="{http://geronimo.apache.org/xml/ns/naming-1.2}web-container" minOccurs="0"/>
        <element name="container-config" type="{http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1}container-configType" minOccurs="0"/>
        <group ref="{http://geronimo.apache.org/xml/ns/naming-1.2}jndiEnvironmentRefsGroup"/>
        <element ref="{http://geronimo.apache.org/xml/ns/naming-1.2}message-destination" maxOccurs="unbounded" minOccurs="0"/>
        <sequence minOccurs="0">
          <element name="security-realm-name" type="{http://www.w3.org/2001/XMLSchema}string"/>
          <element ref="{http://geronimo.apache.org/xml/ns/j2ee/application-2.0}security" minOccurs="0"/>
        </sequence>
        <choice maxOccurs="unbounded" minOccurs="0">
          <element ref="{http://geronimo.apache.org/xml/ns/deployment-1.2}service" maxOccurs="unbounded" minOccurs="0"/>
          <element ref="{http://java.sun.com/xml/ns/persistence}persistence"/>
        </choice>
      </sequence>
    </restriction>
  </complexContent>
</complexType>
Field Summary
protected  Environment environment     
protected  String contextRoot     
protected  String workDir     
protected  GbeanLocator webContainer     
protected  ContainerConfig containerConfig     
protected  List<AbstractNamingEntry> abstractNamingEntry     
protected  List<EjbRef> ejbRef     
protected  List<EjbLocalRef> ejbLocalRef     
protected  List<ServiceRef> serviceRef     
protected  List<ResourceRef> resourceRef     
protected  List<ResourceEnvRef> resourceEnvRef     
protected  List<MessageDestination> messageDestination     
protected  String securityRealmName     
protected  JAXBElement<AbstractSecurity> security     
protected  List<Serializable> serviceOrPersistence     
Method from org.apache.geronimo.jee.web.WebApp Summary:
getAbstractNamingEntry,   getContainerConfig,   getContextRoot,   getEjbLocalRef,   getEjbRef,   getEnvironment,   getMessageDestination,   getResourceEnvRef,   getResourceRef,   getSecurity,   getSecurityRealmName,   getServiceOrPersistence,   getServiceRef,   getWebContainer,   getWorkDir,   setContainerConfig,   setContextRoot,   setEnvironment,   setSecurity,   setSecurityRealmName,   setWebContainer,   setWorkDir
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.geronimo.jee.web.WebApp Detail:
 public List<AbstractNamingEntry> getAbstractNamingEntry() 
    Gets the value of the abstractNamingEntry property.

    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the abstractNamingEntry property.

    For example, to add a new item, do as follows:

       getAbstractNamingEntry().add(newItem);
    

    Objects of the following type(s) are allowed in the list JAXBElement {@code <}GbeanRef {@code >} JAXBElement {@code <}PersistenceContextRef {@code >} JAXBElement {@code <}AbstractNamingEntry {@code >} JAXBElement {@code <}PersistenceUnitRef {@code >}

 public ContainerConfig getContainerConfig() 
    Gets the value of the containerConfig property.
 public String getContextRoot() 
    Gets the value of the contextRoot property.
 public List<EjbLocalRef> getEjbLocalRef() 
    Gets the value of the ejbLocalRef property.

    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the ejbLocalRef property.

    For example, to add a new item, do as follows:

       getEjbLocalRef().add(newItem);
    

    Objects of the following type(s) are allowed in the list EjbLocalRef

 public List<EjbRef> getEjbRef() 
    Gets the value of the ejbRef property.

    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the ejbRef property.

    For example, to add a new item, do as follows:

       getEjbRef().add(newItem);
    

    Objects of the following type(s) are allowed in the list EjbRef

 public Environment getEnvironment() 
    This is the first part of the URL used to access the web application. For example context-root of "Sample-App" will have URL of http://host:port/Sample-App" and a context-root of "/" would be make this the default web application to the server. If the web application is packaged as an EAR that can use application context in the "application.xml". This element is necessary unless you want context root to default to the WAR name.
 public List<MessageDestination> getMessageDestination() 
    Gets the value of the messageDestination property.

    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the messageDestination property.

    For example, to add a new item, do as follows:

       getMessageDestination().add(newItem);
    

    Objects of the following type(s) are allowed in the list MessageDestination

 public List<ResourceEnvRef> getResourceEnvRef() 
    Gets the value of the resourceEnvRef property.

    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the resourceEnvRef property.

    For example, to add a new item, do as follows:

       getResourceEnvRef().add(newItem);
    

    Objects of the following type(s) are allowed in the list ResourceEnvRef

 public List<ResourceRef> getResourceRef() 
    Gets the value of the resourceRef property.

    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the resourceRef property.

    For example, to add a new item, do as follows:

       getResourceRef().add(newItem);
    

    Objects of the following type(s) are allowed in the list ResourceRef

 public JAXBElement<AbstractSecurity> getSecurity() 
    Gets the value of the security property.
 public String getSecurityRealmName() 
    Gets the value of the securityRealmName property.
 public List<Serializable> getServiceOrPersistence() 
    Gets the value of the serviceOrPersistence property.

    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the serviceOrPersistence property.

    For example, to add a new item, do as follows:

       getServiceOrPersistence().add(newItem);
    

    Objects of the following type(s) are allowed in the list JAXBElement {@code <}AbstractService {@code >} JAXBElement {@code <}Gbean {@code >} Persistence

 public List<ServiceRef> getServiceRef() 
    Gets the value of the serviceRef property.

    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the serviceRef property.

    For example, to add a new item, do as follows:

       getServiceRef().add(newItem);
    

    Objects of the following type(s) are allowed in the list ServiceRef

 public GbeanLocator getWebContainer() 
    Gets the value of the webContainer property.
 public String getWorkDir() 
    Gets the value of the workDir property.
 public  void setContainerConfig(ContainerConfig value) 
    Sets the value of the containerConfig property.
 public  void setContextRoot(String value) 
    Sets the value of the contextRoot property.
 public  void setEnvironment(Environment value) 
    This is the first part of the URL used to access the web application. For example context-root of "Sample-App" will have URL of http://host:port/Sample-App" and a context-root of "/" would be make this the default web application to the server. If the web application is packaged as an EAR that can use application context in the "application.xml". This element is necessary unless you want context root to default to the WAR name.
 public  void setSecurity(JAXBElement<AbstractSecurity> value) 
    Sets the value of the security property.
 public  void setSecurityRealmName(String value) 
    Sets the value of the securityRealmName property.
 public  void setWebContainer(GbeanLocator value) 
    Sets the value of the webContainer property.
 public  void setWorkDir(String value) 
    Sets the value of the workDir property.