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, IInternetServerConnection, IServerConnection, IServerConnection2, IServerConnectionAdmin, ITrackingServiceComplexData, ITxConnectionMessages, ITxDiagnostics, Externalizable, Serializable

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

Manages an Internet server connection.

Description

The Internet connector is the primary connection object between a Client, usually the AMSWorkspace component of the Tracking Analyst extension to ArcGIS, and the Tracking Server. This object maintains the information needed to communicate with the Tracking Server using the Tracking Message Server Gateway. This connector uses a proprietary gateway service, part of the Tracking Server product, to exchange messages with the Tracking Server.

Remarks

The internet Connector uses the connection properties to manage all user modifiable features of the connector. Below summarizes the properties, their defaults and descriptions. The Internet Connector will default any property that is not present when setting the connection properties.

Property Name	Required	Default Value	Description
SERVERNAME	O	localhost	Name of Server or IP
AMS_CONNECTION_NAME	O	Tracking Connector	The Name or label of the connection.
CONNECTOR_PORT	O	5506	The Client port of the tracking server
TMS_CMD_TIMEOUT	O	60	Command Response Timeout in seconds
TMS_CONNECT_RETRY	O	60	The time in seconds that the connector waits before it automatically retries a dropped connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:

Serialized Form

Constructor Summary

InternetConnection()
Constructs a InternetConnection using ArcGIS Engine.

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

Method Summary

