com.esri.arcgis.geodatabasedistributed
Class GeoDataServer

java.lang.Object
  com.esri.arcgis.geodatabasedistributed.GeoDataServer

All Implemented Interfaces:

IGeoDataServer, IGeoDataServer2, IGeoDataServerInit, IGeoDataServerObjects, com.esri.arcgis.interop.RemoteObjRef, IServerObject, IServerObjectExtensionManager, ILogSupport, IObjectActivate, IObjectConstruct, IRequestHandler, IRequestHandler2, IRESTRequestHandler, ISupportErrorInfo, java.io.Serializable

public class GeoDataServer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGeoDataServer, IGeoDataServer2, IGeoDataServerInit, IObjectConstruct, IRequestHandler, IRequestHandler2, IGeoDataServerObjects, IObjectActivate, ILogSupport, ISupportErrorInfo, IServerObject, IServerObjectExtensionManager, IRESTRequestHandler

COM Class 'GeoDataServer'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabaseDistributed.olb'

Description 'The GeoDataServer component provides programmatic access to a geodatabase.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geodatabasedistributed.IGeoDataServer2

IID, IID5906a736_62ed_4fb6_b84f_191131dfab07, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabasedistributed.IGeoDataServer

IIDb59deddd_065f_4c9f_942a_af79e8ab3fbc

Fields inherited from interface com.esri.arcgis.geodatabasedistributed.IGeoDataServerInit

IID, IID841bdc30_fe10_46af_b67b_582252bc16b8, xxDummy

Fields inherited from interface com.esri.arcgis.system.IRequestHandler2

IID, IID8319e7d0_8ad1_48ed_aa99_03f9d0c93ba8, xxDummy

Fields inherited from interface com.esri.arcgis.system.IRequestHandler

IID46a0e2ea_3b64_4a46_bd78_88a1660f35bb

Fields inherited from interface com.esri.arcgis.geodatabasedistributed.IGeoDataServerObjects

IID, IIDf3b8e8ca_fdcc_4f3b_a581_ab11258cb801, xxDummy

Fields inherited from interface com.esri.arcgis.system.IObjectActivate

IID, IIDe3b78022_143e_4e61_9099_ed319ec061e7, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.server.IServerObject

IID, IID0ad6ab40_9d6a_4bf8_8b86_eb89406dfc6c, xxDummy

Fields inherited from interface com.esri.arcgis.server.IServerObjectExtensionManager

IID, IID25d8b9dd_c7e8_4da4_bf4b_08a67087ceea, xxDummy

Fields inherited from interface com.esri.arcgis.system.IRESTRequestHandler

IID, IID9d66a418_d54a_48ed_88bd_043a25fa9c83, xxDummy

Constructor Summary

GeoDataServer()
Constructs a GeoDataServer using ArcGIS Engine.

