Java Web ADF runtime files and components

In this topic

About the Java Web Application Developer Framework

The Java Web Application Developer Framework (ADF) operates independent from any server product, such as ArcGIS for Server or ArcIMS. Since the Java Web ADF can be installed as a stand-alone product, it contains the necessary components to work with remote services as well as integrated development environment (IDE) plug-ins. The following items are included in the Java Web ADF installation:
  • Components
    • Web ADF Java Web controls
    • Web ADF Java Connector
    • ArcObjects library
    • ArcGIS Java Web Services (AgsJWS)
    • Eclipse plug-in
  • Developer IDE integration
    • Eclipse and NetBeans plug-ins are provided to extend the IDE. The plug-ins include the Web ADF control snippets, Web application templates, an integrated Help system, and server connection preferences. 
  • Documentation
    • Help for Java developers is accessible from the developer's Eclipse environment and as a stand-alone Eclipse Help system accessed from the install directory. The developer Help includes the following:
      • Discussions and guidelines on the use of Web ADF components
      • Samples
      • Library references 

Components

The Java Web ADF support libraries are located at <Path to ArcGIS>/Server10.0/java/lib/.  The support libraries can be included in your Web application to enable particular features of the Web ADF. The support libraries include the following (with subfolder listed if appropriate):
  • ArcObjects Java interop libraries
    • arcobjects.jar
  • ArcGIS Web Services – /webservices
    • arcgis_agsws_stubs.jar
    • arcgis_ws_runtime.jar
  • ArcGIS Security – /security
    • arcgis_securityapi.jar
    • arcgis_securityutil.jar
  • ArcGIS Web Map Service (WMS) Client – /wmsclient
    • arcgis_wmsclient.jar
    • arcgis_wmsclient_impl.jar
  • ArcIMS Java Connector – /javaconnector
    • arcims_jconnect.jar
  • ArcSDE SDK – /sde
    • jpe_sdk.jar
    • jsde_sdk.jar
    • jsde_sdkres.jar
The Web ADF controls libraries are located at <Path to ArcGIS>/Server10.0/java/web/webcontrols/WEB-INF/lib. The controls libraries can be included in your Web application to enable the JavaServer Faces (JSF) Web controls included with the Web ADF. The Web ADF controls libraries include the following:
  • Web ADF native libraries
    • arcgis_webcontrols.jar
    • arcgis_webcontrols_ags.jar
    • arcgis_webcontrols_arcims.jar
    • arcgis_webcontrols_core.jar
    • arcgis_webcontrols_ve.jar
    • arcgis_webcontrols_wms.jar
The environment variables changed at version 10. ArcGIS for Server for Java installs the following environment variables:
  • AGSSERVERJAVA: <Path to ArcGIS>\Server10.0
  • AGSDEVKITHOME: <Path to ArcGIS>\DeveloperKit10.0
Core functionality for Server is located at %AGSSERVERJAVA%\java and the Java Web ADF Software Development Kit (SDK) tooling, documentation, and samples are located at %AGSDEVKITHOME%\java.
The reference to <Path to ArcGIS> equates to your ArcGIS install directory (for example, C:\Program Files\ArcGIS). 

Map application structure

The Web ADF provides a project skeleton located under $ARCGIS/java/web/web_map_application with the following structure:
Folder
Description
web_map_application
Root map application project folder.
/JavaSource
Template source code directory.  This folder is where you place your own Java Source classes and properties files. 
/WebContent
Holds the Web ADF application files used by the application server. 
  • /css
This folder is in the WebContent folder and contains the template stylesheet files. 
  • /help
This folder is in the WebContent folder and contains help system files your application can reference.
  • /images
This folder is in the WebContent folder and contains template image files used in your Web map application.
  • /js
This folder is in the WebContent folder and contains client-side JavaScript files referenced by your Web application. 
  • /themes
This folder is in the WebContent folder and contains the required stylesheet and image files for the various out-of-the-box Web application templates provided by the Web ADF. 
  • /WEB-INF
This folder is in the WebContent folder and contains files that are used as part of the runtime Web application but are hidden from your browser. 
    • /classes
This folder is in the WEB-INF folder and contains compiled Java classes along with property files required by the Web ADF. These files are typically copied from JavaSource. 
    • /functionalities
This folder is in the WEB-INF folder and contains extended JSF configuration details.
    • faces-config.xml
This file is in the WEB-INF folder and is the JSF configuration file. This file lists bean resources and map entry configuration information required by your Web mapping application.
    • web.xml
This file is in the WEB-INF folder and is the Web application deployment descriptor for your application.  This is an XML file that describes servlets and other components that make up your application.
    • ajax-renderers.xml
This file is in the WEB-INF folder and is an extended JSF configuration file that lists AJAX-managed bean resources for your Web application.

Dependent libraries

The Web ADF follows the Model-View-Controller (MVC) pattern where the existing architecture is broken down into three tiers with respect to the dependent libraries required for an application.  Making efficient use of the Web ADF dependent libraries will help ensure your application is optimized with the required library references. 
The library reference tiers are as follows:
  • Core
  • Resource
  • Business logic
The core library reference for the Web ADF is arcgis_webcontrols.jar.  This is used by all your Web ADF applications regardless of which resource or server references are required. 
The resource library reference refers to the type of resource to which your application will connect.  Following is a list of resources and their required library references: 
  • ArcGIS for Server: arcgis_webcontrols_ags.jar
  • ArcIMS: arcgis_webcontrols_arcims.jar
  • OGC/WMS: arcgis_webcontrols_wms.jar
The business logic library reference refers to the controlling logic provided by the resource to which you are connecting.  Following is a list of resources and their respective business logic libraries:
  • ArcGIS for Server: arcobjects.jar (local connection) & arcgis_agsws_stubs.jar (remote connection through web services)
  • ArcIMS: arcims_jconnect.jar
  • OGC/WMS: arcgis_wmsclient.jar & arcgis_wmsclient_impl.jar
If your application makes exclusive use of an ArcGIS for Server local connection resource, you need the following Web ADF libraries:
  • Core: arcgis_webcontrols.jar
  • Resource: arcgis_webcontrols_ags.jar
  • Business logic: arcobjects.jar
You do not need to include libraries for other resources or their respective business logic libraries in this particular application scenario. 

IDE integration

Plug-ins are provided for Eclipse and NetBeans, such as the WebADF controls, a Web Mapping Application template, integrated Help system, and a set of context wizards.  For more information, see IDE Integration.





Development licensing Deployment licensing
Server Server