Introduction to ArcGIS Server Development Java Web ADF · 2008-06-26 · Introducing the Web Application Developer Framework (ADF) • Set of controls, tasks, and Web applications

Introduction to ArcGIS Server DevelopmentIntroduction to ArcGIS Server Development

Java Web ADFJava Web ADF

Sathya PrasadSathya Prasad

ESRI Developer Summit 2008ESRI Developer Summit 2008 11

TopicsTopics

• Introduction to the Web ADF• Web ADF controls• Toolbars, commands and tools• Tasks• Introduction to developer APIs

– Common API– Resource Specific APIs– Library Specific APIs

• Graphics


Introducing the Web Application Developer Framework (ADF)

•• Set of controls, tasks, and Web applications to enable Set of controls, tasks, and Web applications to enable creation of GIS applicationscreation of GIS applications

•• Developer librariesDeveloper libraries

•• TemplatesTemplates

•• DocumentationDocumentation

•• SamplesSamples

•• Geospatial Enterprise Java Beans (EJB)Geospatial Enterprise Java Beans (EJB)

–– Enterprise ADFEnterprise ADF


ArcObjects

ArcGIS Server

ArcGIS Server Web

Service ArcIMSJSF Framework

Web ADF for the Java Platform

Features of the Web ADFFeatures of the Web ADF

•• ArcGIS Server ManagerArcGIS Server Manager–– Build, host, and manage your Web applicationsBuild, host, and manage your Web applications

•• Custom JSF componentsCustom JSF components–– ObjectObject--oriented, AJAXoriented, AJAX--enabled JavaScript libraryenabled JavaScript library

•• Multisource web controlsMultisource web controls–– ArcGIS Server, ArcIMS, ArcWeb, WMS, and CustomArcGIS Server, ArcIMS, ArcWeb, WMS, and Custom

•• Task frameworkTask framework•• Seamless map navigationSeamless map navigation•• Client side Javascript librariesClient side Javascript libraries•• Integration with Eclipse and Creator IDEsIntegration with Eclipse and Creator IDEs


Creating Web ADF applications

1. Use ArcGIS Server Manager – Wizard to build and deploy– No prorgamming necessary– Configure tasks– Export to WAR file and modify

2. IDE integrated template – Same template used by

ArcGIS Server Manager

3. Create applications directlyusing Web controls


Web Mapping Application templateWeb Mapping Application template

•• Web pagesWeb pages•• ControlsControls•• Images/iconsImages/icons•• ThemesThemes•• JavaScript JavaScript

librarieslibraries•• Custom toolsCustom tools•• Help systemHelp system


Advantages of using the template

• Start with a complete GIS Web application

• The template provides: – Layout– Commonly used MapTools

• zoom, pan, measure, identify, full extent

– Themes– Customizable Help system– Code for docking items, closing application


DemoDemo

•• Export web application from ManagerExport web application from Manager•• Import the web application into EclipseImport the web application into Eclipse•• Run the web applicationRun the web application•• Make changes to the web applicationMake changes to the web application•• Run the web application from EclipseRun the web application from Eclipse


TopicsTopics



• Graphics


Web ADF controlsWeb ADF controls

•• Set of custom JSF Web controls Set of custom JSF Web controls •• Expose server object functionalityExpose server object functionality



•• Set of custom JSF Web controls Set of custom JSF Web controls •• Expose server object functionalityExpose server object functionality•• Types of controlsTypes of controls


Map/Overview• Displays data




Table of contents (TOC)• Map contents• Serves as a legend







Context• Non-visual control• Manages all other controls







Task• Container for functionality







Task• Container for functionality

Toolbar• Container for tools and

commands

What do the Web ADF controls do?What do the Web ADF controls do?

•• Provide a gateway to resource specific APIsProvide a gateway to resource specific APIs•• Provide an extensible framework Provide an extensible framework

–– Through event model and action listenersThrough event model and action listeners–– Ability to associate multiple renderers (e.g., HTML, WML, Ability to associate multiple renderers (e.g., HTML, WML,

DHTML)DHTML)

•• Manage state between HTTP requestsManage state between HTTP requests•• Manage relationships with other JSF componentsManage relationships with other JSF components

44--1616ESRI Developer Summit 2008ESRI Developer Summit 2008

Demo

• Create a new JSP page in Eclipse• Explore the web control tags

– Intellisense, Required attributes

• Add WebControls– Context– Map– Overview– TOC


TopicsTopics



• Graphics


Toolbar controlToolbar control

•• Displays a collection of toolsDisplays a collection of toolsand commands and commands

•• Associated to a Map controlAssociated to a Map control•• Contains a collection of toolbar itemsContains a collection of toolbar items

