com.esri.arcgis.globecore
Class GlobeServer

java.lang.Object
  com.esri.arcgis.globecore.GlobeServer

All Implemented Interfaces:

IGlobeServer, IGlobeServer2, IGlobeServer3, IGlobeServer4, IGlobeServerObjects, IGlobeServerSetup, com.esri.arcgis.interop.RemoteObjRef, IServerObject, IServerObjectExtensionManager, ILogSupport, IObjectActivate, IObjectConstruct, IRequestHandler, IRequestHandler2, IRESTRequestHandler, java.io.Serializable

public class GlobeServer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IObjectConstruct, IRequestHandler, IRequestHandler2, ILogSupport, IObjectActivate, IGlobeServer, IGlobeServer2, IGlobeServer3, IGlobeServer4, IGlobeServerObjects, IGlobeServerSetup, IServerObject, IServerObjectExtensionManager, IRESTRequestHandler

COM Class 'GlobeServer'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGlobeCore.olb'

Description 'A Globe Server class that serves Globe Tiles.' 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.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.system.IObjectActivate

IID, IIDe3b78022_143e_4e61_9099_ed319ec061e7, xxDummy

Fields inherited from interface com.esri.arcgis.globecore.IGlobeServer4

IID, IID0e2de26a_4352_4176_a718_e19816cd86c5, xxDummy

Fields inherited from interface com.esri.arcgis.globecore.IGlobeServer3

IIDa0534365_9cce_4e17_b70c_0d576cafd05f

Fields inherited from interface com.esri.arcgis.globecore.IGlobeServer2

IID2e39bd80_46e9_4291_b658_2abbdafc9ffa

Fields inherited from interface com.esri.arcgis.globecore.IGlobeServer

IIDf44327ec_f03e_4f7a_8094_a5eaa0c15666

Fields inherited from interface com.esri.arcgis.globecore.IGlobeServerObjects

IID, IIDae6300ea_4043_492a_b72c_a61d6656d3d8, xxDummy

Fields inherited from interface com.esri.arcgis.globecore.IGlobeServerSetup

IID, IIDaaaed790_cd9d_4007_b4b2_c97fa9e39809, 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

GlobeServer()
Constructs a GlobeServer using ArcGIS Engine.

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

Method Summary

void	activate() Activates the object.
void	construct(IPropertySet props) Two phase object construction.
void	deactivate() Deactivates the object.
boolean	equals(java.lang.Object o) Compare this object with another
IGlobeServerFindResults	find(int layerID, java.lang.String searchString, boolean contains, java.lang.String searchFields) Returns a Globe Server Find Result object that contain the given search string.
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.
byte[]	getAnimation() Gets the animation stream.
ICacheControlInfo	getCacheControlInfo() Returns cache related properties of the a GlobeServer.
java.lang.String	getCacheName(int layerID) Gets the virtual cache directory for a given layer.
static java.lang.String	getClsid() getClsid.
byte[]	getConfig(int layerID) Gets the configuration file from a given layer.
byte[]	getConfiguration(int layerID) Gets all the configuration and MQT files from a given layer.
java.lang.String	getConfigurationName() Name of the server object configuration that defines the server object.
IGlobeDisplay	getDisplay() The display used by the Globe Server.
IPropertySet	getDocumentInfo() A set of name-value pairs for properties set for the globe document such as Title, Subject, Author, Category, Keywords and Comments.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILayer	getLayer(int layerID) The layer used by the Globe Server.
int	getLayerCount(int parentID) The number of layers in the server under a certain parent.
IGlobeLayerInfos	getLayerInfos(int parentID) A collection of Globe Layer Info objects.
IGlobeLegendInfos	getLegendInfos(ILongArray layerIDs) Returns a collection of Globe Legend Info objects for the specified layers.
byte[]	getMQT(int layerID, int face) Gets the MQT for a given face from a given layer.
java.lang.String	getPhysicalCacheDirectory() The physical directory for Globe cache.
java.lang.String	getPhysicalOutputDirectory() The physical directory for output files.
java.lang.String	getSchema() This method returns the resource hierarchy of a REST based SOE.
java.lang.String	getSOMPhysicalCacheDirectory() The SOM physical directory for Globe cache.
java.lang.String	getSOMVirtualCacheDirectory() The SOM virtual directory for Globe cache.
byte[]	getSymbols(int layerID, ILongArray pSymbolIDs) Gets the symbols with given IDs.
byte[]	getTextures(int layerID, ILongArray pTextureIDs) Gets the textures with given IDs.
byte[]	getTexturesEx(int layerID, ILongArray pTextureIDs, boolean getDDT) Gets the textures with given IDs.
byte[]	getTile(int layerID, int face, int level, int row, int column) Gets a tile for a given tile location from a given layer.
java.lang.String	getTypeName() Type of the server object (MapServer or GeocodeServer).
float	getVersion() The Globe Server version number.
java.lang.String	getVirtualCacheDirectory() The virtual directory for Globe cache.
java.lang.String	getVirtualCacheDirectory(int layerID) Gets the virtual cache directory for a given layer.
java.lang.String	getVirtualOutputDirectory() The virtual directory for output files.
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
IGlobeServerIdentifyResults	identify(int layerID, int oid, IGeometry searchShape) Returns a Globe Server Identify Result object at the given location.
void	init(java.lang.String docFile) Initializes the server from a globe document path.
void	initFromLayer(java.lang.String layerFile) Initializes the server from from a layer file.
void	initLogging(ILog log) Initializes an object with a log.
void	release() Release a GlobeServer.
void	setPhysicalCacheDirectory(java.lang.String pPath) The physical directory for Globe cache.
void	setPhysicalOutputDirectory(java.lang.String pPath) The physical directory for output files.
void	setSOMPhysicalCacheDirectory(java.lang.String pPath) The SOM physical directory for Globe cache.
void	setVirtualCacheDirectory(java.lang.String pPath) The virtual directory for Globe cache.
void	setVirtualOutputDirectory(java.lang.String pPath) The virtual directory for output files.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobeServer

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

Constructs a GlobeServer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GlobeServer

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

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

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

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 GlobeServer.

Specified by:

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

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.

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.

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.

getVersion

public float getVersion()
                 throws java.io.IOException,
                        AutomationException

The Globe Server version number.

Specified by:

getVersion in interface IGlobeServer

Returns:

The pVersion

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerCount

public int getLayerCount(int parentID)
                  throws java.io.IOException,
                         AutomationException

The number of layers in the server under a certain parent.

Specified by:

getLayerCount in interface IGlobeServer

Parameters:

parentID - The parentID (in)

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerInfos

public IGlobeLayerInfos getLayerInfos(int parentID)
                               throws java.io.IOException,
                                      AutomationException

A collection of Globe Layer Info objects.

Specified by:

getLayerInfos in interface IGlobeServer

Parameters:

parentID - The parentID (in)

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeLayerInfos

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendInfos

public IGlobeLegendInfos getLegendInfos(ILongArray layerIDs)
                                 throws java.io.IOException,
                                        AutomationException

Returns a collection of Globe Legend Info objects for the specified layers. If layerIDs is Nothing/Null or empty, legend information for all layers is returned.

Specified by:

getLegendInfos in interface IGlobeServer

Parameters:

layerIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeLegendInfos

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfig

public byte[] getConfig(int layerID)
                 throws java.io.IOException,
                        AutomationException

Gets the configuration file from a given layer.

Specified by:

getConfig in interface IGlobeServer

Parameters:

