ApplicationClient

ApplicationClient

This type is a class for model objects.

The application-client element is the root element of an application client deployment descriptor. The application client deployment descriptor describes the EJB components and external resources referenced by the application client.
Package: client
Supertype: CompatibilityDescriptionGroup

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

Reference attributes having this type:
  ApplicationClientBinding.applicationClient
  ApplicationClientExtension.extendedApplicationClient
  ApplicationClientFile.deploymentDescriptor

Attributes Summary

version : EString @version J2EE1.4 The required value for the version is 1.4.

resourceRefs : ResourceRef * Contains declarations of the application clients's references to an external resources.

environmentProps : EnvEntry * The env-entry element contains the declaration of an application client's environment entries. Each declaration consists of an optional description, the name of the environment entry, and an optional value.

ejbReferences : EjbRef * Contains a list of ejb-ref elements used for the declaration of a reference to an enterprise bean's home.

resourceEnvRefs : ResourceEnvRef * The resource-env-ref element contains a declaration of an application client's reference to an administered object associated with a resource in the application client'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 application client code. Used in: application-client Example: jms/StockQueue javax.jms.Queue

callbackHandler : JavaClass @ A class provided by the application. The class must have a no args constructor and must implement the javax.security.auth.callback.CallbackHandler interface. The class will be instantiated by the application client container and used by the container to collect authentication information from the user.

serviceRefs : ServiceRef * @version J2EE1.4

messageDestinationRefs : MessageDestinationRef * @version J2EE1.4 The message-destination-ref-name element specifies the name of a message destination reference; its value is the message destination reference name used in the application client code. The name is a JNDI name relative to the java:comp/env context and must be unique within an application client.

messageDestinations : MessageDestination * @version J2EE1.4

Attribute Details

version  -  @version J2EE1.4 The required value for the version is 1.4.
    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

resourceRefs  -  Contains declarations of the application clients's references to an external resources.
    Reference Type: ResourceRef *
    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

environmentProps  -  The env-entry element contains the declaration of an application client's environment entries. Each declaration consists of an optional description, the name of the environment entry, and an optional value.
    Reference Type: EnvEntry *
    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

ejbReferences  -  Contains a list of ejb-ref elements used for the declaration of a reference to an enterprise bean's home.
    Reference Type: EjbRef *
    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

resourceEnvRefs  -  The resource-env-ref element contains a declaration of an application client's reference to an administered object associated with a resource in the application client'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 application client code. Used in: application-client Example: jms/StockQueue javax.jms.Queue
    Reference Type: ResourceEnvRef *
    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

callbackHandler  -  A class provided by the application. The class must have a no args constructor and must implement the javax.security.auth.callback.CallbackHandler interface. The class will be instantiated by the application client container and used by the container to collect authentication information from the user.
    Reference Type: JavaClass @
    Containment:  false
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

serviceRefs  -  @version J2EE1.4
    Reference Type: ServiceRef *
    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

messageDestinationRefs  -  @version J2EE1.4 The message-destination-ref-name element specifies the name of a message destination reference; its value is the message destination reference name used in the application client code. The name is a JNDI name relative to the java:comp/env context and must be unique within an application client.
    Reference Type: MessageDestinationRef *
    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

messageDestinations  -  @version J2EE1.4
    Reference Type: MessageDestination *
    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
version : EString	@version J2EE1.4 The required value for the version is 1.4.
resourceRefs : ResourceRef *	Contains declarations of the application clients's references to an external resources.
environmentProps : EnvEntry *	The env-entry element contains the declaration of an application client's environment entries. Each declaration consists of an optional description, the name of the environment entry, and an optional value.
ejbReferences : EjbRef *	Contains a list of ejb-ref elements used for the declaration of a reference to an enterprise bean's home.
resourceEnvRefs : ResourceEnvRef *	The resource-env-ref element contains a declaration of an application client's reference to an administered object associated with a resource in the application client'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 application client code. Used in: application-client Example: jms/StockQueue javax.jms.Queue
callbackHandler : JavaClass @	A class provided by the application. The class must have a no args constructor and must implement the javax.security.auth.callback.CallbackHandler interface. The class will be instantiated by the application client container and used by the container to collect authentication information from the user.
serviceRefs : ServiceRef *	@version J2EE1.4
messageDestinationRefs : MessageDestinationRef *	@version J2EE1.4 The message-destination-ref-name element specifies the name of a message destination reference; its value is the message destination reference name used in the application client code. The name is a JNDI name relative to the java:comp/env context and must be unique within an application client.
messageDestinations : MessageDestination *	@version J2EE1.4