–– ToolTool–– CommandCommand–– DropDrop--down listdown list–– SeparatorsSeparators

•• Required attributesRequired attributes–– mapIdmapId

–– idid

44--1919

<a:toolbar mapId="map1" id="toolbar1"activeTool="toolZoomIn" >

<a:toolbar mapId="map1" id="toolbar1"activeTool="toolZoomIn" >

ESRI Developer Summit 2008ESRI Developer Summit 2008

CommandsCommands

•• Server side action triggered by eventsServer side action triggered by events–– Example: User clicks on Example: User clicks on Full ExtentFull Extent buttonbutton

•• No interaction with Map requiredNo interaction with Map required

•• Out of the box commandsOut of the box commands–– DirectionalPanListenerDirectionalPanListener

–– ZoomFullExtentListenerZoomFullExtentListener

•• Creating commandsCreating commands–– Bind a Command control to a serverBind a Command control to a server--side action listenerside action listener–– When a command button is clicked, listener class processes When a command button is clicked, listener class processes

business logicbusiness logicESRI Developer Summit 2008ESRI Developer Summit 2008 2020

ToolsTools

•• Consist of clientConsist of client--side and serverside and server--side actionsside actions

•• ClientClient--side actionside action–– Processing carried out on the browser clientProcessing carried out on the browser client–– Controlled by JavaScript functionsControlled by JavaScript functions

•• ServerServer--side actionside action–– Business logic performed on the serverBusiness logic performed on the server–– com.esri.adf.web.faces.eventcom.esri.adf.web.faces.event

•• Zoom In, Zoom Out, Pan etc..Zoom In, Zoom Out, Pan etc..

–– Custom methodCustom method


Tool controlTool control

•• Executes a client action followed by a server actionExecutes a client action followed by a server action•• Client post backClient post back•• AttributesAttributes

–– clientActionclientAction•• JavaScript functionJavaScript function•• Performed on the clientPerformed on the client

–– serverActionserverAction•• Processes the requestProcesses the request

–– serverMethodserverMethod•• Points to custom method Points to custom method

44--2222

EsriMapRectangleEsriMapPanEsriMapContinuousPanEsriMapPointEsriMapLineEsriMapPolyEsriMapOval

ZoomInToolActionZoomOutToolActionPanToolAction


myMethod(MapEvent e){ }

TopicsTopics



• Graphics


Web ADF tasksWeb ADF tasks

•• Objects that encapsulate business logicObjects that encapsulate business logic•• OutOut--ofof--thethe--box tasks configurable using Manager or IDEbox tasks configurable using Manager or IDE



•• Objects that encapsulate business logicObjects that encapsulate business logic•• OutOut--ofof--thethe--box tasks configurable using Manager or IDEbox tasks configurable using Manager or IDE•• Available tasksAvailable tasks

–– Map ToolsMap Tools




–– Map ToolsMap Tools–– Search AttributesSearch Attributes




–– Map ToolsMap Tools–– Search AttributesSearch Attributes–– GeocodingGeocoding




–– Map ToolsMap Tools–– Search AttributesSearch Attributes–– GeocodingGeocoding–– EditingEditing




–– Map ToolsMap Tools–– Search AttributesSearch Attributes–– GeocodingGeocoding–– EditingEditing–– GeoprocessingGeoprocessing


Task frameworkTask framework

•• Exposes a way to add custom functionalityExposes a way to add custom functionality



•• Exposes a way to add custom functionalityExposes a way to add custom functionality•• Tasks can contain:Tasks can contain:

–– ParametersParameters–– Commands/actionsCommands/actions–– ToolsTools





•• Why use the Task framework?Why use the Task framework?–– Tight integration with ADFTight integration with ADF

•• User interface (UI) built for youUser interface (UI) built for you•• Event handling for commands and toolsEvent handling for commands and tools







–– Organizes related functionalityOrganizes related functionality







–– Organizes related functionalityOrganizes related functionality–– Development similar to implementing standard JavaBeanDevelopment similar to implementing standard JavaBean


Anatomy of a taskAnatomy of a task

•• ParameterParameter–– Provides inputs to a taskProvides inputs to a task–– Examples: Layer name, zoom factorExamples: Layer name, zoom factor




•• Command (action)Command (action)–– Executes business logic without user Executes business logic without user

interaction with the mapinteraction with the map–– Example: Zoom to full extentExample: Zoom to full extent




•• Command (action)Command (action)–– Executes business logic without user Executes business logic without user

interaction with the mapinteraction with the map–– Example: Zoom to full extentExample: Zoom to full extent

