Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<table class="confluenceTable"><tbody>
<tr>
<td class="confluenceTd"><p> Module Maintainer: </p></td>
<td class="confluenceTd"><p> <a class="confluence-link confluence-userlink" data-username="groldan" href="/display/~groldan" data-linked-resource-id="2971" data-linked-resource-type="userinfo" username="groldan" data-linked-resource-default-alias="Gabriel Rold&amp;aacute;n" data-base-url="http://docs.codehaus.org">Gabriel Rold&aacute;n</a> </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> Status: </p></td>
<td class="confluenceTd"><p> <table class="wysiwyg-macro" data-macro-name="excerpt" data-macro-parameters="atlassian-macro-output-type=INLINE" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2V4Y2VycHQ6YXRsYXNzaWFuLW1hY3JvLW91dHB1dC10eXBlPUlOTElORX0&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p> <img class="emoticon emoticon-yellow-star" data-emoticon-name="yellow-star" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/star_yellow.png" alt="(star)" title="(star)" /> <img class="emoticon emoticon-yellow-star" data-emoticon-name="yellow-star" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/star_yellow.png" alt="(star)" title="(star)" /> <img class="emoticon emoticon-yellow-star" data-emoticon-name="yellow-star" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/star_yellow.png" alt="(star)" title="(star)" /> <img class="emoticon emoticon-yellow-star" data-emoticon-name="yellow-star" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/star_yellow.png" alt="(star)" title="(star)" /> <img class="emoticon emoticon-yellow-star" data-emoticon-name="yellow-star" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/star_yellow.png" alt="(star)" title="(star)" /> </p></td></tr></table> </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> Email Help: </p></td>
<td class="confluenceTd"><p> Geotools-gt2-users@lists.sourceforge.net </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> Volunteer: </p></td>
<td class="confluenceTd"><p> geotools-devel@lists.sourceforge.net </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> Plugin: </p></td>
<td class="confluenceTd"><p> DataStore </p></td>
</tr>
</tbody></table>

<p>Plug-in provides access to an ArcSDE server for both vector and raster data.</p>

<h1>Module Status</h1>

<p><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /> The arcsde module is stable for data reading for both vector and raster data.</p>

<p><img class="emoticon emoticon-cross" data-emoticon-name="cross" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/error.png" alt="(error)" title="(error)" /> The test suite is not being run as a part of the nightly build as there is no build profile which would connect it to a live SDE instance to perform tests.</p>

<h2>Gold Star Quality Assurance Check</h2>

<p>There are five 'support stars' to earn.  In order to get the ArcSDE module to supported status, we need at least four, and eventually five.</p>

<table class="confluenceTable"><tbody>
<tr>
<td class="confluenceTd"><p> status </p></td>
<td class="confluenceTd"><p> description </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <img class="emoticon emoticon-yellow-star" data-emoticon-name="yellow-star" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/star_yellow.png" alt="(star)" title="(star)" /> </p></td>
<td class="confluenceTd"><p> IP check, see <a href="http://svn.osgeo.org/geotools/trunk/modules/plugin/arcsde/datastore/src/site/apt/review.apt">review.apt</a> </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <img class="emoticon emoticon-yellow-star" data-emoticon-name="yellow-star" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/star_yellow.png" alt="(star)" title="(star)" /> </p></td>
<td class="confluenceTd"><p> Releasable - has no blocking bugs in jira </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <img class="emoticon emoticon-yellow-star" data-emoticon-name="yellow-star" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/star_yellow.png" alt="(star)" title="(star)" /> </p></td>
<td class="confluenceTd"><p> Used in anger - Used by GeoServer or uDig on large real world datasets – used by MassGIS to serve the statewide landuse dataset.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <img class="emoticon emoticon-yellow-star" data-emoticon-name="yellow-star" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/star_yellow.png" alt="(star)" title="(star)" /> </p></td>
<td class="confluenceTd"><p> Optimized - has been tuned to meet hard performance requirements (example shapefile) </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> <img class="emoticon emoticon-yellow-star" data-emoticon-name="yellow-star" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/star_yellow.png" alt="(star)" title="(star)" /> </p></td>
<td class="confluenceTd"><p> Supported - user docs, module maintainer watches user list, answers email etc..  Javadocs could use a review.</p></td>
</tr>
</tbody></table>

