IServerObjectManager Interface

Provides access to properties and members of the ArcGIS server's server object manager.

When To Use

Use the IServerObjectManager interface when your application connects to the ArcGIS Server to use and create server objects. For performing administration tasks, such as adding and removing server object configurations, use the IServerObjectAdmin interface.

Members

Name Description
Method CreateServerContext Gets a reference to a server context. The server context can be based on a specified server object configuration, or can be an empty server context if no server object configuration is specified.
Method GetConfigurationInfo Gets the ServerObjectConfigurationInfo for the specified Name and TypeName.
Method GetConfigurationInfos An enumerator over all the GIS server's ServerObjectConfigurationInfos.
Method GetServerDirectoryInfos An enumerator over all the GIS server's ServerDirectoryInfos.
Method GetTypeInfos An enumerator over all the GIS server's ServerObjectTypeInfos.

IServerObjectManager.CreateServerContext Method

Gets a reference to a server context. The server context can be based on a specified server object configuration, or can be an empty server context if no server object configuration is specified.

Public Function CreateServerContext ( _
    ByVal configName As String, _
    ByVal TypeName As String _
) As IServerContext
public IServerContext CreateServerContext (
    string configName,
    string TypeName
);

Remarks

The CreateServerContext method on IServerObjectManager is used to get a reference to a context on the server. A context is a process managed by the server within which a server object runs. You can use CreateServerContext to create a context based on a server object configuration, or you can create empty contexts soley for the purpose of creating ArcObjects on the fly within the server.

When using CreateServerContext to create a context based on a server object configuration, if the server object configuration is pooled, you may get a reference to a context that is already created and running in the server. When you have completed using that context, it is important to released it explicitly by calling the ReleaseContext method on IServerContext to return it to the pool. When using CreateServerContext to create a context based on a non-pooled server object configuration, or when creating an empty context, a new context is created on the server. You still need to call ReleaseContext when you are finished using it, and the context is destroyed on the server.

As of 9.3 some of the possible values for typeName are:

  • MapServer - to get a Map Server context
  • GeocodeServer - to get a Geocode Server context
  • GlobeServer - to get a Globe Server context
  • GPServer - to get a Geoprocessing Server context
  • GeoDataServer - to get a GeoData Server context
  • GeometryServer - to get a Geometry Server context
  • ImageServer - to get an Image Server context

IServerObjectManager.GetConfigurationInfo Method

Gets the ServerObjectConfigurationInfo for the specified Name and TypeName.

Public Function GetConfigurationInfo ( _
    ByVal Name As String, _
    ByVal TypeName As String _
) As IServerObjectConfigurationInfo
public IServerObjectConfigurationInfo GetConfigurationInfo (
    string Name,
    string TypeName
);

Remarks

Returns the server configuration with the specified Name and Type as a ServerObjectConfigurationInfo object. The Info object provides information about the server object configuration required to make use of them in an application. This method will only return a ServerObjectConfigurationInfo for configurations which are started. If you call this method and specify a configuration which is not started, it will return an error.

Additional information about started server object configurations, and configurations that are not started can be accessed using the IServerObjectAdmin interface.

IServerObjectManager.GetConfigurationInfos Method

An enumerator over all the GIS server's ServerObjectConfigurationInfos.

Public Function GetConfigurationInfos ( _
) As IEnumServerObjectConfigurationInfo
public IEnumServerObjectConfigurationInfo GetConfigurationInfos (
);

Remarks

GetConfigurationInfos returns an enumeration (IEnumServerObjectConfigurationInfo) of IServerObjectConfigurationInfo for configurations of any esriConfigurationStatus from all folders.

These Info objects provide information about the server object configurations and types that are required to make use of them in an application. Additional information about server object configurations can be accessed using the IServerObjectAdmin interface.

IServerObjectManager.GetServerDirectoryInfos Method

An enumerator over all the GIS server's ServerDirectoryInfos.

Public Function GetServerDirectoryInfos ( _
) As IEnumServerDirectoryInfo
public IEnumServerDirectoryInfo GetServerDirectoryInfos (
);

Remarks

Returns an enumeration of server directories configured in the server as ServerDirectoryInfo objects. These Info objects provide information about the server directories required to make use of them in an application. Additional information about server directories configured in the server can be accessed using the IServerObjectAdmin interface.

IServerObjectManager.GetTypeInfos Method

An enumerator over all the GIS server's ServerObjectTypeInfos.

Public Function GetTypeInfos ( _
) As IEnumServerObjectTypeInfo
public IEnumServerObjectTypeInfo GetTypeInfos (
);

Remarks

Returns and enumeration of server object types in the server as ServerObjectTypeInfo objects. These Info objects provide information about the server object types required to make use of them in an application. Additional information about server object types in the server can be accessed using the IServerObjectAdmin interface.

Classes that implement IServerObjectManager

Classes Description
ServerObjectManager The ServerObjectManager object which creates ServerContext, ServerObjectConfigurationInfo and ServerObjectTypeInfo objects.

Remarks

Any application that runs as a user account in the agsusers user group on the ArcGIS Server can use the IGIS**ServerConnection interface to connect to the ArcGIS Server and to get a reference to the ServerObjectManager**.

The IServerObjectManager interface has the necessary methods for an application to get the collection of server object configurations and server object types configured in the server as ServerObjectConfigurationInfo and ServerObjectTypeInfo objects, respectivly. These Info objects provide information about the server object configurations and types required to make use of them in an application. Additional information about server object configurations and server object types configured in the server can be accessed using the IServerObjectAdmin interface.

The CreateServerContext method on IServerObjectManager is used to get a reference to a context on the server. A context is a process managed by the server within which a server object runs. You can use CreateServerContext to create a context based on a server object configuration, or you can create empty contexts soley for the purpose of creating ArcObjects on the fly within the server.

When using CreateServerContext to create a context based on a server object configuration, if the server object configuration is pooled, you may get a reference to a context that is already created and running in the server. When you have completed using that context, it is important to released it explicitly by calling the ReleaseContextmethod on IServerContext to return it to the pool. When using CreateServerContext to create a context based on a non-pooled server object configuration, or when creating an empty context, a new context is created on the server. You still need to call ReleaseContext when you are finished using it, and the context is destroyed on the server.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.