com.esri.arcgis.trackinganalyst
Class InternetConnection

java.lang.Object
  com.esri.arcgis.trackinganalyst.InternetConnection

All Implemented Interfaces:

IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, IConnectionStatistics, IGatewayStatistics, IInternetServerConnection, IServerConnection, IServerConnection2, IServerConnectionAdmin, IServerConnectionAOI, ITrackingServiceComplexData, ITxConnectionMessages, ITxDiagnostics, java.io.Externalizable, java.io.Serializable

public class InternetConnection
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITxConnectionMessages, IInternetServerConnection, IServerConnection2, IServerConnection, ITrackingServiceComplexData, ITxDiagnostics, IConnectionStatistics, IServerConnectionAOI, IGatewayStatistics, IPersist, IPersistStream, IServerConnectionAdmin, IConnectionPointContainer, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'InternetConnection'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Manages an Internet server connection.' 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

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITxConnectionMessages

IID, IID07e7567e_20bd_4a55_a9ae_a9acf1dfa2fc, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.IInternetServerConnection

IID, IID987a7d76_54df_11d6_b841_00010265adc5, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.IServerConnection2

IID, IIDf6e2800d_d512_46c1_b92c_d66c1c432a0b, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.IServerConnection

IID, IIDcc018a11_24fb_11d4_b34c_00104ba2abcc, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITrackingServiceComplexData

IID, IIDd9ca9f84_ae4a_4f8c_9ab6_511acd33570b, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITxDiagnostics

IID, IID1d5f7be7_f236_4042_a0b7_3156dc7661bf, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.IConnectionStatistics

IID, IID9de7ca3b_37d0_48b4_9a64_95d2372903d0, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.IServerConnectionAOI

IID, IID2062ae72_0c79_4a4b_9486_cadf6124aac1, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.IGatewayStatistics

IID, IIDf9690b60_19ac_48fd_bffd_6cf0c9436d59, xxDummy

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

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

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

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.trackinganalyst.IServerConnectionAdmin

IID, IIDf49abb00_39ef_11d7_b86b_00010265adc5, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Constructor Summary

InternetConnection()
Constructs a InternetConnection using ArcGIS Engine.

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

Method Summary

