com.esri.arcgis.globecore
Class KmlServer

java.lang.Object
  extended by com.esri.arcgis.globecore.KmlServer
All Implemented Interfaces:
IKmlServer, com.esri.arcgis.interop.RemoteObjRef, IServerObjectExtension, ILogSupport, IObjectConstruct, Serializable

public class KmlServer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerObjectExtension, IObjectConstruct, ILogSupport, IKmlServer

The Kml Server Object Extension.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
KmlServer()
          Constructs a KmlServer using ArcGIS Engine.
KmlServer(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
KmlServer theKmlServer = (KmlServer) obj;
 
Method Summary
 void construct(IPropertySet props)
          Two phase object construction.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 byte[] getData(String capabilities, String request)
          Returns a KMZ file representation of a query to a MapServer object.
 IArray getIDList()
          Returns Layer hierarchy.
 int hashCode()
          the hashcode for this object
 void init(IServerObjectHelper pSOH)
          Initializes and starts the server object specified by the IServerObjectHelper reference.
 void initLogging(ILog log)
          Initializes an object with a log.
 void shutdown()
          Stops the server object specified by the IServerObjectHelper reference.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

KmlServer

public KmlServer()
          throws IOException,
                 UnknownHostException
Constructs a KmlServer using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

KmlServer

public KmlServer(Object obj)
          throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
KmlServer theKmlServer = (KmlServer) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

init

public void init(IServerObjectHelper pSOH)
          throws IOException,
                 AutomationException
Initializes and starts the server object specified by the IServerObjectHelper reference.

Product Availability

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

Specified by:
init in interface IServerObjectExtension
Parameters:
pSOH - A reference to a com.esri.arcgis.server.IServerObjectHelper (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws IOException,
                     AutomationException
Stops the server object specified by the IServerObjectHelper reference.

Product Availability

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

Specified by:
shutdown in interface IServerObjectExtension
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

construct

public void construct(IPropertySet props)
               throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initLogging

public void initLogging(ILog log)
                 throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getData

public byte[] getData(String capabilities,
                      String request)
               throws IOException,
                      AutomationException
Returns a KMZ file representation of a query to a MapServer object.

Product Availability

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

Specified by:
getData in interface IKmlServer
Parameters:
capabilities - The capabilities (in)
request - The request (in)
Returns:
An unsigned byte
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIDList

public IArray getIDList()
                 throws IOException,
                        AutomationException
Returns Layer hierarchy.

Product Availability

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

Specified by:
getIDList in interface IKmlServer
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.