com.esri.arcgis.server
Interface IGISServer

All Superinterfaces:

Serializable

All Known Implementing Classes:

IGISServerProxy

public interface IGISServer
extends Serializable

Provides access to members that manage the collection of IGISServer objects.

Product Availability

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

Method Summary

String	getAlias() The alias used to designate this server.
int	getConnectionType() The type of connection to the SOMs of this ArcGIS Server (Round Robin or FailOver).
int	getMaxRequestLength() The maximum length of a SOAP or Binary request that can be sent to this server.
int	getMessageFormat() The format, SOAP/Binary or both, of messages that are to be sent to the server.
IServerInfos	getServerInfos() Returns the collection of ServerInfo objects (SOMs) associated with this server.
void	setAlias(String alias) The alias used to designate this server.
void	setConnectionType(int serverInfos) The type of connection to the SOMs of this ArcGIS Server (Round Robin or FailOver).
void	setMaxRequestLength(int maxRequestLength) The maximum length of a SOAP or Binary request that can be sent to this server.
void	setMessageFormat(int msgFormat) The format, SOAP/Binary or both, of messages that are to be sent to the server.
void	setServerInfos(IServerInfos serverInfos) Returns the collection of ServerInfo objects (SOMs) associated with this server.

Method Detail

setAlias

void setAlias(String alias)
              throws IOException,
                     AutomationException

The alias used to designate this server.

Product Availability

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

Parameters:

alias - The alias (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlias

String getAlias()
                throws IOException,
                       AutomationException

The alias used to designate this server.

Product Availability

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

Returns:

The alias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServerInfos

void setServerInfos(IServerInfos serverInfos)
                    throws IOException,
                           AutomationException

Returns the collection of ServerInfo objects (SOMs) associated with this server.

Product Availability

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

Parameters:

serverInfos - A reference to a com.esri.arcgis.server.IServerInfos (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerInfos

IServerInfos getServerInfos()
                            throws IOException,
                                   AutomationException

Returns the collection of ServerInfo objects (SOMs) associated with this server.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.server.IServerInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionType

void setConnectionType(int serverInfos)
                       throws IOException,
                              AutomationException

The type of connection to the SOMs of this ArcGIS Server (Round Robin or FailOver).

Product Availability

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

Parameters:

serverInfos - A com.esri.arcgis.server.esriServerConnectionType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionType

int getConnectionType()
                      throws IOException,
                             AutomationException

The type of connection to the SOMs of this ArcGIS Server (Round Robin or FailOver).

Product Availability

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

Returns:

A com.esri.arcgis.server.esriServerConnectionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRequestLength

void setMaxRequestLength(int maxRequestLength)
                         throws IOException,
                                AutomationException

The maximum length of a SOAP or Binary request that can be sent to this server.

Product Availability

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

Parameters:

maxRequestLength - The maxRequestLength (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRequestLength

int getMaxRequestLength()
                        throws IOException,
                               AutomationException

The maximum length of a SOAP or Binary request that can be sent to this server.

Product Availability

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

Returns:

The maxRequestLength

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMessageFormat

void setMessageFormat(int msgFormat)
                      throws IOException,
                             AutomationException

The format, SOAP/Binary or both, of messages that are to be sent to the server.

Product Availability

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

Parameters:

msgFormat - A com.esri.arcgis.server.esriServiceCatalogMessageFormat constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessageFormat

int getMessageFormat()
                     throws IOException,
                            AutomationException

The format, SOAP/Binary or both, of messages that are to be sent to the server.

Product Availability

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

Returns:

A com.esri.arcgis.server.esriServiceCatalogMessageFormat constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.