IServerObjectConfiguration2 Interface

Provides access to administrators to members that control the behavior and properties of a server object configuration with extensions.

Members

Name Description
Read/write property CleanupTimeout Maximum time (in seconds) that a SOC process will remain active to allow its no longer used server object threads to shut down gracefully before terminating them.
Read/write property Description Description of the server object configuration.
Method Deserialize Deserializes the server object configuration from a string.
Read/write property ExtensionEnabled Indicates whether the state of the named extension is Enabled (true) or Disabled (false).
Read/write property ExtensionInfo The extension-dependent info for the server object configuration.
Read/write property ExtensionProperties The extension-dependent properties for the server object configuration.
Read/write property Info Auxiliary Information for the server objects created by the server object configuration ?passive properties only.
Read/write property IsolationLevel The isolation level of the server objects defined by the server object configuration.
Read/write property IsPooled Indicates whether the server objects defined by this configuration are pooled.
Read/write property MaxInstances The maximum number of server object instances for a server object configuration.
Read/write property MinInstances The minimum number of server object instances for a server object configuration.
Read/write property Name Name of the server object configuration.
Read/write property Properties Initialization parameters and properties for the server objects created by the server object configuration.
Read/write property RecycleProperties The recycling properties for the server object configuration.
Method Serialize Serializes the server object configuration into a string.
Read/write property StartupTimeout Maximum time (in seconds) that a SOC process will wait for an instance of a server object to start.
Read/write property StartupType The startup type for this server object configuration. Startup type describes whether the server object configuration is started when the server object manager service is started for the GIS server.
Read/write property TypeName Type of the server object configuration (MapServer or GeocodeServer).
Read/write property UsageTimeout Maximum time (in seconds) a client can hold onto an instance of a server object for this server object configuration before releasing it back to the server. It is the maximum time allowed between calling CreateServerContext and ReleaseServerContext.
Read/write property WaitTimeout Maximum time (in seconds) a client will wait for an instance of a server object for this server object configuration using the CreateServerContext method on IServerObjectManager before timing out.

IServerObjectConfiguration2.CleanupTimeout Property

Maximum time (in seconds) that a SOC process will remain active to allow its no longer used server object threads to shut down gracefully before terminating them.

Public Property CleanupTimeout As Integer
public int CleanupTimeout {get; set;}

IServerObjectConfiguration2.Deserialize Method

Deserializes the server object configuration from a string.

Public Sub Deserialize ( _
    ByVal str As String _
)
public void Deserialize (
    string str
);

Remarks

The Serialize and Deserialize methods allow you to serialize server object configurations to strings, then deserialize them back into server object configurations. This can be useful when copying server object configurations between two GIS servers.

IServerObjectConfiguration2.ExtensionEnabled Property

Indicates whether the state of the named extension is Enabled (true) or Disabled (false).

Public Function get_ExtensionEnabled ( _
    ByVal Name As String _
) As Boolean
Public Sub set_ExtensionEnabled ( _
    ByVal Name As String, _
    ByVal pVal As Boolean _
)
public bool get_ExtensionEnabled (
    string Name
);
public void set_ExtensionEnabled (
    string Name,
    bool pVal
);

Remarks

When you create a server object configuration, all the server object extensions that are installed on the GIS server for the configuration's server object type are by default disabled, unless you enable them by setting the ExtensionEnabled property to true for the extension you want to enable.

You can do this before creating the configuration using IServerObjectAdmin::AddConfiguration, or you can enable an extension for an existing configuration using the IServerObjectAdmin::UpdateConfiguration.

IServerObjectConfiguration2.ExtensionInfo Property

The extension-dependent info for the server object configuration.

Public Function get_ExtensionInfo ( _
    ByVal Name As String _
) As IPropertySet
Public Sub set_ExtensionInfo ( _
    ByVal Name As String, _
    ByVal ppExtProperties As IPropertySet _
)
public IPropertySet get_ExtensionInfo (
    string Name
);
public void set_ExtensionInfo (
    string Name,
    IPropertySet ppExtProperties
);

IServerObjectConfiguration2.ExtensionProperties Property

The extension-dependent properties for the server object configuration.

Public Function get_ExtensionProperties ( _
    ByVal Name As String _
) As IPropertySet
Public Sub set_ExtensionProperties ( _
    ByVal Name As String, _
    ByVal ppExtProperties As IPropertySet _
)
public IPropertySet get_ExtensionProperties (
    string Name
);
public void set_ExtensionProperties (
    string Name,
    IPropertySet ppExtProperties
);

Remarks

Server object extensions may include properties that define parameters for their functionality. The set of properties is specific to the server object extension type.

You can get and set these properties using the ExtensionProperties property.

IServerObjectConfiguration2.Info Property

Auxiliary Information for the server objects created by the server object configuration ?passive properties only.

Public Property Info As IPropertySet
public IPropertySet Info {get; set;}

IServerObjectConfiguration2.Serialize Method

Serializes the server object configuration into a string.

Public Function Serialize ( _
) As String
public string Serialize (
);

Remarks

The Serialize and Deserialize methods allow you to serialize server object configurations to strings, then deserialize them back into server object configurations. This can be useful when copying server object configurations between two GIS servers.

IServerObjectConfiguration2.StartupTimeout Property

Maximum time (in seconds) that a SOC process will wait for an instance of a server object to start.

Public Property StartupTimeout As Integer
public int StartupTimeout {get; set;}

Inherited Interfaces

Interfaces Description
IServerObjectConfiguration Provides access to administrators to members that control the behavior and properties of a server object configuration.

Classes that implement IServerObjectConfiguration2

Classes Description
ServerObjectConfiguration The ServerObjectConfiguration object which defines the properties and behavior for server objects running in the GIS server.

Remarks

IServerObjectConfiguration2 extends IServerObjectConfiguration with properties for managing the server object configuration's extensions.

Set the ExtensionEnabled property to true for the server object extensions you want to enable for this configuration. A list of the server object extensions installed on the GIS server for each server object type are available via IServerObjectManager2::GetExtensionTypeInfos.

Use the ExtensionProperties property to specify the collection of properties for a server object extension.

The Serialize and Deserializemethods allow you to save the server object configuration as a string, and restore it from a string. This can be useful when copying server object configurations between two GIS servers.

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