<h2>Recent Development (as of May 2009)</h2>

<p>For the <a class="confluence-link" href="/display/GEOTOOLS/2.6.x" data-linked-resource-id="111706541" data-linked-resource-type="page" data-linked-resource-default-alias="2.6.x" data-base-url="http://docs.codehaus.org">2.6.x</a> branch (trunk) arcsde raster support has been completely refurbished in order to support all the ArcSDE raster pixel depths, and any number of bands (with the exception of 4-bit rasters and 1-bit ones with more than one band), as well as colormapped rasters (8 or 16-bit rasters with a color pallete).<br />
The vector support was also enhanced to perform really well under high concurrency.<br />
All the changes in the 2.6.x series are being backported to the stable <a class="confluence-link" href="/display/GEOTOOLS/2.5.x" data-linked-resource-id="66511" data-linked-resource-type="page" data-linked-resource-default-alias="2.5.x" data-base-url="http://docs.codehaus.org">2.5.x</a> branch.</p>

<p>For the <a class="confluence-link" href="/display/GEOTOOLS/2.5.x" data-linked-resource-id="66511" data-linked-resource-type="page" data-linked-resource-default-alias="2.5.x" data-base-url="http://docs.codehaus.org">2.5.x</a> branch arcsde has been almost completely rewritten, it no longer extends AbstractDatatore and the code is <strong>much</strong> easier to follow. Internally it protects all SeConnection use behind a Queue (rather than a Lock) as a way of addressing concurrent usage in a fair manner.<br />
Also, it has been extended to support the read and edition of versioned tables, limited to edit the default version.</p>

<p>For the <a class="confluence-link" href="/display/GEOTOOLS/2.4.x" data-linked-resource-id="65815" data-linked-resource-type="page" data-linked-resource-default-alias="2.4.x" data-base-url="http://docs.codehaus.org">2.4.x</a> branch arcsde is working on returning to supported status; we need to provide a profile for nightly builds to run.  ArcSDE Raster Support is also available on 2.4.x as well.  You can find out about it at the <a class="confluence-link unresolved" data-content-title="ArcSDE Raster Support" data-space-key="GEOTDOC" data-linked-resource-default-alias="ArcSDE Raster Support" href="#">ArcSDE Raster Support</a> page.</p>

<p>For the <a class="confluence-link" href="/display/GEOTOOLS/2.3.x" data-linked-resource-id="47443" data-linked-resource-type="page" data-linked-resource-default-alias="2.3.x" data-base-url="http://docs.codehaus.org">2.3.x</a> branch, there is an initial implementation of ArcSDE Raster Support.  You can find out about it <a class="confluence-link unresolved" data-content-title="ArcSDE Raster Support" data-space-key="GEOTDOC" data-linked-resource-default-alias="ArcSDE Raster Support" href="#">here</a>.</p>

<p>For the <a class="confluence-link" href="/display/GEOTOOLS/2.2.x" data-linked-resource-id="47446" data-linked-resource-type="page" data-linked-resource-default-alias="2.2.x" data-base-url="http://docs.codehaus.org">2.2.x</a> branch the arcsde module has returned to the build process with a stub jar to replace ESRI dependencies.</p>

<h2>IP Review</h2>

<p>Please refer to:</p>
<ul class="alternate">
	<li><a href="http://svn.osgeo.org/geotools/trunk/modules/plugin/arcsde/datastore/src/site/apt/review.apt">http://svn.osgeo.org/geotools/trunk/modules/plugin/arcsde/datastore/src/site/apt/review.apt</a></li>
</ul>

<h2>Usage</h2>

<p>For usage instructions please consult the <a class="confluence-link unresolved" data-content-title="ArcSDE Plugin" data-space-key="GEOTDOC" data-linked-resource-default-alias="ArcSDE Plugin" href="#">ArcSDE Plugin</a> page on the GeoTools User Guide.</p>
<h2>Outstanding Issues</h2>

