EnvEntry

EnvEntry

This type is a class for model objects.

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, and an optional value. If a value is not specified, one must be supplied during deployment. It is used by env-entry elements.
Package: common

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Collection attributes having this type:
  ApplicationClient.environmentProps
  JNDIEnvRefsGroup.environmentProperties
  JavaHandlerDD.parameters

Attributes Summary

description : EString @version J2EE1.4 deprecated, becomes descriptions The description element is used by the ejb-jar file producer to provide text describing the parent element. The description element should include any information that the ejb-jar file producer wants to provide to the consumer of the ejb-jar file (i.e. to the Deployer). Typically, the tools used by the ejb-jar file consumer will display the description when processing the parent element.

name : EString The env-entry-name element contains the name of a Deployment Component's environment entry. The name is a JNDI name relative to the java:comp/env context. The name must be unique within a Deployment Component. The uniqueness constraints must be defined within the declared context. Example: minAmount

value : EString The env-entry-value designates the value of a Deployment Component's environment entry. The value must be a String that is valid for the constructor of the specified type that takes a single String parameter, or for java.lang.Character, a single character. Example: 100.00

type : EnvEntryType The env-entry-type element contains the fully-qualified Java type of the environment entry value that is expected by the application client?s code.
The following are the legal values of env-entry-type: java.lang.Bool-ean, java.lang.String, java.lang.Integer, java.lang.Double, java.lang.Byte, java.lang.Short, java.lang.Long, and java.lang.Float. Example: java.lang.Boolean

descriptions : Description * @version J2EE1.4

Attribute Details

description  -  @version J2EE1.4 deprecated, becomes descriptions The description element is used by the ejb-jar file producer to provide text describing the parent element. The description element should include any information that the ejb-jar file producer wants to provide to the consumer of the ejb-jar file (i.e. to the Deployer). Typically, the tools used by the ejb-jar file consumer will display the description when processing the parent element.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

name  -  The env-entry-name element contains the name of a Deployment Component's environment entry. The name is a JNDI name relative to the java:comp/env context. The name must be unique within a Deployment Component. The uniqueness constraints must be defined within the declared context. Example: minAmount
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

value  -  The env-entry-value designates the value of a Deployment Component's environment entry. The value must be a String that is valid for the constructor of the specified type that takes a single String parameter, or for java.lang.Character, a single character. Example: 100.00
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

type  -  The env-entry-type element contains the fully-qualified Java type of the environment entry value that is expected by the application client?s code.
The following are the legal values of env-entry-type: java.lang.Bool-ean, java.lang.String, java.lang.Integer, java.lang.Double, java.lang.Byte, java.lang.Short, java.lang.Long, and java.lang.Float. Example: java.lang.Boolean
    Data Type: EnvEntryType
    Default value:  unspecified
    Allowed values:
        0 - String
        1 - Integer
        2 - Boolean
        3 - Double
        4 - Byte
        5 - Short
        6 - Long
        7 - Float
        8 - Character
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

descriptions  -  @version J2EE1.4
    Reference Type: Description *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

(C) COPYRIGHT International Business Machines Corp. 1996-2006

Attributes Summary
description : EString	@version J2EE1.4 deprecated, becomes descriptions The description element is used by the ejb-jar file producer to provide text describing the parent element. The description element should include any information that the ejb-jar file producer wants to provide to the consumer of the ejb-jar file (i.e. to the Deployer). Typically, the tools used by the ejb-jar file consumer will display the description when processing the parent element.
name : EString	The env-entry-name element contains the name of a Deployment Component's environment entry. The name is a JNDI name relative to the java:comp/env context. The name must be unique within a Deployment Component. The uniqueness constraints must be defined within the declared context. Example: minAmount
value : EString	The env-entry-value designates the value of a Deployment Component's environment entry. The value must be a String that is valid for the constructor of the specified type that takes a single String parameter, or for java.lang.Character, a single character. Example: 100.00
type : EnvEntryType	The env-entry-type element contains the fully-qualified Java type of the environment entry value that is expected by the application client?s code. The following are the legal values of env-entry-type: java.lang.Bool-ean, java.lang.String, java.lang.Integer, java.lang.Double, java.lang.Byte, java.lang.Short, java.lang.Long, and java.lang.Float. Example: java.lang.Boolean
descriptions : Description *	@version J2EE1.4