•• ToolTool–– Requires user interaction with the mapRequires user interaction with the map–– Requires clientRequires client--side actionside action–– Examples: Identify, dynamic navigation (e.g., Zoom In/Out)Examples: Identify, dynamic navigation (e.g., Zoom In/Out)


Steps to implement a custom taskSteps to implement a custom task

1.1. Create a standard Java ClassCreate a standard Java Class–– Signature of method dictatesSignature of method dictates

a command or tool a command or tool

2.2. Register the Java class as a managed beanRegister the Java class as a managed beanin the facesin the faces--configconfig

–– Makes it available in the ADFMakes it available in the ADF

3.3. Add a task tag to the jsp, with referenceAdd a task tag to the jsp, with referenceto the managed beanto the managed bean

–– Visually displays the UI to the userVisually displays the UI to the user


Example: Implement a custom task (1)Example: Implement a custom task (1)

Create a standard Java ClassCreate a standard Java Class

Register Java class as a managed beanRegister Java class as a managed bean


MyTask.java

faces-config.xml

package com.demo;package com.demo;public class public class MyTaskMyTask {{

}}

<managed<managed--bean>bean><managed<managed--beanbean--name>name>myTaskmyTask</managed</managed--beanbean--name>name><managed<managed--beanbean--class>class>com.demo.MyTaskcom.demo.MyTask</managed</managed--beanbean--class>class><managed<managed--beanbean--scope>session</managedscope>session</managed--beanbean--scope>scope>

</managed</managed--bean>bean>

Example: Implement a custom task (2)Example: Implement a custom task (2)

Add the control to the jspAdd the control to the jsp–– Value attribute = value of managedValue attribute = value of managed--beanbean--name in facesname in faces--configconfig


<a:task value="#{<a:task value="#{myTaskmyTask}" mapId="map1" />}" mapId="map1" />

map.jsp

<managed<managed--bean>bean><managed<managed--beanbean--name>name>myTaskmyTask</managed</managed--beanbean--name>name>

faces-config.xml

DemoDemo

•• Adding a custom task to the web mapping applicationAdding a custom task to the web mapping application


TopicsTopics



• Graphics


The Web ADF APIThe Web ADF API

•• Web ADF can be divided into different areas:Web ADF can be divided into different areas:–– Common APICommon API

•• WebControlsWebControls

–– Resource specific APIsResource specific APIs•• ArcGIS Server, ArcIMS, ArcWeb Services, WMSArcGIS Server, ArcIMS, ArcWeb Services, WMS

•• Web ADF APIs use:Web ADF APIs use:–– Library specific APIs based on type of resourceLibrary specific APIs based on type of resource

•• ArcObjects, Java Connector etc..ArcObjects, Java Connector etc..

77--4343ESRI Developer Summit 2008ESRI Developer Summit 2008

Web ADF development pathsWeb ADF development paths

99--4444

WebcontrolsCommon API

Resource specific API

AGS AIMS WSIn

tern

et

Loca

l

Library specific API

WebContext

WebMapWebxxx

SOAP API(arcgisws.jar)

ArcObjects API(arcobjects.jar)

Java Connector API

(arcims_jconnect.jar)

ArcWeb ServicesAPI

(arcgis_arcweb_stubs.jar)


Organization of the Developer APIsOrganization of the Developer APIs

com.esri.adf.webcom.esri.adf.webcom.esri.adf.web.datacom.esri.adf.web.datacom.esri.adf.web.data.geometrycom.esri.adf.web.data.geometrycom.esri.adf.web.data.querycom.esri.adf.web.data.querycom.esri.adf.web.data.renderercom.esri.adf.web.data.renderercom.esri.adf.web.data.resultscom.esri.adf.web.data.resultscom.esri.adf.web.data.symbolcom.esri.adf.web.data.symbolcom.esri.adf.web.data.taskscom.esri.adf.web.data.taskscom.esri.adf.web.faces.*com.esri.adf.web.faces.*com.esri.adf.web.taskscom.esri.adf.web.taskscom.esri.adf.web.utilcom.esri.adf.web.utilcom.esri.adf.web.wms.*com.esri.adf.web.wms.*com.esri.adf.web.ags.*com.esri.adf.web.ags.*com.esri.adf.web.aims.*com.esri.adf.web.aims.*com.esri.adf.web.aws.*com.esri.adf.web.aws.*com.esri.adf.web.ejb.*com.esri.adf.web.ejb.*com.esri.arcgisws.*com.esri.arcgisws.*com.esri.aims.mtier.*com.esri.aims.mtier.*com.esri.arcgis.*com.esri.arcgis.*

99--4545

Common API