<h1>Development</h1>

<p>ArcSDE used to have two great module maintainers looking after it: Saul Farber and Gabriel Roldan.<br />
As per GeoTools 2.6.x Saul dropped from being a co-maintainer but still watches the mailing lists and provides great feedback. Let's thank him for the great work during the years in implementing the basis of the current ArcSDE Raster support and general module maintainance help</p>

<p>We have a couple short term goals:</p>
<ul>
	<li>We have run into problems when using the ArcSDEDatastore from uDig; when performing an Edit (ie writing) a desktop client is quite willing to be drawing <strong>at the same time</strong>.</li>
	<li>When using a low number of connections it is quite easy to leave the DataStore without enough SeConnections to answer basic questions such as describing a FeatureType is.</li>
</ul>

<h2>Design and Research Pages</h2>

<h2>Building a Working ArcSDE using the jsde jars</h2>

<p>To connect to ArcSDE from java code, ESRI publishes a java library which is split across 2, 3 or 4 jars (depending on the version you use).  These &quot;java-to-ArcSDE connector jars&quot; are here called the 'jsde' jars, so as to seperate them from our own ArcSDE module.</p>

<p>The ArcSDE module relies on the jsde jars for all its direct communication to ArcSDE, as indeed any java-based ArcSDE client application does.  However, due to concerns about redistributing ESRI's jsde jars, geotools wanted to avoid having <strong>everyone</strong> who built gt2 download the jsde jars from the geotools maven site.  This was accomplished by the use of a 'dummy' api, which is an exact mimic of the jsde api, only it doesn't actually do anything.  It's simply classes which allow compilation of the ArcSDE module, without actually having or downloading the jsde jar files.</p>

<p>If you want to actually connect to ArcSDE using the ArcSDE module, you'll need to download the jsde jars and instruct maven to actually use them when building the ArcSDE module.</p>

<table class="wysiwyg-macro" data-macro-name="warning" data-macro-parameters="title=You have to build your module against the jsde jars if you want to use it to really access ArcSDE" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3dhcm5pbmc6dGl0bGU9WW91IGhhdmUgdG8gYnVpbGQgeW91ciBtb2R1bGUgYWdhaW5zdCB0aGUganNkZSBqYXJzIGlmIHlvdSB3YW50IHRvIHVzZSBpdCB0byByZWFsbHkgYWNjZXNzIEFyY1NERX0&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">
<p>There have been reports of problems if you:<br />
1.  Build the ArcSDE module against the dummy api<br />
2.  Copy the ArcSDE module into their application, leaving the dummy api behind<br />
3.  Copy the actual jsde jars into their application<br />
4.  Run the dummy-built module against the real jsde jars and try to access ArcSDE and fetch data</p>

<p>Mostly these problems have to do with static final constants which have different values and get inlined by the compiler.  There is a jira issue to track this, so if you need to do the above, <a href="http://jira.codehaus.org/browse/GEOT-1062">check it out</a></p></td></tr></table>

<p>The jsde jars are actually very easily available.  You can download the 9.1 jars <a href="http://support.esri.com/index.cfm?fa=downloads.patchesServicePacks.viewPatch&amp;PID=19&amp;MetaID=1198#install-cUNIX">here</a>  Just unroll the tar, zip and then tar files that you get, and extract the jsde_sdk.jar and jsde_pde.jar files.</p>

<p>Here's how to build the ArcSDE module with the real jsde jars:</p>

