ApplicationClient

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.



 

Attributes Summary

smallIcon The small-icon element contains the name of a file containing a small (16 x 16) icon image.
largeIcon The large-icon element contains the name of a file containing a large (32 x 32) icon image.
displayName The display-name element contains a short name that is intended to be displayed by tools.
description The description element is used to provide text describing the parent element.
resourceRefs Contains declarations of the application clients's references to an external resources.
environmentProps The env-entry element contains the declaration of an application client's environment entries.
ejbReferences Contains a list of ejb-ref elements used for the declaration of a reference to an enterprisebean's home.
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.
callbackHandler A class provided by the application.

 

Attribute Details


smallIcon

The small-icon element contains the name of a file containing a small (16 x 16) icon image. The file name is a relative path within the application-client jar file. The image must be either in the JPEG or GIF format, and the file name must end with the suffix ".jpg" or ".gif" respectively. The icon can be used by tools.Example: <small-icon>lib/images/employee-service-icon16x16.jpg</small-icon>

Data type:   String
Default value:   unspecified



largeIcon

The large-icon element contains the name of a file containing a large (32 x 32) icon image. The file name is a relative path within the application-client jar file. The image must be either in the JPEG or GIF format, and the file name must end with the suffix ".jpg" or ".gif" respectively. The icon can be used by tools.Example: <large-icon>lib/images/employee-service-icon32x32.jpg</large-icon>

Data type:   String
Default value:   unspecified



displayName

The display-name element contains a short name that is intended to be displayed by tools.

Data type:   String
Default value:   unspecified



description

The description element is used to provide text describing the parent element. The description element should include any information that the application-client file producer wants to provide to the consumer of the application-client file (i.e., to the Deployer). Typically, the tools used by the application-client file consumer will display the description when processing the parent element that contains the description.

Data type:   String
Default value:   unspecified



resourceRefs

Contains declarations of the application clients's references to an external resources.

Data type:  ResourceRef



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.

Data type:  EnvEntry



ejbReferences

Contains a list of ejb-ref elements used for the declaration of a reference to an enterprisebean's home.

Data type:  EjbRef



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 optionaldescription, the resource environment reference name, and an indication of the resource environment reference type expected by the application client code.Used in: application-clientExample:<resource-env-ref> <resource-env-ref-name>jms/StockQueue</resource-env-ref-name> <resource-env-ref-type>javax.jms.Queue</resource-env-ref-type></resource-env-ref>

Data type:  ResourceEnvRef



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.

Data type:  JavaClass