Class AGSServerConnectionClass

Namespace
ESRI.ArcGIS.GISClient
Assembly
ESRI.Server.GISClient.dll
[Guid("B49DEFD0-85C0-46F4-918B-1FB7E02A8C70")]
[ClassInterface(ClassInterfaceType.None)]
public class AGSServerConnectionClass : AGSServerConnection, IAGSServerConnection3, IAGSServerConnection2, IAGSServerConnection, IAGSServerConnectionAdmin, ISupportErrorInfo
Inheritance
AGSServerConnectionClass
Implements
Inherited Members

Constructors

AGSServerConnectionClass()

public AGSServerConnectionClass()

Explicit Interface Implementations

FullName

The AGSServerConnectionName object assiated with the GIS server connection.

virtual IName FullName { get; set; }

Returns

IName

Remarks

The FullName property gets and sets the AGSServerConnectionName name object. The AGSServerConnectionName for an AGSServerConnection can be persisted, for example, in a map document. An application can call the Open method on the AGSServerConnection name after loading it from persistent storage in order to connect to and get an object reference to the GIS server or web service catalog.

GetFile(string)

Retrieves a file from the specified url.

virtual IStream GetFile(string URL)

Parameters

URL string

Returns

IStream

GetFileAsVariant(string)

Retrieves the stream as variant from the specified url.

virtual object GetFileAsVariant(string URL)

Parameters

URL string

Returns

object

GetFolders(string)

Returns an enumeration of folder names beneath the specified folder.

virtual IEnumBSTR GetFolders(string reserved)

Parameters

reserved string

Returns

IEnumBSTR

IAGSServerConnection2_FullName

virtual IName IAGSServerConnection2_FullName { get; set; }

Returns

IName

IAGSServerConnection2_Name

virtual string IAGSServerConnection2_Name { get; set; }

Returns

string

IAGSServerConnection2_ServerObjectNames

virtual IAGSEnumServerObjectName IAGSServerConnection2_ServerObjectNames { get; }

Returns

IAGSEnumServerObjectName

IAGSServerConnection3_FullName

virtual IName IAGSServerConnection3_FullName { get; set; }

Returns

IName

IAGSServerConnection3_GetFolders(string)

virtual IEnumBSTR IAGSServerConnection3_GetFolders(string reserved)

Parameters

reserved string

Returns

IEnumBSTR

IAGSServerConnection3_Name

virtual string IAGSServerConnection3_Name { get; set; }

Returns

string

IAGSServerConnection3_ServerObjectNames

virtual IAGSEnumServerObjectName IAGSServerConnection3_ServerObjectNames { get; }

Returns

IAGSEnumServerObjectName

IAGSServerConnection3_ServerObjectNamesEx[string]

virtual IAGSEnumServerObjectName IAGSServerConnection3_ServerObjectNamesEx[string FolderName] { get; }

Parameters

FolderName string

Returns

IAGSEnumServerObjectName

InterfaceSupportsErrorInfo(ref Guid)

virtual void InterfaceSupportsErrorInfo(ref Guid riid)

Parameters

riid Guid

Name

The name of the connection.

virtual string Name { get; set; }

Returns

string

ServerObjectAdmin

The server object admin for the connected GIS server.

virtual IServerObjectAdmin ServerObjectAdmin { get; }

Returns

IServerObjectAdmin

Remarks

If the application using this interface is running as a user in the GIS server's administrators group (agadmin), it can use the ServerObjectAdmin property to get a reference to the GIS server's ServerObjectAdmin. Using the ServerObjectAdmin , you can perform administration tasks such as starting and stopping serever objects, and so on.

ServerObjectConfiguration[string, string]

The server object configuration with the specified Name and TypeName.

virtual IServerObjectConfiguration ServerObjectConfiguration[string Name, string Type] { get; }

Parameters

Name string
Type string

Returns

IServerObjectConfiguration

Remarks

The ServerObjectConfiguration property will return the ServerObjectConfiguration for the specified server object and type. The application must be running as a member of the GIS server's administrators group (agadmin) to succesfully get this property.

You can use the ServerObjectNames propety on IAGSServerConnection to get a list of the server objects configured in the server, then use the names and types as inputs to the ServerObjectConfiguration property. Once you have a ServerObjectConfiguration, you can update it, check its status and so on.

ServerObjectManager

The server object manager for the connected GIS server.

virtual IServerObjectManager ServerObjectManager { get; }

Returns

IServerObjectManager

Remarks

If the application using this interface is running as a user in the GIS server's users group (agsusers), it can use the ServerObjectManager property to get a reference to the GIS server's ServerObjectManager. Using the ServerObjectManager , you can create server contexts, works with ArcObjects in the GIS server and so on.

ServerObjectNames

The ServerObjectNames in the GIS server.

virtual IAGSEnumServerObjectName ServerObjectNames { get; }

Returns

IAGSEnumServerObjectName

Remarks

Returns an enumeration of the AGSServerObjectName objects in the GIS server or web service catalog. Note, if the application that uses this interface is running as a user in the GIS server's users group (agsusers), and connects directly to a GIS server over a LAN, this method will return only the server objects which are started. If the application that uses this interface is running as a user in the GIS server's administrators group (agsadmin), this method will return all server objects.

ServerObjectNamesEx[string]

The ServerObjectNames in the GIS server folder.

virtual IAGSEnumServerObjectName ServerObjectNamesEx[string FolderName] { get; }

Parameters

FolderName string

Returns

IAGSEnumServerObjectName