Interface IServerObjectAdmin2

Namespace
ESRI.ArcGIS.Server
Assembly
ESRI.Server.Server.dll

Provides access to members that administer the ArcGIS server.

[Guid("4BC97A90-0B03-478C-8EB8-2BA647297BF7")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IServerObjectAdmin2 : IServerObjectAdmin

Remarks

The following administration functionality of the ArcGIS Server is exposed by the methods of IServerObjectAdmin2 :

 

Administer the ArcGIS Server:

  • add and remove server object extension types.
  • access the server log.
  • enable a disabled ArcGIS server.
  • disable an enabled ArcGIS server.

 

Get ArcGIS Server configuration information:

  • get information about server object extension types.
  • get a reference to the server logs.
  • retrieve information about the underlying hardware and operating system.

Properties

FolderInfo[string]

Properties associated with a server configuration folder.

IPropertySet FolderInfo[string folderName] { get; set; }

Parameters

folderName string

Property Value

IPropertySet

Properties

IPropertySet Properties { get; set; }

Property Value

IPropertySet

ServerLog

Retrieves a reference to the ArcGIS Server logs.

IServerLog ServerLog { get; }

Property Value

IServerLog

Remarks

The ServerLog property of the IServerObjectAdmin2 interface is a reference to an IServerLog interface.  The IServerLog interface is used to query and retrieve records from the logs on disk.

Methods

AddConfiguration(IServerObjectConfiguration)

void AddConfiguration(IServerObjectConfiguration config)

Parameters

config IServerObjectConfiguration

AddExtensionType(string, IServerObjectExtensionType)

Registers a new server object extension type with the server object type indicated in the argument list.

void AddExtensionType(string SOTypeName, IServerObjectExtensionType pSOEType)

Parameters

SOTypeName string
pSOEType IServerObjectExtensionType

AddMachine(IServerMachine)

void AddMachine(IServerMachine Machine)

Parameters

Machine IServerMachine

AddServerDirectory(IServerDirectory)

void AddServerDirectory(IServerDirectory pSD)

Parameters

pSD IServerDirectory

CreateConfiguration()

IServerObjectConfiguration CreateConfiguration()

Returns

IServerObjectConfiguration

CreateExtensionType()

Creates a new empty server object extension type.

IServerObjectExtensionType CreateExtensionType()

Returns

IServerObjectExtensionType

CreateFolder(string)

Creates a server configuration folder.

void CreateFolder(string folderName)

Parameters

folderName string

CreateMachine()

IServerMachine CreateMachine()

Returns

IServerMachine

CreateServerDirectory()

IServerDirectory CreateServerDirectory()

Returns

IServerDirectory

DeleteConfiguration(string, string)

void DeleteConfiguration(string Name, string TypeName)

Parameters

Name string
TypeName string

DeleteExtensionType(string, string)

Unregisters a server object extension type from the server object type indicated in the argument list.

void DeleteExtensionType(string SOTypeName, string SOETypeName)

Parameters

SOTypeName string
SOETypeName string

DeleteFolder(string)

Deletes a server configuration folder.

void DeleteFolder(string folderName)

Parameters

folderName string

DeleteMachine(string)

void DeleteMachine(string MachineName)

Parameters

MachineName string

DeleteServerDirectory(string)

void DeleteServerDirectory(string Path)

Parameters

Path string

Disable()

Disables a started SOM.

void Disable()

Remarks

The Disable method of the IServerObjectAdmin2 interface disables a SOM.  This prevents further communication with any server objects until the Enable method is called. Diabling a SOM does not remove server objects from RAM.  When the SOM is enabled again, the server objects will be immediately available.

Enable()

Enables a disabled SOM.

void Enable()

Remarks

The Enable method of the IServerObjectAdmin2 interface enables a previously disabled SOM.  Using this method on a currently enabled SOM has no effect. Server objects that had been disabled will be immediately available.

GetConfiguration(string, string)

IServerObjectConfiguration GetConfiguration(string Name, string TypeName)

Parameters

Name string
TypeName string

Returns

IServerObjectConfiguration

GetConfigurationStatus(string, string)

IServerObjectConfigurationStatus GetConfigurationStatus(string Name, string TypeName)

Parameters

Name string
TypeName string

Returns

IServerObjectConfigurationStatus

GetConfigurations()

IEnumServerObjectConfiguration GetConfigurations()

Returns

IEnumServerObjectConfiguration

GetConfigurationsEx(string)

An enumerator over all the server object configurations in a server configuration folder.

IEnumServerObjectConfiguration GetConfigurationsEx(string folderName)

Parameters

folderName string

Returns

IEnumServerObjectConfiguration

Remarks

GetConfigurationEx returns an enumeration (IEnumServerObjectConfiguration) of IServerObjectConfiguration for configurations of any esriConfigurationStatus from the folder specified.

 

Some folderNames have special significance:

         folderName == “” means “root”.

         folderName == “NULL” means “all folders and root”

GetExtensionTypes(string)

An enumerator over all the server object extension types.

IEnumServerObjectExtensionType GetExtensionTypes(string SOTypeName)

Parameters

SOTypeName string

Returns

IEnumServerObjectExtensionType

Remarks

Server object extensions can be designated by a type name, description and class ID. The GetExtensionTypes method of the IServerObjectAdmin2 interface provides a reference to an enumeration of IServerObjectExtensionTypes. IServerObjectExtensionType has methods that can be interrogated for type name, description and class ID.

GetFolders(string)

An array of folder names in the server configuration folder.

IEnumBSTR GetFolders(string folderName)

Parameters

folderName string

Returns

IEnumBSTR

GetMachine(string)

IServerMachine GetMachine(string Name)

Parameters

Name string

Returns

IServerMachine

GetMachines()

IEnumServerMachine GetMachines()

Returns

IEnumServerMachine

GetServerDirectories()

IEnumServerDirectory GetServerDirectories()

Returns

IEnumServerDirectory

GetServerDirectory(string)

IServerDirectory GetServerDirectory(string Path)

Parameters

Path string

Returns

IServerDirectory

GetTypes()

IEnumServerObjectType GetTypes()

Returns

IEnumServerObjectType

PauseConfiguration(string, string)

void PauseConfiguration(string Name, string TypeName)

Parameters

Name string
TypeName string

RenameFolder(string, string)

Renames a server configuration folder.

void RenameFolder(string folderName, string newName)

Parameters

folderName string
newName string

StartConfiguration(string, string)

void StartConfiguration(string Name, string TypeName)

Parameters

Name string
TypeName string

StopConfiguration(string, string)

void StopConfiguration(string Name, string TypeName)

Parameters

Name string
TypeName string

UpdateConfiguration(IServerObjectConfiguration)

void UpdateConfiguration(IServerObjectConfiguration config)

Parameters

config IServerObjectConfiguration

UpdateMachine(IServerMachine)

void UpdateMachine(IServerMachine Machine)

Parameters

Machine IServerMachine

UpdateServerDirectory(IServerDirectory)

void UpdateServerDirectory(IServerDirectory pSD)

Parameters

pSD IServerDirectory

ValidateConfiguration(string, string)

Validates server object configuration.

void ValidateConfiguration(string Name, string TypeName)

Parameters

Name string
TypeName string