<table class="confluenceTable"><tbody>
<tr>
<td class="confluenceTd"><p> geotools version </p></td>
<td class="confluenceTd"><p> sde version </p></td>
<td class="confluenceTd"><p> instructions </p></td>
</tr>
<tr>
<td class="confluenceTd"><p> 2.2.x </p></td>
<td class="confluenceTd"><p> any </p></td>
<td class="confluenceTd"><p> Modify the module pom.xml to include dependencies on com.esri:jsde_sdk:9.0,com.esri:jsde_jpe:9.0 and com.esri:jsde_concurrent:9.0.  All these dependencies are commented out in the pom.xml, you just need to uncomment them and rebuild.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p> 2.3.x </p></td>
<td class="confluenceTd"><p> any </p></td>
<td class="confluenceTd"><p> Modify the module pom.xml to include dependencies on com.esri:jsde_sdk:9.0,com.esri:jsde_jpe:9.0 and com.esri:jsde_concurrent:9.0.  All these dependencies are commented out in the pom.xml, you just need to uncomment them and rebuild.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p> 2.4.x <br class="atl-forced-newline" /> 2.5.x <br class="atl-forced-newline" /> 2.6.x </p></td>
<td class="confluenceTd"><p> 9.0 </p></td>
<td class="confluenceTd"><p> add the parameter <strong>-DhaveSDEJars=true</strong> to your maven build command.  Something like this will work just fine:</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
$ mvn -DhaveSDEJars=true -Dmaven.test.skip clean install
</pre></td></tr></table>
<p>Note that the jsde version 9.0 jars are publically available at maven.geotools.fr, so your maven build will just automatically download these and build everything correctly. </p></td>
</tr>
<tr>
<td class="confluenceTd"><p>2.4.x <br class="atl-forced-newline" /> 2.5.x <br class="atl-forced-newline" /> 2.6.x </p></td>
<td class="confluenceTd"><p> 9.1 <br class="atl-forced-newline" /> 9.2 <br class="atl-forced-newline" /> 9.3 </p></td>
<td class="confluenceTd"><p> Add both the parameter <strong>-DhaveSDEJars=true</strong> and <strong>-Dsde.version=&lt;version&gt;</strong> to your maven build command.  Something like this will work:</p>
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
$ mvn -DhaveSDEJars=true -Dsde.version=9.2 -Dmaven.test.skip clean install
</pre></td></tr></table>
<p>Note that no versions other than jsde 9.0 are available via a maven repository, so you'll need to inject:</p>
<ul>
	<li>jsde_sdk</li>
	<li>jsde_jpe_sdk<br />
Into your local maven repository yourself.  Something like this should do the trick (once you've downloaded/tracked down the jars you wish to inject):
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
mvn install:install-file -DgroupId=com.esri -DartifactId=jsde_sdk -Dversion=9.3
-Dfile=jsde_sdk.jar -Dpackaging=jar -DgeneratePom=true
mvn install:install-file -DgroupId=com.esri -DartifactId=jpre_sdk -Dversion=9.3
-Dfile=jpe_sdk.jar -Dpackaging=jar -DgeneratePom=true
</pre></td></tr></table>
ESRI includes a couple more jars which we will ignore at this time:</li>
	<li>concurrent - this is now covered by Java 5</li>
	<li>icu4j - this is available from ibm and has already been published to our maven repository</li>
</ul>
</td>
</tr>
<tr>
</tr>
</tbody></table>

<h3>So what do I have to type again?</h3>

<p>To install and use the latest 9.3 jars (or whatever server you have):</p>
<ol>
	<li>Instll the ArcSDE SDK</li>
	<li>Choose the option to install &quot;arcsde developers sdk&quot;</li>
	<li>It will copy the jars into C:\\ArcGIS\\ArcSD<br class="atl-forced-newline" />lib by default</li>
	<li>Open up the command line and navigate to where the jars are</li>
	<li>Type the following maven command:
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
mvn install:install-file -DgroupId=com.esri -DartifactId=jsde_sdk -Dversion=9.3
-Dfile=jsde_sdk.jar -Dpackaging=jar -DgeneratePom=true
mvn install:install-file -DgroupId=com.esri -DartifactId=jpre_sdk -Dversion=9.3
-Dfile=jpe_sdk.jar -Dpackaging=jar -DgeneratePom=true
</pre></td></tr></table></li>
	<li>To set up your eclipse development environment for testing - go to the root of geotools and type:
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
mvn eclipse:eclipse -Parcsde -Dsde.version=9.3
</pre></td></tr></table></li>
	<li>You can also build on the command line:
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
mvn clean install -Parcsde -Dsde.version=9.3
</pre></td></tr></table></li>
</ol>

<h3>Running the Tests Against your Own Server</h3>