ResourceEnvRef


This type is a class for model objects.

The resource-env-refType is used to define resource-env-type elements. It contains a declaration of a Deployment Component's reference to an administered object associated with a resource in the Deployment Component's environment. It consists of an optional description, the resource environment reference name, and an indication of the resource environment reference type expected by the Deployment Component code. Example: jms/StockQueue javax.jms.Queue

Package: common

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

Reference attributes having this type:
  ResourceEnvRefBinding.bindingResourceEnvRef

Collection attributes having this type:
  ApplicationClient.resourceEnvRefs
  JNDIEnvRefsGroup.resourceEnvRefs



Attributes Summary
description : EString @version J2EE1.4 deprecated, becomes descriptions The description is used by the ejb-jar file producer to provide text describing the resource env ref. The description 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 list of dependents.
name : EString The resource-env-ref-name element specifies the name of a resource environment reference; its value is the environment entry name used in the Deployment Component code. The name is a JNDI name relative to the java:comp/env context and must be unique within a Deployment Component.
type : JavaClass @ The resource-env-ref-type element specifies the type of a resource environment reference. It is the fully qualified name of a Java language class or interface.
descriptions : Description * * No description is available *



Attribute Details

description  -  @version J2EE1.4 deprecated, becomes descriptions The description is used by the ejb-jar file producer to provide text describing the resource env ref. The description 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 list of dependents.
    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 resource-env-ref-name element specifies the name of a resource environment reference; its value is the environment entry name used in the Deployment Component code. The name is a JNDI name relative to the java:comp/env context and must be unique within a Deployment Component.
    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 resource-env-ref-type element specifies the type of a resource environment reference. It is the fully qualified name of a Java language class or interface.
    Reference Type: JavaClass @
    Containment:  false
    Container:  false
    Required:  true
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  1
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

descriptions  -  * No description is available *
    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