GeoDataServer(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeoDataServer theGeoDataServer = (GeoDataServer) obj;

Method Summary

void	activate() Activates the object.
IGDSData	compareReplicaSchema(IGDSData relativeReplicaSchemaDoc, int transportType) Compares the schema of a replica with that of its relative, and returns a schema changes XML document.
void	construct(IPropertySet props) Two phase object construction.
IGDSData	createReplica(java.lang.String parentVersion, java.lang.String replicaName, IGPReplicaDescription replicaDesc, IGPReplicaOptions repOptions, IGDSExportOptions exportOptions, int transportType) Creates a Replica.
void	deactivate() Deactivates the object.
boolean	equals(java.lang.Object o) Compare this object with another
IGPReplicaDatasets	expandReplicaDatasets(IGPReplicaDatasets repDatasets) Expands a set of replica datasets taking into consideration geodatabase constructs (topologies, relationship classes, etc.).
IGPReplicaDatasets	expandReplicaDatasets2(IGPReplicaDatasets gPReplicaDatasets, IGPReplicaOptions replicaOptions) Expands a set of replica datasets taking into consideration geodatabase constructs (topologies, relationship classes, etc.).
IGDSData	exportAcknowledgement(java.lang.String replicaName, int transportType) Export an acknowledgement message for a replica.
IGDSData	exportReplicaDataChanges(java.lang.String replicaName, IGDSExportOptions options, int transportType, int generationsToExport, boolean switchRole) Exports data changes for a replica.
IGDSData	exportReplicaSchema(java.lang.String replicaName, int transportType) Exports the schema of a replica to an Xml document.
IGDSData	extractData(java.lang.String versionName, IGPReplicaDescription replicaDesc, IGDSExportOptions options, int transportType) Extract Data.
IServerObjectExtension	findExtensionByCLSID(java.lang.String cLSID) Returns a server object extension found using a string representation of its class ID.
IServerObjectExtension	findExtensionByTypeName(java.lang.String name) Returns a server object extension found using its type name.
static java.lang.String	getClsid() getClsid.
java.lang.String	getConfigurationName() Name of the server object configuration that defines the server object.
IDataElements	getDataElements(IDEBrowseOptions pBrowseOptions) The data elements in the workspace.
java.lang.String	getDefaultWorkingVersion() The default working version for all operations/methods.
IWorkspace	getDefaultWorkingWorkspace() The default working workspace for the geodata server.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getMaxRecordCount() The maximum number of records to be returned by a search.
IGDSQueryResultPortion	getNextResultPortion(IResultPortionInfo desiredRange) Gets the next portion of the results.
java.lang.String	getPhysicalOutputDirectory() The physical directory for output files.
IGPReplica	getReplica(java.lang.String replicaName) Return the replica in the workspace that has a specific name.
IGPReplicas	getReplicas() The replicas in the workspace.
java.lang.String	getSchema() This method returns the resource hierarchy of a REST based SOE.
java.lang.String	getTypeName() Type of the server object (MapServer or GeocodeServer).
IGPVersionInfos	getVersions() The versions in the workspace.
java.lang.String	getVirtualOutputDirectory() The virtual directory for output files.
int	getWrappedWorkspaceType() The type of the geodatabase the geodataserver operates on.
byte[]	handleBinaryRequest(byte[] request) Handles a binary request.
byte[]	handleBinaryRequest2(java.lang.String capabilities, byte[] request) Handles a binary request with explicit capabilities.
byte[]	handleRESTRequest(java.lang.String capabilities, java.lang.String resourceName, java.lang.String operationName, java.lang.String operationInput, java.lang.String outputFormat, java.lang.String requestProperties, java.lang.String[] responseProperties) Handles REST requests for SOE.
java.lang.String	handleStringRequest(java.lang.String capabilities, java.lang.String request) Handles a SOAP string request.
int	hashCode() the hashcode for this object
void	importAcknowledgement(IGDSData data) Import an acknowledgement message for a replica.
void	importData(IGDSData pData, int fmt) Imports data into the workspace.
boolean	importReplicaDataChanges(int sourceType, int reconcilePolicy, boolean columnLevel, IGDSData data) Import the data changes for a replica.
void	importReplicaSchemaChanges(IGDSData schemaChangesDoc) Updates the schema of the replica with the changes in an schema changes XML document.
void	initFromConnectionString(java.lang.String connectionString) Initializes a GeoDataServer object from a connection string to a geodatabase.
void	initFromFile(java.lang.String file) Initializes a GeoDataServer object from a geodatabase or an sde connection file (*.sde).
void	initFromMap(java.lang.String filePath) Initializes a GeoDataServer object with a map document.
void	initLogging(ILog log) Initializes an object with a log.
void	initWithWorkspace(IWorkspace pWorkspace) Initializes a GeoDataServer object with a workspace.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
IGDSData	reExportReplicaDataChanges(java.lang.String replicaName, IGDSExportOptions options, int transportType, int gensToExport) Re-exports data changes for a replica.
void	release() Release a GeoDataServer.
void	setMaxRecordCount(int count) The maximum number of records returned for query results.
void	setPhysicalOutputDirectory(java.lang.String dirPath) The physical directory for output files.
void	setVirtualOutputDirectory(java.lang.String dirPath) The virtual directory for output files.
IGDSQueryResultPortion	tableSearch(java.lang.String versionName, java.lang.String tableName, IQueryFilter queryFilter, IResultPortionInfo queryRange) Returns the records satisfying the specified query.
void	unregisterReplica(java.lang.String replicaName) Unregisters the replica.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeoDataServer

public GeoDataServer()
              throws java.io.IOException,
                     java.net.UnknownHostException

Constructs a GeoDataServer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GeoDataServer

public GeoDataServer(java.lang.Object obj)
              throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeoDataServer theGeoDataServer = (GeoDataServer) obj;

Construct a GeoDataServer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GeoDataServer.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GeoDataServer.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getMaxRecordCount

public int getMaxRecordCount()
                      throws java.io.IOException,
                             AutomationException

The maximum number of records to be returned by a search.

Specified by:

getMaxRecordCount in interface IGeoDataServer

Specified by:

getMaxRecordCount in interface IGeoDataServerInit

Returns:

The maxCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataElements

public IDataElements getDataElements(IDEBrowseOptions pBrowseOptions)
                              throws java.io.IOException,
                                     AutomationException

The data elements in the workspace.

Specified by:

getDataElements in interface IGeoDataServer

Parameters:

pBrowseOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IDataElements

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersions

public IGPVersionInfos getVersions()
                            throws java.io.IOException,
                                   AutomationException

The versions in the workspace.

Specified by:

getVersions in interface IGeoDataServer

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPVersionInfos

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplicas

public IGPReplicas getReplicas()
                        throws java.io.IOException,
                               AutomationException

The replicas in the workspace.

Specified by:

getReplicas in interface IGeoDataServer

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPReplicas

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultWorkingVersion

public java.lang.String getDefaultWorkingVersion()
                                          throws java.io.IOException,
                                                 AutomationException

The default working version for all operations/methods.

Specified by:

getDefaultWorkingVersion in interface IGeoDataServer

Returns:

The defaultWorkingVersion

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWrappedWorkspaceType

public int getWrappedWorkspaceType()
                            throws java.io.IOException,
                                   AutomationException

The type of the geodatabase the geodataserver operates on.

Specified by:

getWrappedWorkspaceType in interface IGeoDataServer

Returns:

A com.esri.arcgis.geodatabase.esriWorkspaceType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

extractData

public IGDSData extractData(java.lang.String versionName,
                            IGPReplicaDescription replicaDesc,
                            IGDSExportOptions options,
                            int transportType)
                     throws java.io.IOException,
                            AutomationException

Extract Data.

Specified by:

extractData in interface IGeoDataServer

Parameters:

versionName - The versionName (in)

replicaDesc - A reference to a com.esri.arcgis.geodatabase.IGPReplicaDescription (in)

options - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSExportOptions (in)

transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createReplica

public IGDSData createReplica(java.lang.String parentVersion,
                              java.lang.String replicaName,
                              IGPReplicaDescription replicaDesc,
                              IGPReplicaOptions repOptions,
                              IGDSExportOptions exportOptions,
                              int transportType)
                       throws java.io.IOException,
                              AutomationException

Creates a Replica.

Specified by:

createReplica in interface IGeoDataServer

Parameters:

parentVersion - The parentVersion (in)

replicaName - The replicaName (in)

replicaDesc - A reference to a com.esri.arcgis.geodatabase.IGPReplicaDescription (in)

repOptions - A reference to a com.esri.arcgis.geodatabase.IGPReplicaOptions (in)

exportOptions - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSExportOptions (in)

transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expandReplicaDatasets

public IGPReplicaDatasets expandReplicaDatasets(IGPReplicaDatasets repDatasets)
                                         throws java.io.IOException,
                                                AutomationException

Expands a set of replica datasets taking into consideration geodatabase constructs (topologies, relationship classes, etc.).

Specified by:

expandReplicaDatasets in interface IGeoDataServer

Parameters:

repDatasets - A reference to a com.esri.arcgis.geodatabase.IGPReplicaDatasets (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPReplicaDatasets

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

importData

public void importData(IGDSData pData,
                       int fmt)
                throws java.io.IOException,
                       AutomationException

Imports data into the workspace.

Specified by:

importData in interface IGeoDataServer

Parameters:

pData - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData (in)

fmt - A com.esri.arcgis.geodatabasedistributed.esriGDSImportFormat constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportReplicaDataChanges

public IGDSData exportReplicaDataChanges(java.lang.String replicaName,
                                         IGDSExportOptions options,
                                         int transportType,
                                         int generationsToExport,
                                         boolean switchRole)
                                  throws java.io.IOException,
                                         AutomationException

Exports data changes for a replica.

Specified by:

exportReplicaDataChanges in interface IGeoDataServer

Parameters:

replicaName - The replicaName (in)

options - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSExportOptions (in)

transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)

generationsToExport - A com.esri.arcgis.geodatabasedistributed.esriExportGenerationsOption constant (in)

switchRole - The switchRole (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reExportReplicaDataChanges

public IGDSData reExportReplicaDataChanges(java.lang.String replicaName,
                                           IGDSExportOptions options,
                                           int transportType,
                                           int gensToExport)
                                    throws java.io.IOException,
                                           AutomationException

Re-exports data changes for a replica.

Specified by:

reExportReplicaDataChanges in interface IGeoDataServer

Parameters:

replicaName - The replicaName (in)

options - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSExportOptions (in)

transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)

gensToExport - A com.esri.arcgis.geodatabasedistributed.esriReExportGenerationsOption constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

importReplicaDataChanges

public boolean importReplicaDataChanges(int sourceType,
                                        int reconcilePolicy,
                                        boolean columnLevel,
                                        IGDSData data)
                                 throws java.io.IOException,
                                        AutomationException

Import the data changes for a replica.

Specified by:

importReplicaDataChanges in interface IGeoDataServer

Parameters:

sourceType - A com.esri.arcgis.geodatabasedistributed.esriGDSReplicaImportSource constant (in)

reconcilePolicy - A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant (in)

columnLevel - The columnLevel (in)

data - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData (in)

Returns:

The conflictsFound

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportAcknowledgement

public IGDSData exportAcknowledgement(java.lang.String replicaName,
                                      int transportType)
                               throws java.io.IOException,
                                      AutomationException

Export an acknowledgement message for a replica.

Specified by:

exportAcknowledgement in interface IGeoDataServer

Parameters:

replicaName - The replicaName (in)

transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

importAcknowledgement

public void importAcknowledgement(IGDSData data)
                           throws java.io.IOException,
                                  AutomationException

Import an acknowledgement message for a replica.

Specified by:

importAcknowledgement in interface IGeoDataServer

Parameters:

data - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unregisterReplica

public void unregisterReplica(java.lang.String replicaName)
                       throws java.io.IOException,
                              AutomationException

Unregisters the replica.

Specified by:

unregisterReplica in interface IGeoDataServer

Parameters:

replicaName - The replicaName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

tableSearch

public IGDSQueryResultPortion tableSearch(java.lang.String versionName,
                                          java.lang.String tableName,
                                          IQueryFilter queryFilter,
                                          IResultPortionInfo queryRange)
                                   throws java.io.IOException,
                                          AutomationException

Returns the records satisfying the specified query.

Specified by:

tableSearch in interface IGeoDataServer

Parameters:

versionName - The versionName (in)

tableName - The tableName (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

queryRange - A reference to a com.esri.arcgis.geodatabase.IResultPortionInfo (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSQueryResultPortion

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNextResultPortion

public IGDSQueryResultPortion getNextResultPortion(IResultPortionInfo desiredRange)
                                            throws java.io.IOException,
                                                   AutomationException

Gets the next portion of the results.

Specified by:

getNextResultPortion in interface IGeoDataServer

Parameters:

desiredRange - A reference to a com.esri.arcgis.geodatabase.IResultPortionInfo (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSQueryResultPortion

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportReplicaSchema

public IGDSData exportReplicaSchema(java.lang.String replicaName,
                                    int transportType)
                             throws java.io.IOException,
                                    AutomationException

Exports the schema of a replica to an Xml document.

Specified by:

exportReplicaSchema in interface IGeoDataServer

Parameters:

replicaName - The replicaName (in)

transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

compareReplicaSchema

public IGDSData compareReplicaSchema(IGDSData relativeReplicaSchemaDoc,
                                     int transportType)
                              throws java.io.IOException,
                                     AutomationException

Compares the schema of a replica with that of its relative, and returns a schema changes XML document.

Specified by:

compareReplicaSchema in interface IGeoDataServer

Parameters:

relativeReplicaSchemaDoc - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData (in)

transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

importReplicaSchemaChanges

public void importReplicaSchemaChanges(IGDSData schemaChangesDoc)
                                throws java.io.IOException,
                                       AutomationException

Updates the schema of the replica with the changes in an schema changes XML document.

Specified by:

importReplicaSchemaChanges in interface IGeoDataServer

Parameters:

schemaChangesDoc - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expandReplicaDatasets2

public IGPReplicaDatasets expandReplicaDatasets2(IGPReplicaDatasets gPReplicaDatasets,
                                                 IGPReplicaOptions replicaOptions)
                                          throws java.io.IOException,
                                                 AutomationException

Expands a set of replica datasets taking into consideration geodatabase constructs (topologies, relationship classes, etc.).

Specified by:

expandReplicaDatasets2 in interface IGeoDataServer2

Parameters:

gPReplicaDatasets - A reference to a com.esri.arcgis.geodatabase.IGPReplicaDatasets (in)

replicaOptions - A reference to a com.esri.arcgis.geodatabase.IGPReplicaOptions (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPReplicaDatasets

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplica

public IGPReplica getReplica(java.lang.String replicaName)
                      throws java.io.IOException,
                             AutomationException

Return the replica in the workspace that has a specific name.

Specified by:

getReplica in interface IGeoDataServer2

Parameters:

replicaName - The replicaName (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPReplica

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initFromMap

public void initFromMap(java.lang.String filePath)
                 throws java.io.IOException,
                        AutomationException

Initializes a GeoDataServer object with a map document.

Specified by:

initFromMap in interface IGeoDataServerInit

Parameters:

filePath - The filePath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initFromFile

public void initFromFile(java.lang.String file)
                  throws java.io.IOException,
                         AutomationException

Initializes a GeoDataServer object from a geodatabase or an sde connection file (*.sde).

Specified by:

initFromFile in interface IGeoDataServerInit

Parameters:

file - The file (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initFromConnectionString

public void initFromConnectionString(java.lang.String connectionString)
                              throws java.io.IOException,
                                     AutomationException

Initializes a GeoDataServer object from a connection string to a geodatabase.

Specified by:

initFromConnectionString in interface IGeoDataServerInit

Parameters:

connectionString - The connectionString (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initWithWorkspace

public void initWithWorkspace(IWorkspace pWorkspace)
                       throws java.io.IOException,
                              AutomationException

Initializes a GeoDataServer object with a workspace.

Specified by:

initWithWorkspace in interface IGeoDataServerInit

Parameters:

pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPhysicalOutputDirectory

public void setPhysicalOutputDirectory(java.lang.String dirPath)
                                throws java.io.IOException,
                                       AutomationException

The physical directory for output files.

Specified by:

setPhysicalOutputDirectory in interface IGeoDataServerInit

Parameters:

dirPath - The dirPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPhysicalOutputDirectory

public java.lang.String getPhysicalOutputDirectory()
                                            throws java.io.IOException,
                                                   AutomationException

The physical directory for output files.

Specified by:

getPhysicalOutputDirectory in interface IGeoDataServerInit

Returns:

The dirPath

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVirtualOutputDirectory

public void setVirtualOutputDirectory(java.lang.String dirPath)
                               throws java.io.IOException,
                                      AutomationException

The virtual directory for output files.

Specified by:

setVirtualOutputDirectory in interface IGeoDataServerInit

Parameters:

dirPath - The dirPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVirtualOutputDirectory

public java.lang.String getVirtualOutputDirectory()
                                           throws java.io.IOException,
                                                  AutomationException

The virtual directory for output files.

Specified by:

getVirtualOutputDirectory in interface IGeoDataServerInit

Returns:

The dirPath

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRecordCount

public void setMaxRecordCount(int count)
                       throws java.io.IOException,
                              AutomationException

The maximum number of records returned for query results.

Specified by:

setMaxRecordCount in interface IGeoDataServerInit

Parameters:

count - The count (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

construct

public void construct(IPropertySet props)
               throws java.io.IOException,
                      AutomationException

Two phase object construction.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

construct in interface IObjectConstruct

Parameters:

props - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

handleBinaryRequest

public byte[] handleBinaryRequest(byte[] request)
                           throws java.io.IOException,
                                  AutomationException

Handles a binary request.

Specified by:

handleBinaryRequest in interface IRequestHandler

Parameters:

request - An unsigned byte (in)

Returns:

An unsigned byte

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

handleStringRequest

public java.lang.String handleStringRequest(java.lang.String capabilities,
                                            java.lang.String request)
                                     throws java.io.IOException,
                                            AutomationException

Handles a SOAP string request.

Specified by:

handleStringRequest in interface IRequestHandler

Parameters:

capabilities - The capabilities (in)

request - The request (in)

Returns:

The response

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

handleBinaryRequest2

public byte[] handleBinaryRequest2(java.lang.String capabilities,
                                   byte[] request)
                            throws java.io.IOException,
                                   AutomationException

Handles a binary request with explicit capabilities.

Specified by:

handleBinaryRequest2 in interface IRequestHandler2

Parameters:

capabilities - The capabilities (in)

request - An unsigned byte (in)

Returns:

An unsigned byte

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultWorkingWorkspace

public IWorkspace getDefaultWorkingWorkspace()
                                      throws java.io.IOException,
                                             AutomationException

The default working workspace for the geodata server.

Specified by:

getDefaultWorkingWorkspace in interface IGeoDataServerObjects

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

public void activate()
              throws java.io.IOException,
                     AutomationException

Activates the object.

Specified by:

activate in interface IObjectActivate

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws java.io.IOException,
                       AutomationException

Deactivates the object.

Specified by:

deactivate in interface IObjectActivate

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initLogging

public void initLogging(ILog log)
                 throws java.io.IOException,
                        AutomationException

Initializes an object with a log.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

initLogging in interface ILogSupport

Parameters:

log - A reference to a com.esri.arcgis.system.ILog (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfigurationName

public java.lang.String getConfigurationName()
                                      throws java.io.IOException,
                                             AutomationException

Name of the server object configuration that defines the server object.

Specified by:

getConfigurationName in interface IServerObject

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTypeName

public java.lang.String getTypeName()
                             throws java.io.IOException,
                                    AutomationException

Type of the server object (MapServer or GeocodeServer).

Specified by:

getTypeName in interface IServerObject

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findExtensionByCLSID

public IServerObjectExtension findExtensionByCLSID(java.lang.String cLSID)
                                            throws java.io.IOException,
                                                   AutomationException

Returns a server object extension found using a string representation of its class ID.

Specified by:

findExtensionByCLSID in interface IServerObjectExtensionManager

Parameters:

cLSID - The cLSID (in)

Returns:

A reference to a com.esri.arcgis.server.IServerObjectExtension

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findExtensionByTypeName

public IServerObjectExtension findExtensionByTypeName(java.lang.String name)
                                               throws java.io.IOException,
                                                      AutomationException

Returns a server object extension found using its type name.

Specified by:

findExtensionByTypeName in interface IServerObjectExtensionManager

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.server.IServerObjectExtension

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

handleRESTRequest

public byte[] handleRESTRequest(java.lang.String capabilities,
                                java.lang.String resourceName,
                                java.lang.String operationName,
                                java.lang.String operationInput,
                                java.lang.String outputFormat,
                                java.lang.String requestProperties,
                                java.lang.String[] responseProperties)
                         throws java.io.IOException,
                                AutomationException

Handles REST requests for SOE.

This method is invoked by ArcGIS Server's REST handler, which intercepts client's request (in URL form), parses it and passes it on to this method in form of parameter values.

The REST SOE developer must add logic to use these parameter values to determine which resource/operation is being requested and accordingly handle these requests and generate responses in the output format indicated by the "outputFormat" parameter. For more information on developing REST SOEs, please consult the Java ArcObjects Developer Guide.

Developer doc: Developing extensions > Server Object Extensions > SOE Web Services > REST Web Services > Developing SOE REST Web Services
Samples: Samples > Server Object Extensions section

Specified by:

handleRESTRequest in interface IRESTRequestHandler

Parameters:

capabilities - The capabilities supported by the SOE. An admin can choose which capabilities are enabled on a particular SOE (in ArcGIS Manager or ArcCatalog), based on certain criteria such as security roles. This list of allowed capabilities is then sent to this method, at runtime, as a comma separated list. (in)

resourceName - Name of the resource being addressed. If empty, its assumed that root resource is being addressed. (in)

operationName - Name of the operation being invoked. If empty, description of resource is returned. (in)

operationInput - Input parameters, in form of comma separated list, to the operation specified by operationName parameter. (in)

outputFormat - OutputFormat of operation. Possible formats are JSON, HTML, AMF, etc. (in)

requestProperties - The requestProperties (in)

responseProperties - The responseProperties (out)

Returns:

Output generated by the SOE

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchema

public java.lang.String getSchema()
                           throws java.io.IOException,
                                  AutomationException

This method returns the resource hierarchy of a REST based SOE. This hierarchy is in JSON format as shown in the example below:

For an SOE that has a root resource (called "root") with one operation ("operation0"), and 2 sub-resources with one operation each ("operation1" and "operation2" respectively), the schema would look like:

 {
   "name": "MyRESTSOE",
   "description": "My REST SOE with 3 resources and 1 operation each.",
   "isCollection": false,
   "operations": [
   {
      "name": "operation0",
      "parameters": ["param01"],
      "supportedOutputFormats": ["json"]
    }
 ],
 "resources": [
  {
      "name": "subresource1",
      "description": "Sub Resource 1",
      "isCollection": true,
      "operations": [
       {
          "name": "operation1",
          "parameters": ["param10", "param11"],
          "supportedOutputFormats": ["json"]
       }
    ]
  },
  {
      "name": "subresource2",
      "description": "Sub Resource 2",
      "isCollection": true,
      "operations": [
       {
          "name": "operation2",
          "parameters": ["param20", "param21"],
          "supportedOutputFormats": ["json"]
       }
    ]
  }
 ]
}

Specified by:

getSchema in interface IRESTRequestHandler

Returns:

resource hierarchy of REST SOE, as String

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.