void	add_IGatewayStatisticsEventListener(_IGatewayStatisticsEvent theListener) add_IGatewayStatisticsEventListener.
void	add_IPlugInEventsListener(_IPlugInEvents theListener) add_IPlugInEventsListener.
void	connect(java.lang.String bstrUserName, java.lang.String bstrPassword) Creates Internet server connection.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	disableDataDefinition(java.lang.String bstrDataDefinitionID) Disables dataset definition for the Internet server connection.
void	disconnect() Disconnects Internet server connection.
void	enableDataDefinition(java.lang.String bstrDataDefinitionID) Enables data definition for the Internet server connection.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
java.lang.String	getActivityLog() Indicates error code value for the last Internet server connection.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getConnectionName() Name of Internet server connection.
IPropSet	getConnectionProperties() Properties for the server connection.
java.lang.String	getConnectionString() Indicates connection string value.
java.lang.Object	getCurrentDiscardedMessageCount() Indicates current number of messages discarded.
IDatasetDef	getDataSetDefinition(java.lang.String bstrName) Gets value for dataset definition for Internet server connection.
java.lang.Object	getDataSetDefinitionList() Lists values in the dataset definition.
java.lang.Object	getDiscardedMessageCount() Indicates total number of messages discarded.
java.lang.Object	getEnabledDataDefinitions() Indicates whether data definitions are enabled for the Internet server connection.
int	getEventReadyHandle() The handle to the event that is signaled when a message is ready to be received.
IPropSet	getGatewayConnectionStatistics() Retrieves the connection portion of the gateway statistics.
IPropSet	getGatewayProcessStatistics() Retrieves the process portion of the gateway statistics.
IStringArray	getGatewayServiceNames() Retrieves a list of service names from the gateway statistics.
IPropSet	getGatewayServiceStatistics(java.lang.String serviceName) Retrieves the services portion of the gateway statistics.
int	getGatewayStatisticsRate() The time in milliseconds between requests made to get the latest gateway statistics.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLastConnectionErrorCode() Indicates error code value for the last Internet server connection.
java.lang.String	getLastConnectionErrorMessage() Indicates error code value for the last Internet server connection.
IMessage	getMessage(int nTimeOutInMilliseconds) Gets message via the Internet server connection.
int	getMessageCount() The count of messages ready to retrieve.
IPlugin	getPlugIn() Data link plugin information for the server connection.
int	getPortNumber() Port number used for the Internet server connection.
java.lang.Object	getPulledMessageCount() Indicates total number of messages pulled.
java.lang.Object	getQueuedMessageCount() Indicates total number of messages queued.
java.lang.Object	getReceivedMessageCount() Indicates total number of messages received.
java.lang.Object	getServerActions(boolean bForEditing) Actions used on data in the server connection.
java.lang.String	getServerName() Indicates server name in the Internet server connection.
void	getServiceAreaOfInterest(java.lang.String bstrServiceName, int[] aoiType, IEnvelope[] aoi) The service area of interest.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.String	getSubletPath() Value of the sublet path for the Internet server connection.
java.lang.String	getTopicName(java.lang.String bstrServiceName) Indicates name for the topic in the Internet server connection.
ITrackingServiceDef	getTrackingService(java.lang.String bstrName) Gets tracking service information for the Internet server connection.
java.lang.Object	getTrackingServicesList() Lists tracking services within the Internet server connection.
java.lang.String	getUserName() Indicates user's name using the Internet server connection.
int	hashCode() the hashcode for this object
boolean	isConnected() Indicates whether the Internet server connection is active.
void	isDirty() isDirty
boolean	isEnableDataFiltering() Indicates whether data filtering is enabled for the Internet server connection.
boolean	isHasObjectData(java.lang.String bstrTrackingService) Indicates whether a tracking service has complex data to request.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
IMessage	nextMessage() Retrieves a message from the server connection.
void	onConnect() Fires an OnConnect Event.
void	onDisconnect() Fires an OnDisconnect Event.
void	onError() Fires an OnError Event.
void	onMessage() Fires an OnMessage Event.
void	readExternal(java.io.ObjectInput in)
void	release() Release a InternetConnection.
void	remove_IGatewayStatisticsEventListener(_IGatewayStatisticsEvent theListener) remove_IGatewayStatisticsEventListener.
void	remove_IPlugInEventsListener(_IPlugInEvents theListener) remove_IPlugInEventsListener.
void	requestObjectData(java.lang.String bstrTrackingService) Requests the Object or static data associated with a Complex Tracking Service.
void	returnDataSetDefinition(IDatasetDef piDataSetDef) Returns value for dataset definition in Internet server connection.
void	returnServerActions(boolean bSave, java.lang.Object piActionCollection) Actions used on data in the server connection.
void	returnTrackingService(ITrackingServiceDef piTrackingServiceDef) Returns tracking service information for the Internet server connection.
void	save(IStream pstm, int fClearDirty) save
IResponseMessage	sendCommand(ICommandMessage piCmdMsg, int nTimeOut) Sends command information via the Internet server connection.
void	sendMessage(IMessage piMessage) Sends message via the Internet server connection.
void	setConnectionName(java.lang.String pbstrConnectionName) Name of Internet server connection.
void	setConnectionProperties(IPropSet ppiProperties) Properties for the server connection.
void	setConnectionString(java.lang.String pbstrConnectionString) Indicates connection string value.
void	setEnableDataFiltering(boolean pbvVal) Indicates whether data filtering is enabled for the Internet server connection.
void	setGatewayStatisticsRate(int requestRate) The time in milliseconds between requests made to get the latest gateway statistics.
void	setPortNumber(int plPortNumber) Port number used for the Internet server connection.
void	setServerName(java.lang.String pVal) Indicates server name in the Internet server connection.
void	setServiceAreaOfInterest(java.lang.String bstrServiceName, int aoiType, IEnvelope aoi) The service area of interest.
void	setSubletPath(java.lang.String pbstrSubletPath) Value of the sublet path for the Internet server connection.
void	setTopicName(java.lang.String bstrServiceName, java.lang.String pbstrTopicName) Indicates name for the topic in the Internet server connection.
void	startGatewayStatistics() Start making periodic requests for statistics from the gateway.
void	stopGatewayStatistics() Stop making periodic requests for statistics from the gateway.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

InternetConnection

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

Constructs a InternetConnection using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

InternetConnection

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

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

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

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

add_IPlugInEventsListener

public void add_IPlugInEventsListener(_IPlugInEvents theListener)
                               throws java.io.IOException

add_IPlugInEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst._IPlugInEvents interface.

Throws:

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

remove_IPlugInEventsListener

public void remove_IPlugInEventsListener(_IPlugInEvents theListener)
                                  throws java.io.IOException