void	add_IPlugInEventsListener(_IPlugInEvents theListener) add_IPlugInEventsListener.
void	connect(String bstrUserName, String bstrPassword) Creates Internet server connection.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	disableDataDefinition(String bstrDataDefinitionID) Disables dataset definition for the Internet server connection.
void	disconnect() Disconnects Internet server connection.
void	enableDataDefinition(String bstrDataDefinitionID) Enables data definition for the Internet server connection.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
String	getActivityLog() Indicates error code value for the last Internet server connection.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getConnectionName() Name of Internet server connection.
IPropSet	getConnectionProperties() Properties for the server connection.
String	getConnectionString() Indicates connection string value.
Object	getCurrentDiscardedMessageCount() Indicates current number of messages discarded.
IDatasetDef	getDataSetDefinition(String bstrName) Gets value for dataset definition for Internet server connection.
Object	getDataSetDefinitionList() Lists values in the dataset definition.
Object	getDiscardedMessageCount() Indicates total number of messages discarded.
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.
int	getLastConnectionErrorCode() Indicates error code value for the last Internet server connection.
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.
Object	getPulledMessageCount() Indicates total number of messages pulled.
Object	getQueuedMessageCount() Indicates total number of messages queued.
Object	getReceivedMessageCount() Indicates total number of messages received.
Object	getServerActions(boolean bForEditing) Actions used on data in the server connection.
String	getServerName() Indicates server name in the Internet server connection.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getSubletPath() Value of the sublet path for the Internet server connection.
String	getTopicName(String bstrServiceName) Indicates name for the topic in the Internet server connection.
ITrackingServiceDef	getTrackingService(String bstrName) Gets tracking service information for the Internet server connection.
Object	getTrackingServicesList() Lists tracking services within the Internet server connection.
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(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(ObjectInput in)
void	remove_IPlugInEventsListener(_IPlugInEvents theListener) remove_IPlugInEventsListener.
void	requestObjectData(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, 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(String pbstrConnectionName) Name of Internet server connection.
void	setConnectionProperties(IPropSet ppiProperties) Properties for the server connection.
void	setConnectionString(String pbstrConnectionString) Indicates connection string value.
void	setEnableDataFiltering(boolean pbvVal) Indicates whether data filtering is enabled for the Internet server connection.
void	setPortNumber(int plPortNumber) Port number used for the Internet server connection.
void	setServerName(String pVal) Indicates server name in the Internet server connection.
void	setSubletPath(String pbstrSubletPath) Value of the sublet path for the Internet server connection.
void	setTopicName(String bstrServiceName, String pbstrTopicName) Indicates name for the topic in the Internet server connection.
void	writeExternal(ObjectOutput out)

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

InternetConnection

public InternetConnection()
                   throws IOException,
                          UnknownHostException

Constructs a InternetConnection using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

InternetConnection

public InternetConnection(Object obj)
                   throws 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:

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

add_IPlugInEventsListener

public void add_IPlugInEventsListener(_IPlugInEvents theListener)
                               throws IOException

add_IPlugInEventsListener. Listen to events generated by this class.

Parameters:

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

Throws:

IOException - If there are communications problems.

remove_IPlugInEventsListener

public void remove_IPlugInEventsListener(_IPlugInEvents theListener)
                                  throws 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:

IOException - If there are communications problems.

getMessageCount

public int getMessageCount()
                    throws IOException,
                           AutomationException

The count of messages ready to retrieve.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getMessageCount in interface ITxConnectionMessages

Returns:

The plNumberOfMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEventReadyHandle

public int getEventReadyHandle()
                        throws IOException,
                               AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getEventReadyHandle in interface ITxConnectionMessages

Returns:

The phReadyEvent (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextMessage

public IMessage nextMessage()
                     throws IOException,
                            AutomationException

Retrieves a message from the server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

nextMessage in interface ITxConnectionMessages

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isConnected

public boolean isConnected()
                    throws IOException,
                           AutomationException

Indicates whether the Internet server connection is active.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

isConnected in interface IInternetServerConnection

Specified by:

isConnected in interface IServerConnection

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerName

public String getServerName()
                     throws IOException,
                            AutomationException

Indicates server name in the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getServerName in interface IInternetServerConnection

Specified by:

getServerName in interface IServerConnection

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerName

public void setServerName(String pVal)
                   throws IOException,
                          AutomationException

Indicates server name in the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setServerName in interface IInternetServerConnection

Specified by:

setServerName in interface IServerConnection

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserName

public String getUserName()
                   throws IOException,
                          AutomationException

Indicates user's name using the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getUserName in interface IInternetServerConnection

Specified by:

getUserName in interface IServerConnection

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableDataFiltering

public boolean isEnableDataFiltering()
                              throws IOException,
                                     AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

isEnableDataFiltering in interface IInternetServerConnection

Specified by:

isEnableDataFiltering in interface IServerConnection

Returns:

The pbvVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableDataFiltering

public void setEnableDataFiltering(boolean pbvVal)
                            throws IOException,
                                   AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setEnableDataFiltering in interface IInternetServerConnection

Specified by:

setEnableDataFiltering in interface IServerConnection

Parameters:

pbvVal - The pbvVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSetDefinitionList

public Object getDataSetDefinitionList()
                                throws IOException,
                                       AutomationException

Lists values in the dataset definition.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getDataSetDefinitionList in interface IInternetServerConnection

Specified by:

getDataSetDefinitionList in interface IServerConnection

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnabledDataDefinitions

public Object getEnabledDataDefinitions()
                                 throws IOException,
                                        AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getEnabledDataDefinitions in interface IInternetServerConnection

Specified by:

getEnabledDataDefinitions in interface IServerConnection

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorCode

public int getLastConnectionErrorCode()
                               throws IOException,
                                      AutomationException

Indicates error code value for the last Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getLastConnectionErrorCode in interface IInternetServerConnection

Specified by:

getLastConnectionErrorCode in interface IServerConnection

Specified by:

getLastConnectionErrorCode in interface ITxDiagnostics

Returns:

The pnErrorCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorMessage

public String getLastConnectionErrorMessage()
                                     throws IOException,
                                            AutomationException

Indicates error code value for the last Internet server connection.

Description

This property indicates error message value for the last Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getLastConnectionErrorMessage in interface IInternetServerConnection

Specified by:

getLastConnectionErrorMessage in interface IServerConnection

Specified by:

getLastConnectionErrorMessage in interface ITxDiagnostics

Returns:

The pbstrErrorMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionName

public String getConnectionName()
                         throws IOException,
                                AutomationException

Name of Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getConnectionName in interface IInternetServerConnection

Specified by:

getConnectionName in interface IServerConnection

Returns:

The pbstrConnectionName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionName

public void setConnectionName(String pbstrConnectionName)
                       throws IOException,
                              AutomationException

Name of Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setConnectionName in interface IInternetServerConnection

Specified by:

setConnectionName in interface IServerConnection

Parameters:

pbstrConnectionName - The pbstrConnectionName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionString

public String getConnectionString()
                           throws IOException,
                                  AutomationException

Indicates connection string value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getConnectionString in interface IInternetServerConnection

Specified by:

getConnectionString in interface IServerConnection

Returns:

The pbstrConnectionString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionString

public void setConnectionString(String pbstrConnectionString)
                         throws IOException,
                                AutomationException

Indicates connection string value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setConnectionString in interface IInternetServerConnection

Specified by:

setConnectionString in interface IServerConnection

Parameters:

pbstrConnectionString - The pbstrConnectionString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

public void connect(String bstrUserName,
                    String bstrPassword)
             throws IOException,
                    AutomationException

Creates Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

connect in interface IInternetServerConnection

Specified by:

connect in interface IServerConnection

Parameters:

bstrUserName - The bstrUserName (in)

bstrPassword - The bstrPassword (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws IOException,
                       AutomationException

Disconnects Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

disconnect in interface IInternetServerConnection

Specified by:

disconnect in interface IServerConnection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendMessage

public void sendMessage(IMessage piMessage)
                 throws IOException,
                        AutomationException

Sends message via the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

public IMessage getMessage(int nTimeOutInMilliseconds)
                    throws IOException,
                           AutomationException

Gets message via the Internet server connection.

Description

This method gets message via the Internet server connection. The method times out after nTimeOutInMilliseconds if no message is received by the connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableDataDefinition

public void enableDataDefinition(String bstrDataDefinitionID)
                          throws IOException,
                                 AutomationException

Enables data definition for the Internet server connection.

Description

This method enables a data definition for the Internet server connection specified by bstrDataDefinitionID. bstrDataDefinitionID is the key to the data definition to be enabled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

enableDataDefinition in interface IInternetServerConnection

Specified by:

enableDataDefinition in interface IServerConnection

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disableDataDefinition

public void disableDataDefinition(String bstrDataDefinitionID)
                           throws IOException,
                                  AutomationException

Disables dataset definition for the Internet server connection.

Description

This method disables a dataset definition for the internet server connection specified by bstrDataDefinitionID. bstrDataDefinitionID is the key to the dataset to be disabled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

disableDataDefinition in interface IInternetServerConnection

Specified by:

disableDataDefinition in interface IServerConnection

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

returnDataSetDefinition

public void returnDataSetDefinition(IDatasetDef piDataSetDef)
                             throws IOException,
                                    AutomationException

Returns value for dataset definition in Internet server connection.

Remarks

This method does nothing in the current version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSetDefinition

public IDatasetDef getDataSetDefinition(String bstrName)
                                 throws IOException,
                                        AutomationException

Gets value for dataset definition for Internet server connection.

Description

This method gets value for dataset definition for Internet server connection specified by bstrName.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendCommand

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

Sends command information via the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackingServicesList

public Object getTrackingServicesList()
                               throws IOException,
                                      AutomationException

Lists tracking services within the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getTrackingServicesList in interface IInternetServerConnection

Specified by:

getTrackingServicesList in interface IServerConnection2

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackingService

public ITrackingServiceDef getTrackingService(String bstrName)
                                       throws IOException,
                                              AutomationException

Gets tracking service information for the Internet server connection.

Description

This method gets message via the Internet server connection. The method times out after nTimeOutInMilliseconds if no message is received by the connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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.trackinganalyst.ITrackingServiceDef

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

returnTrackingService

public void returnTrackingService(ITrackingServiceDef piTrackingServiceDef)
                           throws IOException,
                                  AutomationException

Returns tracking service information for the Internet server connection.

Remarks

This method does nothing in the current version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

returnTrackingService in interface IInternetServerConnection

Specified by:

returnTrackingService in interface IServerConnection2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubletPath

public String getSubletPath()
                     throws IOException,
                            AutomationException

Value of the sublet path for the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getSubletPath in interface IInternetServerConnection

Returns:

The pbstrSubletPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubletPath

public void setSubletPath(String pbstrSubletPath)
                   throws IOException,
                          AutomationException

Value of the sublet path for the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setSubletPath in interface IInternetServerConnection

Parameters:

pbstrSubletPath - The pbstrSubletPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTopicName

public String getTopicName(String bstrServiceName)
                    throws IOException,
                           AutomationException

Indicates name for the topic in the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getTopicName in interface IInternetServerConnection

Parameters:

bstrServiceName - The bstrServiceName (in)

Returns:

The pbstrTopicName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTopicName

public void setTopicName(String bstrServiceName,
                         String pbstrTopicName)
                  throws IOException,
                         AutomationException

Indicates name for the topic in the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setTopicName in interface IInternetServerConnection

Parameters:

bstrServiceName - The bstrServiceName (in)

pbstrTopicName - The pbstrTopicName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPortNumber

public int getPortNumber()
                  throws IOException,
                         AutomationException

Port number used for the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getPortNumber in interface IInternetServerConnection

Returns:

The plPortNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPortNumber

public void setPortNumber(int plPortNumber)
                   throws IOException,
                          AutomationException

Port number used for the Internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setPortNumber in interface IInternetServerConnection

Parameters:

plPortNumber - The plPortNumber (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

public IPropSet getConnectionProperties()
                                 throws IOException,
                                        AutomationException

Properties for the server connection.

Remarks

The internet Connector uses the connection properties to manage all user modifiable features of the connector. Below summarizes the properties, their defaults and descriptions. The Internet Connector will default any property that is not present when setting the connection properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getConnectionProperties in interface IServerConnection2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionProperties

public void setConnectionProperties(IPropSet ppiProperties)
                             throws IOException,
                                    AutomationException

Properties for the server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setConnectionProperties in interface IServerConnection2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlugIn

public IPlugin getPlugIn()
                  throws IOException,
                         AutomationException

Data link plugin information for the server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getPlugIn in interface IServerConnection2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerActions

public Object getServerActions(boolean bForEditing)
                        throws IOException,
                               AutomationException

Actions used on data in the server connection.

Description

This method returns actions used on data in the server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getServerActions in interface IServerConnection2

Parameters:

bForEditing - The bForEditing (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

returnServerActions

public void returnServerActions(boolean bSave,
                                Object piActionCollection)
                         throws IOException,
                                AutomationException

Actions used on data in the server connection.

Remarks

This method is not implemented in the current version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

returnServerActions in interface IServerConnection2

Parameters:

bSave - The bSave (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasObjectData

public boolean isHasObjectData(String bstrTrackingService)
                        throws IOException,
                               AutomationException

Indicates whether a tracking service has complex data to request.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

isHasObjectData in interface ITrackingServiceComplexData

Parameters:

bstrTrackingService - The bstrTrackingService (in)

Returns:

The pbvarHasObjectData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

requestObjectData

public void requestObjectData(String bstrTrackingService)
                       throws IOException,
                              AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

requestObjectData in interface ITrackingServiceComplexData

Parameters:

bstrTrackingService - The bstrTrackingService (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActivityLog

public String getActivityLog()
                      throws IOException,
                             AutomationException

Indicates error code value for the last Internet server connection.

Description

This property indicates the activity log for the internet server connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getActivityLog in interface ITxDiagnostics

Returns:

The pbstrLog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReceivedMessageCount

public Object getReceivedMessageCount()
                               throws IOException,
                                      AutomationException

Indicates total number of messages received.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getReceivedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPulledMessageCount

public Object getPulledMessageCount()
                             throws IOException,
                                    AutomationException

Indicates total number of messages pulled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getPulledMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDiscardedMessageCount

public Object getDiscardedMessageCount()
                                throws IOException,
                                       AutomationException

Indicates total number of messages discarded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getDiscardedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentDiscardedMessageCount

public Object getCurrentDiscardedMessageCount()
                                       throws IOException,
                                              AutomationException

Indicates current number of messages discarded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getCurrentDiscardedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueuedMessageCount

public Object getQueuedMessageCount()
                             throws IOException,
                                    AutomationException

Indicates total number of messages queued.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getQueuedMessageCount in interface IConnectionStatistics

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDisconnect

public void onDisconnect()
                  throws IOException,
                         AutomationException

Fires an OnDisconnect Event.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

onDisconnect in interface IServerConnectionAdmin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onConnect

public void onConnect()
               throws IOException,
                      AutomationException

Fires an OnConnect Event.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

onConnect in interface IServerConnectionAdmin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onMessage

public void onMessage()
               throws IOException,
                      AutomationException

Fires an OnMessage Event.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

onMessage in interface IServerConnectionAdmin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onError

public void onError()
             throws IOException,
                    AutomationException

Fires an OnError Event.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

onError in interface IServerConnectionAdmin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

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

enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException