Home » geronimo-eclipse-plugin-2.2-source-release » org.apache.geronimo.jee.application » [javadoc | source]

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *    http://www.apache.org/licenses/LICENSE-2.0
   10    *
   11    * Unless required by applicable law or agreed to in writing, software
   12    * distributed under the License is distributed on an "AS IS" BASIS,
   13    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   14    * See the License for the specific language governing permissions and
   15    * limitations under the License.
   16    */
   17   
   18   package org.apache.geronimo.jee.application;
   19   
   20   import java.io.Serializable;
   21   import java.util.ArrayList;
   22   import java.util.List;
   23   
   24   import javax.xml.bind.JAXBElement;
   25   import javax.xml.bind.annotation.XmlAccessType;
   26   import javax.xml.bind.annotation.XmlAccessorType;
   27   import javax.xml.bind.annotation.XmlAttribute;
   28   import javax.xml.bind.annotation.XmlElement;
   29   import javax.xml.bind.annotation.XmlElementRef;
   30   import javax.xml.bind.annotation.XmlType;
   31   
   32   import org.apache.geronimo.jee.deployment.AbstractService;
   33   import org.apache.geronimo.jee.deployment.Environment;
   34   import org.apache.geronimo.jee.deployment.Gbean;
   35   
   36   
   37   /**
   38    * 
   39    *                 The complex type for root element, it defines the elements of
   40    *                 root element for Geronimo enterprise application deployment
   41    *                 plan. Basically it is a sequence of elements environment,
   42    *                 module, ext-module, security, and services.
   43    *             
   44    * 
   45    * <p>Java class for applicationType complex type.
   46    * 
   47    * <p>The following schema fragment specifies the expected content contained within this class.
   48    * 
   49    * <pre>
   50    * &lt;complexType name="applicationType">
   51    *   &lt;complexContent>
   52    *     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
   53    *       &lt;sequence>
   54    *         &lt;element ref="{http://geronimo.apache.org/xml/ns/deployment-1.2}environment"/>
   55    *         &lt;element name="module" type="{http://geronimo.apache.org/xml/ns/j2ee/application-2.0}moduleType" maxOccurs="unbounded" minOccurs="0"/>
   56    *         &lt;element name="ext-module" type="{http://geronimo.apache.org/xml/ns/j2ee/application-2.0}ext-moduleType" maxOccurs="unbounded" minOccurs="0"/>
   57    *         &lt;element ref="{http://geronimo.apache.org/xml/ns/j2ee/application-2.0}security" minOccurs="0"/>
   58    *         &lt;element ref="{http://geronimo.apache.org/xml/ns/deployment-1.2}service" maxOccurs="unbounded" minOccurs="0"/>
   59    *       &lt;/sequence>
   60    *       &lt;attribute name="application-name" type="{http://www.w3.org/2001/XMLSchema}string" />
   61    *     &lt;/restriction>
   62    *   &lt;/complexContent>
   63    * &lt;/complexType>
   64    * </pre>
   65    * 
   66    * @version $Rev: 672410 $ $Date: 2008-06-28 06:16:51 +0800 (Sat, 28 Jun 2008) $
   67    */
   68   @XmlAccessorType(XmlAccessType.FIELD)
   69   @XmlType(name = "applicationType", propOrder = {
   70       "environment",
   71       "module",
   72       "extModule",
   73       "security",
   74       "service"
   75   })
   76   public class Application
   77       implements Serializable
   78   {
   79   
   80       private final static long serialVersionUID = 12343L;
   81       @XmlElement(namespace = "http://geronimo.apache.org/xml/ns/deployment-1.2", required = true)
   82       protected Environment environment;
   83       protected List<Module> module;
   84       @XmlElement(name = "ext-module")
   85       protected List<ExtModule> extModule;
   86       @XmlElementRef(name = "security", namespace = "http://geronimo.apache.org/xml/ns/j2ee/application-2.0", type = JAXBElement.class)
   87       protected JAXBElement<? extends AbstractSecurity> security;
   88       @XmlElementRef(name = "service", namespace = "http://geronimo.apache.org/xml/ns/deployment-1.2", type = JAXBElement.class)
   89       protected List<JAXBElement<? extends AbstractService>> service;
   90       @XmlAttribute(name = "application-name")
   91       protected java.lang.String applicationName;
   92   
   93       /**
   94        * 
   95        *                         Reference to environment element defined in imported
   96        *                         "geronimo-module-1.2.xsd"
   97        *                     
   98        * 
   99        * @return
  100        *     possible object is
  101        *     {@link Environment}
  102        *     
  103        */
  104       public Environment getEnvironment() {
  105           return environment;
  106       }
  107   
  108       /**
  109        * 
  110        *                         Reference to environment element defined in imported
  111        *                         "geronimo-module-1.2.xsd"
  112        *                     
  113        * 
  114        * @param value
  115        *     allowed object is
  116        *     {@link Environment}
  117        *     
  118        */
  119       public void setEnvironment(Environment value) {
  120           this.environment = value;
  121       }
  122   
  123       /**
  124        * Gets the value of the module property.
  125        * 
  126        * <p>
  127        * This accessor method returns a reference to the live list,
  128        * not a snapshot. Therefore any modification you make to the
  129        * returned list will be present inside the JAXB object.
  130        * This is why there is not a <CODE>set</CODE> method for the module property.
  131        * 
  132        * <p>
  133        * For example, to add a new item, do as follows:
  134        * <pre>
  135        *    getModule().add(newItem);
  136        * </pre>
  137        * 
  138        * 
  139        * <p>
  140        * Objects of the following type(s) are allowed in the list
  141        * {@link Module }
  142        * 
  143        * 
  144        */
  145       public List<Module> getModule() {
  146           if (module == null) {
  147               module = new ArrayList<Module>();
  148           }
  149           return this.module;
  150       }
  151   
  152       /**
  153        * Gets the value of the extModule property.
  154        * 
  155        * <p>
  156        * This accessor method returns a reference to the live list,
  157        * not a snapshot. Therefore any modification you make to the
  158        * returned list will be present inside the JAXB object.
  159        * This is why there is not a <CODE>set</CODE> method for the extModule property.
  160        * 
  161        * <p>
  162        * For example, to add a new item, do as follows:
  163        * <pre>
  164        *    getExtModule().add(newItem);
  165        * </pre>
  166        * 
  167        * 
  168        * <p>
  169        * Objects of the following type(s) are allowed in the list
  170        * {@link ExtModule }
  171        * 
  172        * 
  173        */
  174       public List<ExtModule> getExtModule() {
  175           if (extModule == null) {
  176               extModule = new ArrayList<ExtModule>();
  177           }
  178           return this.extModule;
  179       }
  180   
  181       /**
  182        * 
  183        *                         Reference to security element defined in this schema. If
  184        *                         this optional element is present, all web and EJB
  185        *                         modules must make the appropriate access checks as
  186        *                         outlined in the JACC spec. This element groups the
  187        *                         security role mapping settings for the application.
  188        *                     
  189        * 
  190        * @return
  191        *     possible object is
  192        *     {@link JAXBElement }{@code <}{@link AbstractSecurity }{@code >}
  193        *     {@link JAXBElement }{@code <}{@link org.apache.geronimo.jee.security.Security}{@code >}
  194        *     
  195        */
  196       public JAXBElement<? extends AbstractSecurity> getSecurity() {
  197           return security;
  198       }
  199   
  200       /**
  201        * 
  202        *                         Reference to security element defined in this schema. If
  203        *                         this optional element is present, all web and EJB
  204        *                         modules must make the appropriate access checks as
  205        *                         outlined in the JACC spec. This element groups the
  206        *                         security role mapping settings for the application.
  207        *                     
  208        * 
  209        * @param value
  210        *     allowed object is
  211        *     {@link JAXBElement }{@code <}{@link AbstractSecurity }{@code >}
  212        *     {@link JAXBElement }{@code <}{@link org.apache.geronimo.jee.security.Security}{@code >}
  213        *     
  214        */
  215       public void setSecurity(JAXBElement<? extends AbstractSecurity> value) {
  216           this.security = ((JAXBElement<? extends AbstractSecurity> ) value);
  217       }
  218   
  219       /**
  220        * 
  221        *                         Reference to service element defined in imported
  222        *                         "geronimo-module-1.2.xsd".
  223        *                     Gets the value of the service property.
  224        * 
  225        * <p>
  226        * This accessor method returns a reference to the live list,
  227        * not a snapshot. Therefore any modification you make to the
  228        * returned list will be present inside the JAXB object.
  229        * This is why there is not a <CODE>set</CODE> method for the service property.
  230        * 
  231        * <p>
  232        * For example, to add a new item, do as follows:
  233        * <pre>
  234        *    getService().add(newItem);
  235        * </pre>
  236        * 
  237        * 
  238        * <p>
  239        * Objects of the following type(s) are allowed in the list
  240        * {@link JAXBElement }{@code <}{@link Gbean}{@code >}
  241        * {@link JAXBElement }{@code <}{@link AbstractService}{@code >}
  242        * 
  243        * 
  244        */
  245       public List<JAXBElement<? extends AbstractService>> getService() {
  246           if (service == null) {
  247               service = new ArrayList<JAXBElement<? extends AbstractService>>();
  248           }
  249           return this.service;
  250       }
  251   
  252       /**
  253        * Gets the value of the applicationName property.
  254        * 
  255        * @return
  256        *     possible object is
  257        *     {@link java.lang.String }
  258        *     
  259        */
  260       public java.lang.String getApplicationName() {
  261           return applicationName;
  262       }
  263   
  264       /**
  265        * Sets the value of the applicationName property.
  266        * 
  267        * @param value
  268        *     allowed object is
  269        *     {@link java.lang.String }
  270        *     
  271        */
  272       public void setApplicationName(java.lang.String value) {
  273           if (value == null || value.length() == 0)
  274               this.applicationName = null;
  275           else
  276               this.applicationName = value;
  277       }
  278   
  279   }

Home » geronimo-eclipse-plugin-2.2-source-release » org.apache.geronimo.jee.application » [javadoc | source]