com.esri.arcgis.server
Interface IServerObjectAdmin

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IServerObjectAdmin2, IServerObjectAdmin3, IServerObjectAdmin4, IServerObjectAdmin5, IServerObjectAdmin6, IServerObjectAdmin7, IServerObjectAdmin8
All Known Implementing Classes:
IServerObjectAdmin2Proxy, IServerObjectAdmin3Proxy, IServerObjectAdmin4Proxy, IServerObjectAdmin5Proxy, IServerObjectAdmin6Proxy, IServerObjectAdmin7Proxy, IServerObjectAdmin8Proxy, IServerObjectAdminProxy, ServerObjectAdmin

public interface IServerObjectAdmin
extends java.io.Serializable

COM Interface 'IServerObjectAdmin'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriServer.olb'

Description: 'Provides access to members that administer the ArcGIS server.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID01f6db39_6458_4c12_bcc7_30f1021075e2
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addConfiguration(IServerObjectConfiguration config)
          Adds a server object configuration (created with CreateConfiguration) to the GIS server.
 void addMachine(IServerMachine machine)
          Adds a host machine (created with CreateMachine) to the GIS server.
 void addServerDirectory(IServerDirectory pSD)
          Adds a server directory (created with CreateServerDirectory) to the GIS server.
 IServerObjectConfiguration createConfiguration()
          Creates a new server object configuration.
 IServerMachine createMachine()
          Creates a new host machine.
 IServerDirectory createServerDirectory()
          Creates a new server directory.
 void deleteConfiguration(java.lang.String name, java.lang.String typeName)
          Deletes a server object configuration from the GIS server.
 void deleteMachine(java.lang.String machineName)
          Deletes a host machine from the GIS server, making it unavailable to host server objects.
 void deleteServerDirectory(java.lang.String path)
          Deletes a server directory such that its cleanup is no longer managed by the GIS server.
 IServerObjectConfiguration getConfiguration(java.lang.String name, java.lang.String typeName)
          Get the server object configuration with the specified Name and TypeName.
 IEnumServerObjectConfiguration getConfigurations()
          An enumerator over all the server object configurations.
 IServerObjectConfigurationStatus getConfigurationStatus(java.lang.String name, java.lang.String typeName)
          Get the configuration status for a server object configuration with the specified Name and TypeName.
 IServerMachine getMachine(java.lang.String name)
          Get the host machine with the specified Name.
 IEnumServerMachine getMachines()
          An enumerator over all the GIS server's host machines.
 IPropertySet getProperties()
          The properties for the GIS server.
 IEnumServerDirectory getServerDirectories()
          An enumerator over the GIS server's output directories.
 IServerDirectory getServerDirectory(java.lang.String path)
          Get the server directory with the specified Path.
 IEnumServerObjectType getTypes()
          An enumerator over all the server object types.
 void pauseConfiguration(java.lang.String name, java.lang.String typeName)
          Makes the configuration unavailable to clients for processing requests, but does not shut down running instances of server objects, or interrupt requests in progress.
 void setProperties(IPropertySet props)
          The properties for the GIS server.
 void startConfiguration(java.lang.String name, java.lang.String typeName)
          Starts a server object configuration and makes it available to clients for processing requests.
 void stopConfiguration(java.lang.String name, java.lang.String typeName)
          Stops a server object configuration and shuts down any running instances of server objects defined by the configuration.
 void updateConfiguration(IServerObjectConfiguration config)
          Updates the properties of a server object configuration.
 void updateMachine(IServerMachine machine)
          Updates the properties of a host machine.
 void updateServerDirectory(IServerDirectory pSD)
          Updates the properties of a server directory.
 

Field Detail

IID01f6db39_6458_4c12_bcc7_30f1021075e2

static final int IID01f6db39_6458_4c12_bcc7_30f1021075e2
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

createServerDirectory

IServerDirectory createServerDirectory()
                                       throws java.io.IOException,
                                              AutomationException
Creates a new server directory.

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

addServerDirectory

void addServerDirectory(IServerDirectory pSD)
                        throws java.io.IOException,
                               AutomationException
Adds a server directory (created with CreateServerDirectory) to the GIS server.

