com.esri.arcgis.gisclient
Interface IIMSAxlRequest

All Superinterfaces:

Serializable

All Known Implementing Classes:

IMSMetadataServiceName, IMSServiceName

public interface IIMSAxlRequest
extends Serializable

Provides access to members that control AXL requests to IMS server.

Product Availability

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

Method Summary

String	getServerVersion(ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) The ArcIMS server version.
String	sendAxlRequest(String axl, boolean queryRequest, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) Sends an Axl request.
IStream	sendAxlRequestStream(String axl, boolean queryRequest, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) Sends an Axl request and returns a stream.
String	sendCommandRequest(String command, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages) Sends a command request,i.e.: ConnectorPing.

Method Detail

sendAxlRequest

String sendAxlRequest(String axl,
                      boolean queryRequest,
                      ITrackCancel trackCancel,
                      boolean showConnectingAVI,
                      boolean processMessages)
                      throws IOException,
                             AutomationException

Sends an Axl request.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

axl - The axl (in)

queryRequest - The queryRequest (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

showConnectingAVI - The showConnectingAVI (in)

processMessages - The processMessages (in)

Returns:

The response

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendAxlRequestStream

IStream sendAxlRequestStream(String axl,
                             boolean queryRequest,
                             ITrackCancel trackCancel,
                             boolean showConnectingAVI,
                             boolean processMessages)
                             throws IOException,
                                    AutomationException

Sends an Axl request and returns a stream.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

axl - The axl (in)

queryRequest - The queryRequest (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

showConnectingAVI - The showConnectingAVI (in)

processMessages - The processMessages (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendCommandRequest

String sendCommandRequest(String command,
                          ITrackCancel trackCancel,
                          boolean showConnectingAVI,
                          boolean processMessages)
                          throws IOException,
                                 AutomationException

Sends a command request,i.e.: ConnectorPing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

command - The command (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

showConnectingAVI - The showConnectingAVI (in)

processMessages - The processMessages (in)

Returns:

The response

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerVersion

String getServerVersion(ITrackCancel trackCancel,
                        boolean showConnectingAVI,
                        boolean processMessages)
                        throws IOException,
                               AutomationException

The ArcIMS server version.

Product Availability

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

Parameters:

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

showConnectingAVI - The showConnectingAVI (in)

processMessages - The processMessages (in)

Returns:

The serverVersion

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.