Resource Specific API

Library Specific API


Common APICommon API

• Provides a generic way for Web controls to access functionality

• Exposes commonly used functionality – Query, QueryCriteria, Highlight, Zoom etc..

• Exposes business objects – WebMap, WebQuery, WebGraphics, WebResults

•• Gives access to other APIs Gives access to other APIs


Context controlContext control

WebGeocode, …WebGeocode, …

WebContextWebContext

WebGraphicsWebGraphics WebQueryWebQuery

Map controlMap control Toc controlToc control Overview controlOverview control

WebMapWebMap WebTocWebToc

WebOverviewWebOverview

Advantages of the Common API

• Removes business and GIS logic from Web controls

• Support for multiple data sources using the same API

• Easy to program against different data sources

• Implement your own custom data sources

• Code is portable

• Abstracts Implementation


Resource Specific APIs

• Each resource exposes a different set of functionality– ArcGIS Server - SOAP, ArcObjects – (HTTP , DCOM)– ArcIMS – ArcXML – (TCP, HTTP)– ArcWeb Services – SOAP (HTTP)

• What does this mean?– Many other resource specific classes available– More value objects, business/GIS logic– Different APIs use different communication protocols– Requires different programming patterns for each data source–– Available functionality depends on:Available functionality depends on:

Underlying capabilities of the server objectUnderlying capabilities of the server objectCapabilities exposed through the ADF APICapabilities exposed through the ADF API


Library Specific APIsLibrary Specific APIs

•• Has more functionality available than common or Has more functionality available than common or Resource specific APIsResource specific APIs

•• Use it only when the higher level APIs do not provide Use it only when the higher level APIs do not provide the required functionality (Example: Buffer)the required functionality (Example: Buffer)

–– Custom tasks to execute business logicCustom tasks to execute business logic

•• Example: ArcObjects APIExample: ArcObjects API–– Gives you access to the server objectsGives you access to the server objects

•• MapServer, geocodeServer, etc.MapServer, geocodeServer, etc.

–– Gives you access to fine grained ArcObjectsGives you access to fine grained ArcObjects•• IMapServer, IMapServerInfo, IMapServerLayout etcIMapServer, IMapServerInfo, IMapServerLayout etc


TopicsTopics



• Graphics


Graphics layerGraphics layer

•• Drawn on top of layers in the mapDrawn on top of layers in the map

•• Used by other tasksUsed by other tasks–– Highlighting featuresHighlighting features–– Labeling textLabeling text–– Displaying buffersDisplaying buffers–– EditingEditing–– Custom tasksCustom tasks

•• Rendering occurs independently from the mapRendering occurs independently from the map

–– Does not require a map redrawDoes not require a map redraw


Using the graphics layerUsing the graphics layer

•• WebQueryWebQuery–– Uses a default symbol to display graphicsUses a default symbol to display graphics–– Can apply different point, line, or polygon symbols Can apply different point, line, or polygon symbols –– Provides convenient access to the graphics layerProvides convenient access to the graphics layer–– Ideal for displaying a few features in one colorIdeal for displaying a few features in one color

•• Buffer, selected features, etc.Buffer, selected features, etc.


Using the graphics layerUsing the graphics layer

•• WebQueryWebQuery–– Uses a default symbol to display graphicsUses a default symbol to display graphics–– Can apply different point, line, or polygon symbols Can apply different point, line, or polygon symbols –– Provides convenient access to the graphics layerProvides convenient access to the graphics layer–– Ideal for displaying a few features in one colorIdeal for displaying a few features in one color

•• Buffer, selected features, etc.Buffer, selected features, etc.

•• WebGraphicsWebGraphics–– Uses a renderer to display graphicsUses a renderer to display graphics

•• More control over displayMore control over display

–– Can render based on attribute valuesCan render based on attribute values–– Ideal for displaying large number of featuresIdeal for displaying large number of features


SummarySummary



• Graphics


In ConclusionIn Conclusion……

•• All sessions are recorded and will be available on EDNAll sessions are recorded and will be available on EDN–– Slides and code will also be availableSlides and code will also be available

•• Please fill out session surveys!Please fill out session surveys!

•• Still have questions?Still have questions?1.1. Tech talk, Demo Theatres, Meet the TeamTech talk, Demo Theatres, Meet the Team2.2. ““Ask a DeveloperAsk a Developer”” link on web pagelink on web page

•• www.esri.com/devsummit/techquestionswww.esri.com/devsummit/techquestions


Documents

Introduction to ArcGIS Server Development Java Web ADF · 2008-06-26 · Introducing the Web Application Developer Framework (ADF) • Set of controls, tasks, and Web applications