Parameters:
pSD - A reference to a com.esri.arcgis.server.IServerDirectory (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateServerDirectory

void updateServerDirectory(IServerDirectory pSD)
                           throws java.io.IOException,
                                  AutomationException
Updates the properties of a server directory.

Parameters:
pSD - A reference to a com.esri.arcgis.server.IServerDirectory (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteServerDirectory

void deleteServerDirectory(java.lang.String path)
                           throws java.io.IOException,
                                  AutomationException
Deletes a server directory such that its cleanup is no longer managed by the GIS server. It does not delete the physical directory from disk.

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

getServerDirectory

IServerDirectory getServerDirectory(java.lang.String path)
                                    throws java.io.IOException,
                                           AutomationException
Get the server directory with the specified Path.

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

getServerDirectories

IEnumServerDirectory getServerDirectories()
                                          throws java.io.IOException,
                                                 AutomationException
An enumerator over the GIS server's output directories.

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

createConfiguration

IServerObjectConfiguration createConfiguration()
                                               throws java.io.IOException,
                                                      AutomationException
Creates a new server object configuration.

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

addConfiguration

void addConfiguration(IServerObjectConfiguration config)
                      throws java.io.IOException,
                             AutomationException
Adds a server object configuration (created with CreateConfiguration) to the GIS server.

Parameters:
config - A reference to a com.esri.arcgis.server.IServerObjectConfiguration (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConfiguration

IServerObjectConfiguration getConfiguration(java.lang.String name,
                                            java.lang.String typeName)
                                            throws java.io.IOException,
                                                   AutomationException
Get the server object configuration with the specified Name and TypeName.

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

updateConfiguration

void updateConfiguration(IServerObjectConfiguration config)
                         throws java.io.IOException,
                                AutomationException
Updates the properties of a server object configuration.

Parameters:
config - A reference to a com.esri.arcgis.server.IServerObjectConfiguration (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteConfiguration

void deleteConfiguration(java.lang.String name,
                         java.lang.String typeName)
                         throws java.io.IOException,
                                AutomationException
Deletes a server object configuration from the GIS server.

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

getConfigurations

IEnumServerObjectConfiguration getConfigurations()
                                                 throws java.io.IOException,
                                                        AutomationException
An enumerator over all the server object configurations.

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

getConfigurationStatus

IServerObjectConfigurationStatus getConfigurationStatus(java.lang.String name,
                                                        java.lang.String typeName)
                                                        throws java.io.IOException,
                                                               AutomationException
Get the configuration status for a server object configuration with the specified Name and TypeName.

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

getTypes

IEnumServerObjectType getTypes()
                               throws java.io.IOException,
                                      AutomationException
An enumerator over all the server object types.

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

startConfiguration

void startConfiguration(java.lang.String name,
                        java.lang.String typeName)
                        throws java.io.IOException,
                               AutomationException
Starts a server object configuration and makes it available to clients for processing requests.

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

stopConfiguration

void stopConfiguration(java.lang.String name,
                       java.lang.String typeName)
                       throws java.io.IOException,
                              AutomationException
Stops a server object configuration and shuts down any running instances of server objects defined by the configuration.

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

pauseConfiguration

void pauseConfiguration(java.lang.String name,
                        java.lang.String typeName)
                        throws java.io.IOException,
                               AutomationException
Makes the configuration unavailable to clients for processing requests, but does not shut down running instances of server objects, or interrupt requests in progress.

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

createMachine

IServerMachine createMachine()
                             throws java.io.IOException,
                                    AutomationException
Creates a new host machine.

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

addMachine

void addMachine(IServerMachine machine)
                throws java.io.IOException,
                       AutomationException
Adds a host machine (created with CreateMachine) to the GIS server.

Parameters:
machine - A reference to a com.esri.arcgis.server.IServerMachine (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMachines

IEnumServerMachine getMachines()
                               throws java.io.IOException,
                                      AutomationException
An enumerator over all the GIS server's host machines.

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

deleteMachine

void deleteMachine(java.lang.String machineName)
                   throws java.io.IOException,
                          AutomationException
Deletes a host machine from the GIS server, making it unavailable to host server objects.

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

getMachine

IServerMachine getMachine(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException
Get the host machine with the specified Name.

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

updateMachine

void updateMachine(IServerMachine machine)
                   throws java.io.IOException,
                          AutomationException
Updates the properties of a host machine.

Parameters:
machine - A reference to a com.esri.arcgis.server.IServerMachine (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProperties

IPropertySet getProperties()
                           throws java.io.IOException,
                                  AutomationException
The properties for the GIS server.

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

setProperties

void setProperties(IPropertySet props)
                   throws java.io.IOException,
                          AutomationException
The properties for the GIS server.

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