remove_IPlugInEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst._IPlugInEvents interface.

Throws:

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

add_IGatewayStatisticsEventListener

public void add_IGatewayStatisticsEventListener(_IGatewayStatisticsEvent theListener)
                                         throws java.io.IOException

add_IGatewayStatisticsEventListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst._IGatewayStatisticsEvent interface.

Throws:

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

remove_IGatewayStatisticsEventListener

public void remove_IGatewayStatisticsEventListener(_IGatewayStatisticsEvent theListener)
                                            throws java.io.IOException

remove_IGatewayStatisticsEventListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.trackinganalyst._IGatewayStatisticsEvent interface.

Throws:

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

release

public void release()

Release a InternetConnection.

Specified by:

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

getMessageCount

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

The count of messages ready to retrieve.

Specified by:

getMessageCount in interface ITxConnectionMessages

Returns:

The plNumberOfMessages

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEventReadyHandle

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

The handle to the event that is signaled when a message is ready to be received.

Specified by:

getEventReadyHandle in interface ITxConnectionMessages

Returns:

The phReadyEvent (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

nextMessage

public IMessage nextMessage()
                     throws java.io.IOException,
                            AutomationException

Retrieves a message from the server connection.

Specified by:

nextMessage in interface ITxConnectionMessages

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isConnected

public boolean isConnected()
                    throws java.io.IOException,
                           AutomationException

Indicates whether the Internet server connection is active.

Specified by:

isConnected in interface IInternetServerConnection

Specified by:

isConnected in interface IServerConnection

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerName

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

Indicates server name in the Internet server connection.

Specified by:

getServerName in interface IInternetServerConnection

Specified by:

getServerName in interface IServerConnection

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setServerName

public void setServerName(java.lang.String pVal)
                   throws java.io.IOException,
                          AutomationException

Indicates server name in the Internet server connection.

Specified by:

setServerName in interface IInternetServerConnection

Specified by:

setServerName in interface IServerConnection

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUserName

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

Indicates user's name using the Internet server connection.

Specified by:

getUserName in interface IInternetServerConnection

Specified by:

getUserName in interface IServerConnection

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnableDataFiltering

public boolean isEnableDataFiltering()
                              throws java.io.IOException,
                                     AutomationException

Indicates whether data filtering is enabled for the Internet server connection.

Specified by:

isEnableDataFiltering in interface IInternetServerConnection

Specified by:

isEnableDataFiltering in interface IServerConnection

Returns:

The pbvVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnableDataFiltering

public void setEnableDataFiltering(boolean pbvVal)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether data filtering is enabled for the Internet server connection.

Specified by:

setEnableDataFiltering in interface IInternetServerConnection

Specified by:

setEnableDataFiltering in interface IServerConnection

Parameters:

pbvVal - The pbvVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSetDefinitionList

public java.lang.Object getDataSetDefinitionList()
                                          throws java.io.IOException,
                                                 AutomationException

Lists values in the dataset definition.

Specified by:

getDataSetDefinitionList in interface IInternetServerConnection

Specified by:

getDataSetDefinitionList in interface IServerConnection

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEnabledDataDefinitions

public java.lang.Object getEnabledDataDefinitions()
                                           throws java.io.IOException,
                                                  AutomationException

Indicates whether data definitions are enabled for the Internet server connection.

Specified by:

getEnabledDataDefinitions in interface IInternetServerConnection

Specified by:

getEnabledDataDefinitions in interface IServerConnection

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorCode

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

Indicates error code value for the last Internet server connection.

Specified by:

getLastConnectionErrorCode in interface IInternetServerConnection

Specified by:

getLastConnectionErrorCode in interface IServerConnection

Specified by:

getLastConnectionErrorCode in interface ITxDiagnostics

Returns:

The pnErrorCode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorMessage

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

Indicates error code value for the last Internet server connection.

Specified by:

getLastConnectionErrorMessage in interface IInternetServerConnection

Specified by:

getLastConnectionErrorMessage in interface IServerConnection

Specified by:

getLastConnectionErrorMessage in interface ITxDiagnostics

Returns:

The pbstrErrorMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionName

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

Name of Internet server connection.

Specified by:

getConnectionName in interface IInternetServerConnection

Specified by:

getConnectionName in interface IServerConnection

Returns:

The pbstrConnectionName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setConnectionName

public void setConnectionName(java.lang.String pbstrConnectionName)
                       throws java.io.IOException,
                              AutomationException

Name of Internet server connection.

Specified by:

setConnectionName in interface IInternetServerConnection

Specified by:

setConnectionName in interface IServerConnection

Parameters:

pbstrConnectionName - The pbstrConnectionName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionString

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

Indicates connection string value.

Specified by:

getConnectionString in interface IInternetServerConnection

Specified by:

getConnectionString in interface IServerConnection

Returns:

The pbstrConnectionString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setConnectionString

public void setConnectionString(java.lang.String pbstrConnectionString)
                         throws java.io.IOException,
                                AutomationException

Indicates connection string value.

Specified by:

setConnectionString in interface IInternetServerConnection

Specified by:

setConnectionString in interface IServerConnection

Parameters:

pbstrConnectionString - The pbstrConnectionString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

connect

public void connect(java.lang.String bstrUserName,
                    java.lang.String bstrPassword)
             throws java.io.IOException,
                    AutomationException

Creates Internet server connection.

Specified by:

connect in interface IInternetServerConnection

Specified by:

connect in interface IServerConnection

Parameters:

bstrUserName - The bstrUserName (in)

bstrPassword - The bstrPassword (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disconnect

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

Disconnects Internet server connection.

Specified by:

disconnect in interface IInternetServerConnection

Specified by:

disconnect in interface IServerConnection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

sendMessage

public void sendMessage(IMessage piMessage)
                 throws java.io.IOException,
                        AutomationException

Sends message via the Internet server connection.

Specified by:

sendMessage in interface IInternetServerConnection

Specified by:

sendMessage in interface IServerConnection

Parameters:

piMessage - A reference to a com.esri.arcgis.trackinganalyst.IMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessage

public IMessage getMessage(int nTimeOutInMilliseconds)
                    throws java.io.IOException,
                           AutomationException

Gets message via the Internet server connection.

Specified by:

getMessage in interface IInternetServerConnection

Specified by:

getMessage in interface IServerConnection

Parameters:

nTimeOutInMilliseconds - The nTimeOutInMilliseconds (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enableDataDefinition

public void enableDataDefinition(java.lang.String bstrDataDefinitionID)
                          throws java.io.IOException,
                                 AutomationException

Enables data definition for the Internet server connection.

Specified by:

enableDataDefinition in interface IInternetServerConnection

Specified by:

enableDataDefinition in interface IServerConnection

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disableDataDefinition

public void disableDataDefinition(java.lang.String bstrDataDefinitionID)
                           throws java.io.IOException,
                                  AutomationException

Disables dataset definition for the Internet server connection.

Specified by:

disableDataDefinition in interface IInternetServerConnection

Specified by:

disableDataDefinition in interface IServerConnection

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

returnDataSetDefinition

public void returnDataSetDefinition(IDatasetDef piDataSetDef)
                             throws java.io.IOException,
                                    AutomationException

Returns value for dataset definition in Internet server connection.

Specified by:

returnDataSetDefinition in interface IInternetServerConnection

Specified by:

returnDataSetDefinition in interface IServerConnection

Parameters:

piDataSetDef - A reference to a com.esri.arcgis.trackinganalyst.IDatasetDef (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSetDefinition

public IDatasetDef getDataSetDefinition(java.lang.String bstrName)
                                 throws java.io.IOException,
                                        AutomationException

Gets value for dataset definition for Internet server connection.

Specified by:

getDataSetDefinition in interface IInternetServerConnection

Specified by:

getDataSetDefinition in interface IServerConnection

Parameters:

bstrName - The bstrName (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IDatasetDef

Throws:

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

AutomationException - If the ArcObject component throws an exception.

sendCommand

public IResponseMessage sendCommand(ICommandMessage piCmdMsg,
                                    int nTimeOut)
                             throws java.io.IOException,
                                    AutomationException

Sends command information via the Internet server connection.

Specified by:

sendCommand in interface IInternetServerConnection

Specified by:

sendCommand in interface IServerConnection

Parameters:

piCmdMsg - A reference to a com.esri.arcgis.trackinganalyst.ICommandMessage (in)

nTimeOut - The nTimeOut (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IResponseMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackingServicesList

public java.lang.Object getTrackingServicesList()
                                         throws java.io.IOException,
                                                AutomationException

Lists tracking services within the Internet server connection.

Specified by:

getTrackingServicesList in interface IInternetServerConnection

Specified by:

getTrackingServicesList in interface IServerConnection2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackingService

public ITrackingServiceDef getTrackingService(java.lang.String bstrName)
                                       throws java.io.IOException,
                                              AutomationException

Gets tracking service information for the Internet server connection.

Specified by:

getTrackingService in interface IInternetServerConnection

Specified by:

getTrackingService in interface IServerConnection2

Parameters:

bstrName - The bstrName (in)

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ITrackingServiceDef

Throws:

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

AutomationException - If the ArcObject component throws an exception.

returnTrackingService

public void returnTrackingService(ITrackingServiceDef piTrackingServiceDef)
                           throws java.io.IOException,
                                  AutomationException

Returns tracking service information for the Internet server connection.

Specified by:

returnTrackingService in interface IInternetServerConnection

Specified by:

returnTrackingService in interface IServerConnection2

Parameters:

piTrackingServiceDef - A reference to a com.esri.arcgis.geodatabaseextensions.ITrackingServiceDef (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubletPath

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

Value of the sublet path for the Internet server connection.

Specified by:

getSubletPath in interface IInternetServerConnection

Returns:

The pbstrSubletPath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubletPath

public void setSubletPath(java.lang.String pbstrSubletPath)
                   throws java.io.IOException,
                          AutomationException

Value of the sublet path for the Internet server connection.

Specified by:

setSubletPath in interface IInternetServerConnection

Parameters:

pbstrSubletPath - The pbstrSubletPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTopicName

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

Indicates name for the topic in the Internet server connection.

Specified by:

getTopicName in interface IInternetServerConnection

Parameters:

bstrServiceName - The bstrServiceName (in)

Returns:

The pbstrTopicName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTopicName

public void setTopicName(java.lang.String bstrServiceName,
                         java.lang.String pbstrTopicName)
                  throws java.io.IOException,
                         AutomationException

Indicates name for the topic in the Internet server connection.

Specified by:

setTopicName in interface IInternetServerConnection

Parameters:

bstrServiceName - The bstrServiceName (in)

pbstrTopicName - The pbstrTopicName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPortNumber

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

Port number used for the Internet server connection.

Specified by:

getPortNumber in interface IInternetServerConnection

Returns:

The plPortNumber

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPortNumber

public void setPortNumber(int plPortNumber)
                   throws java.io.IOException,
                          AutomationException

Port number used for the Internet server connection.

Specified by:

setPortNumber in interface IInternetServerConnection

Parameters:

plPortNumber - The plPortNumber (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

public IPropSet getConnectionProperties()
                                 throws java.io.IOException,
                                        AutomationException

Properties for the server connection.

Specified by:

getConnectionProperties in interface IServerConnection2

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IPropSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setConnectionProperties

public void setConnectionProperties(IPropSet ppiProperties)
                             throws java.io.IOException,
                                    AutomationException

Properties for the server connection.

Specified by:

setConnectionProperties in interface IServerConnection2

Parameters:

ppiProperties - A reference to a com.esri.arcgis.trackinganalyst.IPropSet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPlugIn

public IPlugin getPlugIn()
                  throws java.io.IOException,
                         AutomationException

Data link plugin information for the server connection.

Specified by:

getPlugIn in interface IServerConnection2

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IPlugin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerActions

public java.lang.Object getServerActions(boolean bForEditing)
                                  throws java.io.IOException,
                                         AutomationException

Actions used on data in the server connection.

Specified by:

getServerActions in interface IServerConnection2

Parameters:

bForEditing - The bForEditing (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

returnServerActions

public void returnServerActions(boolean bSave,
                                java.lang.Object piActionCollection)
                         throws java.io.IOException,
                                AutomationException

Actions used on data in the server connection.

Specified by:

returnServerActions in interface IServerConnection2

Parameters:

bSave - The bSave (in)

piActionCollection - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasObjectData

public boolean isHasObjectData(java.lang.String bstrTrackingService)
                        throws java.io.IOException,
                               AutomationException

Indicates whether a tracking service has complex data to request.

Specified by:

isHasObjectData in interface ITrackingServiceComplexData

Parameters:

bstrTrackingService - The bstrTrackingService (in)

Returns:

The pbvarHasObjectData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

requestObjectData

public void requestObjectData(java.lang.String bstrTrackingService)
                       throws java.io.IOException,
                              AutomationException

Requests the Object or static data associated with a Complex Tracking Service.

Specified by:

requestObjectData in interface ITrackingServiceComplexData

Parameters:

bstrTrackingService - The bstrTrackingService (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActivityLog

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

Indicates error code value for the last Internet server connection.

Specified by:

getActivityLog in interface ITxDiagnostics

Returns:

The pbstrLog

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReceivedMessageCount

public java.lang.Object getReceivedMessageCount()
                                         throws java.io.IOException,
                                                AutomationException

Indicates total number of messages received.

Specified by:

getReceivedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPulledMessageCount

public java.lang.Object getPulledMessageCount()
                                       throws java.io.IOException,
                                              AutomationException

Indicates total number of messages pulled.

Specified by:

getPulledMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDiscardedMessageCount

public java.lang.Object getDiscardedMessageCount()
                                          throws java.io.IOException,
                                                 AutomationException

Indicates total number of messages discarded.

Specified by:

getDiscardedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentDiscardedMessageCount

public java.lang.Object getCurrentDiscardedMessageCount()
                                                 throws java.io.IOException,
                                                        AutomationException

Indicates current number of messages discarded.

Specified by:

getCurrentDiscardedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getQueuedMessageCount

public java.lang.Object getQueuedMessageCount()
                                       throws java.io.IOException,
                                              AutomationException

Indicates total number of messages queued.

Specified by:

getQueuedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setServiceAreaOfInterest

public void setServiceAreaOfInterest(java.lang.String bstrServiceName,
                                     int aoiType,
                                     IEnvelope aoi)
                              throws java.io.IOException,
                                     AutomationException

The service area of interest.

Specified by:

setServiceAreaOfInterest in interface IServerConnectionAOI

Parameters:

bstrServiceName - The bstrServiceName (in)

aoiType - A com.esri.arcgis.trackinganalyst.esriTxServiceAOI constant (in)

aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServiceAreaOfInterest

public void getServiceAreaOfInterest(java.lang.String bstrServiceName,
                                     int[] aoiType,
                                     IEnvelope[] aoi)
                              throws java.io.IOException,
                                     AutomationException

The service area of interest.

Specified by:

getServiceAreaOfInterest in interface IServerConnectionAOI

Parameters:

bstrServiceName - The bstrServiceName (in)

aoiType - A com.esri.arcgis.trackinganalyst.esriTxServiceAOI constant (out: use single element array)

aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startGatewayStatistics

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

Start making periodic requests for statistics from the gateway.

Specified by:

startGatewayStatistics in interface IGatewayStatistics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopGatewayStatistics

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

Stop making periodic requests for statistics from the gateway.

Specified by:

stopGatewayStatistics in interface IGatewayStatistics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGatewayStatisticsRate

public void setGatewayStatisticsRate(int requestRate)
                              throws java.io.IOException,
                                     AutomationException

The time in milliseconds between requests made to get the latest gateway statistics.

Specified by:

setGatewayStatisticsRate in interface IGatewayStatistics

Parameters:

requestRate - The requestRate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGatewayStatisticsRate

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

The time in milliseconds between requests made to get the latest gateway statistics.

Specified by:

getGatewayStatisticsRate in interface IGatewayStatistics

Returns:

The requestRate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGatewayConnectionStatistics

public IPropSet getGatewayConnectionStatistics()
                                        throws java.io.IOException,
                                               AutomationException

Retrieves the connection portion of the gateway statistics.

Specified by:

getGatewayConnectionStatistics in interface IGatewayStatistics

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IPropSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGatewayProcessStatistics

public IPropSet getGatewayProcessStatistics()
                                     throws java.io.IOException,
                                            AutomationException

Retrieves the process portion of the gateway statistics.

Specified by:

getGatewayProcessStatistics in interface IGatewayStatistics

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IPropSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGatewayServiceNames

public IStringArray getGatewayServiceNames()
                                    throws java.io.IOException,
                                           AutomationException

Retrieves a list of service names from the gateway statistics.

Specified by:

getGatewayServiceNames in interface IGatewayStatistics

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGatewayServiceStatistics

public IPropSet getGatewayServiceStatistics(java.lang.String serviceName)
                                     throws java.io.IOException,
                                            AutomationException

Retrieves the services portion of the gateway statistics.

Specified by:

getGatewayServiceStatistics in interface IGatewayStatistics

Parameters:

serviceName - The serviceName (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IPropSet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onDisconnect

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

Fires an OnDisconnect Event.

Specified by:

onDisconnect in interface IServerConnectionAdmin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onConnect

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

Fires an OnConnect Event.

Specified by:

onConnect in interface IServerConnectionAdmin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onMessage

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

Fires an OnMessage Event.

Specified by:

onMessage in interface IServerConnectionAdmin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onError

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

Fires an OnError Event.

Specified by:

onError in interface IServerConnectionAdmin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

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

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException