com.esri.arcgis.server
Interface IServerObjectAdmin2

All Superinterfaces:
IServerObjectAdmin, Serializable
All Known Subinterfaces:
IServerObjectAdmin3, IServerObjectAdmin4
All Known Implementing Classes:
IServerObjectAdmin2Proxy, IServerObjectAdmin3Proxy, IServerObjectAdmin4Proxy, ServerObjectAdmin

public interface IServerObjectAdmin2
extends IServerObjectAdmin, Serializable

Provides access to members that administer the ArcGIS server.

Description

IServerObjectAdmin2 provides methods to retrieve server configuration information and to administer the ArcGIS Server.

The IServerObjectAdmin2 interface can be obtained by a query interface with the IServerObjectAdmin interface.

Remarks

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

Administer the ArcGIS Server:

Get ArcGIS Server configuration information:

When To Use

Use the IServerObjectAmin2 interface when your application needs to connect to retrieve configuration information about the ArcGIS Server and when your application intends to administer the ArcGIS Server.

If your application is connecting to the server only to make use of objects in the server, use the IServerObjectManager interface instead.

Product Availability

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


Method Summary
 void addExtensionType(String sOTypeName, IServerObjectExtensionType pSOEType)
          Registers a new server object extension type with the server object type indicated in the argument list.
 IServerObjectExtensionType createExtensionType()
          Creates a new empty server object extension type.
 void createFolder(String folderName)
          Creates a server configuration folder.
 void deleteExtensionType(String sOTypeName, String sOETypeName)
          Unregisters a server object extension type from the server object type indicated in the argument list.
 void deleteFolder(String folderName)
          Deletes a server configuration folder.
 void disable()
          Disables a started SOM.
 void enable()
          Enables a disabled SOM.
 IEnumServerObjectConfiguration getConfigurationsEx(String folderName)
          An enumerator over all the server object configurations in a server configuration folder.
 IEnumServerObjectExtensionType getExtensionTypes(String sOTypeName)
          An enumerator over all the server object extension types.
 IPropertySet getFolderInfo(String folderName)
          Properties associated with a server configuration folder.
 IEnumBSTR getFolders(String folderName)
          An array of folder names in the server configuration folder.
 IServerLog getServerLog()
          Retrieves a reference to the ArcGIS Server logs.
 void renameFolder(String folderName, String newName)
          Renames a server configuration folder.
 void setFolderInfo(String folderName, IPropertySet ppInfo)
          Properties associated with a server configuration folder.
 void validateConfiguration(String name, String typeName)
          Validates server object configuration.
 
Methods inherited from interface com.esri.arcgis.server.IServerObjectAdmin
addConfiguration, addMachine, addServerDirectory, createConfiguration, createMachine, createServerDirectory, deleteConfiguration, deleteMachine, deleteServerDirectory, getConfiguration, getConfigurations, getConfigurationStatus, getMachine, getMachines, getProperties, getServerDirectories, getServerDirectory, getTypes, pauseConfiguration, setProperties, startConfiguration, stopConfiguration, updateConfiguration, updateMachine, updateServerDirectory
 

Method Detail

getExtensionTypes

IEnumServerObjectExtensionType getExtensionTypes(String sOTypeName)
                                                 throws IOException,
                                                        AutomationException
An enumerator over all the server object extension types.

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.

Product Availability

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

Parameters:
sOTypeName - The sOTypeName (in)
Returns:
A reference to a com.esri.arcgis.server.IEnumServerObjectExtensionType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerLog

IServerLog getServerLog()
                        throws IOException,
                               AutomationException
Retrieves a reference to the ArcGIS Server logs.

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.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.server.IServerLog
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enable

void enable()
            throws IOException,
                   AutomationException
Enables a disabled SOM.

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.

Product Availability

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

disable

void disable()
             throws IOException,
                    AutomationException
Disables a started SOM.

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.

Product Availability

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createExtensionType

IServerObjectExtensionType createExtensionType()
                                               throws IOException,
                                                      AutomationException
Creates a new empty server object extension type.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.server.IServerObjectExtensionType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addExtensionType

void addExtensionType(String sOTypeName,
                      IServerObjectExtensionType pSOEType)
                      throws IOException,
                             AutomationException
Registers a new server object extension type with the server object type indicated in the argument list.

Product Availability

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

Parameters:
sOTypeName - The sOTypeName (in)
pSOEType - A reference to a com.esri.arcgis.server.IServerObjectExtensionType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteExtensionType

void deleteExtensionType(String sOTypeName,
                         String sOETypeName)
                         throws IOException,
                                AutomationException
Unregisters a server object extension type from the server object type indicated in the argument list.

Product Availability

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

Parameters:
sOTypeName - The sOTypeName (in)
sOETypeName - The sOETypeName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createFolder

void createFolder(String folderName)
                  throws IOException,
                         AutomationException
Creates a server configuration folder.

Product Availability

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

Parameters:
folderName - The folderName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteFolder

void deleteFolder(String folderName)
                  throws IOException,
                         AutomationException
Deletes a server configuration folder.

Product Availability

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

Parameters:
folderName - The folderName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

renameFolder

void renameFolder(String folderName,
                  String newName)
                  throws IOException,
                         AutomationException
Renames a server configuration folder.

Product Availability

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

Parameters:
folderName - The folderName (in)
newName - The newName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFolders

IEnumBSTR getFolders(String folderName)
                     throws IOException,
                            AutomationException
An array of folder names in the server configuration folder.

Product Availability

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

Parameters:
folderName - The folderName (in)
Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFolderInfo

IPropertySet getFolderInfo(String folderName)
                           throws IOException,
                                  AutomationException
Properties associated with a server configuration folder.

Product Availability

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

Parameters:
folderName - The folderName (in)
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFolderInfo

void setFolderInfo(String folderName,
                   IPropertySet ppInfo)
                   throws IOException,
                          AutomationException
Properties associated with a server configuration folder.

Product Availability

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

Parameters:
folderName - The folderName (in)
ppInfo - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConfigurationsEx

IEnumServerObjectConfiguration getConfigurationsEx(String folderName)
                                                   throws IOException,
                                                          AutomationException
An enumerator over all the server object configurations in a server configuration folder.

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”

Product Availability

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

Parameters:
folderName - The folderName (in)
Returns:
A reference to a com.esri.arcgis.server.IEnumServerObjectConfiguration
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validateConfiguration

void validateConfiguration(String name,
                           String typeName)
                           throws IOException,
                                  AutomationException
Validates server object configuration.

Product Availability

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

Parameters:
name - The name (in)
typeName - The typeName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.