org.apache.axis2.jaxws.description.xml.handler
Class EnvEntryType

java.lang.Object
  extended by org.apache.axis2.jaxws.description.xml.handler.EnvEntryType

public class EnvEntryType
extends Object

The env-entryType is used to declare an application's environment entry. The declaration consists of an optional description, the name of the environment entry, a type (optional if the value is injected, otherwise required), and an optional value.

It also includes optional elements to define injection of the named resource into fields or JavaBeans properties.

If a value is not specified and injection is requested, no injection will occur and no entry of the specified name will be created. This allows an initial value to be specified in the source code without being incorrectly changed when no override has been specified.

If a value is not specified and no injection is requested, a value must be supplied during deployment.

This type is used by env-entry elements.

Java class for env-entryType complex type.

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

 <complexType name="env-entryType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" type="{http://java.sun.com/xml/ns/javaee}descriptionType"
 maxOccurs="unbounded" minOccurs="0"/>
         <element name="env-entry-name" type="{http://java.sun.com/xml/ns/javaee}jndi-nameType"/>
         <element name="env-entry-type" type="{http://java.sun.com/xml/ns/javaee}env-entry-type-valuesType"
 minOccurs="0"/>
         <element name="env-entry-value" type="{http://java.sun.com/xml/ns/javaee}xsdStringType"
 minOccurs="0"/>
         <group ref="{http://java.sun.com/xml/ns/javaee}resourceGroup"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 


Field Summary
protected  List<DescriptionType> description
           
protected  JndiNameType envEntryName
           
protected  EnvEntryTypeValuesType envEntryType
           
protected  XsdStringType envEntryValue
           
protected  String id
           
protected  List<InjectionTargetType> injectionTarget
           
protected  XsdStringType mappedName
           
 
Constructor Summary
EnvEntryType()
           
 
Method Summary
 List<DescriptionType> getDescription()
          Gets the value of the description property.
 JndiNameType getEnvEntryName()
          Gets the value of the envEntryName property.
 EnvEntryTypeValuesType getEnvEntryType()
          Gets the value of the envEntryType property.
 XsdStringType getEnvEntryValue()
          Gets the value of the envEntryValue property.
 String getId()
          Gets the value of the id property.
 List<InjectionTargetType> getInjectionTarget()
          Gets the value of the injectionTarget property.
 XsdStringType getMappedName()
          Gets the value of the mappedName property.
 void setEnvEntryName(JndiNameType value)
          Sets the value of the envEntryName property.
 void setEnvEntryType(EnvEntryTypeValuesType value)
          Sets the value of the envEntryType property.
 void setEnvEntryValue(XsdStringType value)
          Sets the value of the envEntryValue property.
 void setId(String value)
          Sets the value of the id property.
 void setMappedName(XsdStringType value)
          Sets the value of the mappedName property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

description

protected List<DescriptionType> description

envEntryName

protected JndiNameType envEntryName

envEntryType

protected EnvEntryTypeValuesType envEntryType

envEntryValue

protected XsdStringType envEntryValue

mappedName

protected XsdStringType mappedName

injectionTarget

protected List<InjectionTargetType> injectionTarget

id

protected String id
Constructor Detail

EnvEntryType

public EnvEntryType()
Method Detail

getDescription

public List<DescriptionType> getDescription()
Gets the value of the description 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 description property.

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

    getDescription().add(newItem);
 

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


getEnvEntryName

public JndiNameType getEnvEntryName()
Gets the value of the envEntryName property.

Returns:
possible object is JndiNameType

setEnvEntryName

public void setEnvEntryName(JndiNameType value)
Sets the value of the envEntryName property.

Parameters:
value - allowed object is JndiNameType

getEnvEntryType

public EnvEntryTypeValuesType getEnvEntryType()
Gets the value of the envEntryType property.

Returns:
possible object is EnvEntryTypeValuesType

setEnvEntryType

public void setEnvEntryType(EnvEntryTypeValuesType value)
Sets the value of the envEntryType property.

Parameters:
value - allowed object is EnvEntryTypeValuesType

getEnvEntryValue

public XsdStringType getEnvEntryValue()
Gets the value of the envEntryValue property.

Returns:
possible object is XsdStringType

setEnvEntryValue

public void setEnvEntryValue(XsdStringType value)
Sets the value of the envEntryValue property.

Parameters:
value - allowed object is XsdStringType

getMappedName

public XsdStringType getMappedName()
Gets the value of the mappedName property.

Returns:
possible object is XsdStringType

setMappedName

public void setMappedName(XsdStringType value)
Sets the value of the mappedName property.

Parameters:
value - allowed object is XsdStringType

getInjectionTarget

public List<InjectionTargetType> getInjectionTarget()
Gets the value of the injectionTarget 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 injectionTarget property.

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

    getInjectionTarget().add(newItem);
 

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


getId

public String getId()
Gets the value of the id property.

Returns:
possible object is String

setId

public void setId(String value)
Sets the value of the id property.

Parameters:
value - allowed object is String


Copyright © 2004-2012 The Apache Software Foundation. All Rights Reserved.