layerID - The layerID (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMQT

public byte[] getMQT(int layerID,
                     int face)
              throws java.io.IOException,
                     AutomationException

Gets the MQT for a given face from a given layer.

Specified by:

getMQT in interface IGlobeServer

Parameters:

layerID - The layerID (in)

face - The face (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfiguration

public byte[] getConfiguration(int layerID)
                        throws java.io.IOException,
                               AutomationException

Gets all the configuration and MQT files from a given layer.

Specified by:

getConfiguration in interface IGlobeServer

Parameters:

layerID - The layerID (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTile

public byte[] getTile(int layerID,
                      int face,
                      int level,
                      int row,
                      int column)
               throws java.io.IOException,
                      AutomationException

Gets a tile for a given tile location from a given layer.

Specified by:

getTile in interface IGlobeServer

Parameters:

layerID - The layerID (in)

face - The face (in)

level - The level (in)

row - The row (in)

column - The column (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbols

public byte[] getSymbols(int layerID,
                         ILongArray pSymbolIDs)
                  throws java.io.IOException,
                         AutomationException

Gets the symbols with given IDs.

Specified by:

getSymbols in interface IGlobeServer

Parameters:

layerID - The layerID (in)

pSymbolIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTextures

public byte[] getTextures(int layerID,
                          ILongArray pTextureIDs)
                   throws java.io.IOException,
                          AutomationException

Gets the textures with given IDs.

Specified by:

getTextures in interface IGlobeServer

Parameters:

layerID - The layerID (in)

pTextureIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnimation

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

Gets the animation stream.

Specified by:

getAnimation in interface IGlobeServer

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

identify

public IGlobeServerIdentifyResults identify(int layerID,
                                            int oid,
                                            IGeometry searchShape)
                                     throws java.io.IOException,
                                            AutomationException

Returns a Globe Server Identify Result object at the given location.

Specified by:

identify in interface IGlobeServer

Parameters:

layerID - The layerID (in)

oid - The oid (in)

searchShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeServerIdentifyResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

find

public IGlobeServerFindResults find(int layerID,
                                    java.lang.String searchString,
                                    boolean contains,
                                    java.lang.String searchFields)
                             throws java.io.IOException,
                                    AutomationException

Returns a Globe Server Find Result object that contain the given search string.

Specified by:

find in interface IGlobeServer

Parameters:

layerID - The layerID (in)

searchString - The searchString (in)

contains - The contains (in)

searchFields - The searchFields (in)

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeServerFindResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVirtualCacheDirectory

public java.lang.String getVirtualCacheDirectory(int layerID)
                                          throws java.io.IOException,
                                                 AutomationException

Gets the virtual cache directory for a given layer.

Specified by:

getVirtualCacheDirectory in interface IGlobeServer

Parameters:

layerID - The layerID (in)

Returns:

The pUrl

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCacheName

public java.lang.String getCacheName(int layerID)
                              throws java.io.IOException,
                                     AutomationException

Gets the virtual cache directory for a given layer.

Specified by:

getCacheName in interface IGlobeServer

Parameters:

layerID - The layerID (in)

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCacheControlInfo

public ICacheControlInfo getCacheControlInfo()
                                      throws java.io.IOException,
                                             AutomationException

Returns cache related properties of the a GlobeServer.

Specified by:

getCacheControlInfo in interface IGlobeServer2

Returns:

A reference to a com.esri.arcgis.carto.ICacheControlInfo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTexturesEx

public byte[] getTexturesEx(int layerID,
                            ILongArray pTextureIDs,
                            boolean getDDT)
                     throws java.io.IOException,
                            AutomationException

Gets the textures with given IDs.

Specified by:

getTexturesEx in interface IGlobeServer3

Parameters:

layerID - The layerID (in)

pTextureIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

getDDT - The getDDT (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocumentInfo

public IPropertySet getDocumentInfo()
                             throws java.io.IOException,
                                    AutomationException

A set of name-value pairs for properties set for the globe document such as Title, Subject, Author, Category, Keywords and Comments.

Specified by:

getDocumentInfo in interface IGlobeServer4

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int layerID)
                throws java.io.IOException,
                       AutomationException

The layer used by the Globe Server.

Specified by:

getLayer in interface IGlobeServerObjects

Parameters:

layerID - The layerID (in)

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplay

public IGlobeDisplay getDisplay()
                         throws java.io.IOException,
                                AutomationException

The display used by the Globe Server.

Specified by:

getDisplay in interface IGlobeServerObjects

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeDisplay

Throws:

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

AutomationException - If the ArcObject component throws an exception.

init

public void init(java.lang.String docFile)
          throws java.io.IOException,
                 AutomationException

Initializes the server from a globe document path. The path must be accessible to the server machine.

Specified by:

init in interface IGlobeServerSetup

Parameters:

docFile - The docFile (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initFromLayer

public void initFromLayer(java.lang.String layerFile)
                   throws java.io.IOException,
                          AutomationException

Initializes the server from from a layer file. The path must be accessible to the server machine.

Specified by:

initFromLayer in interface IGlobeServerSetup

Parameters:

layerFile - The layerFile (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 pPath)
                                throws java.io.IOException,
                                       AutomationException

The physical directory for output files.

Specified by:

setPhysicalOutputDirectory in interface IGlobeServerSetup

Parameters:

pPath - The pPath (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 IGlobeServerSetup

Returns:

The pPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVirtualOutputDirectory

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

The virtual directory for output files.

Specified by:

setVirtualOutputDirectory in interface IGlobeServerSetup

Parameters:

pPath - The pPath (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 IGlobeServerSetup

Returns:

The pPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPhysicalCacheDirectory

public void setPhysicalCacheDirectory(java.lang.String pPath)
                               throws java.io.IOException,
                                      AutomationException

The physical directory for Globe cache.

Specified by:

setPhysicalCacheDirectory in interface IGlobeServerSetup

Parameters:

pPath - The pPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPhysicalCacheDirectory

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

The physical directory for Globe cache.

Specified by:

getPhysicalCacheDirectory in interface IGlobeServerSetup

Returns:

The pPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSOMPhysicalCacheDirectory

public void setSOMPhysicalCacheDirectory(java.lang.String pPath)
                                  throws java.io.IOException,
                                         AutomationException

The SOM physical directory for Globe cache.

Specified by:

setSOMPhysicalCacheDirectory in interface IGlobeServerSetup

Parameters:

pPath - The pPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSOMPhysicalCacheDirectory

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

The SOM physical directory for Globe cache.

Specified by:

getSOMPhysicalCacheDirectory in interface IGlobeServerSetup

Returns:

The pPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVirtualCacheDirectory

public void setVirtualCacheDirectory(java.lang.String pPath)
                              throws java.io.IOException,
                                     AutomationException

The virtual directory for Globe cache.

Specified by:

setVirtualCacheDirectory in interface IGlobeServerSetup

Parameters:

pPath - The pPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVirtualCacheDirectory

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

The virtual directory for Globe cache.

Specified by:

getVirtualCacheDirectory in interface IGlobeServerSetup

Returns:

The pPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSOMVirtualCacheDirectory

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

The SOM virtual directory for Globe cache.

Specified by:

getSOMVirtualCacheDirectory in interface IGlobeServerSetup

Returns:

The pPath

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.