com.esri.arcgis.system
Interface IServerEnvironment

All Superinterfaces:
Serializable
All Known Subinterfaces:
IServerEnvironment2
All Known Implementing Classes:
IServerEnvironment2Proxy, IServerEnvironmentProxy

public interface IServerEnvironment
extends Serializable

Provides access to Server configuration information.

Superseded By

IServerEnvironment2

Description

The methods of IServerEnvironment allow access to the ILog interface and the PropertySet of server configuration properties.

Remarks

This interface is primarily used when developing server object extensions. It permits access to an ILog interface which provides a conduit to log messages. It also retrieves the server properties as an IPropertySet interface. This PropertySet can be used to determine various properties, for example, output and input operating system paths, that might be useful to a server object extension programmer.

When To Use

Use this interface to retrieve the server properties and write access to the server logs.

Product Availability

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


Method Summary
 String getCurrentJobID()
          Retrieves current job ID.
 String getJobDirectory(String jobID)
          Retrieves job directory for given job.
 IJobTracker getJobTracker()
          Retrieves IJobTracker interface that provides access to members that track and control execution of jobs.
 ILog getLog()
          Retrieves an ILog interface that can be used to add logging messages.
 IPropertySet getProperties()
          Retrieves an IProperySet interface that provides access to the server configuration information.
 

Method Detail

getLog

ILog getLog()
            throws IOException,
                   AutomationException
Retrieves an ILog interface that can be used to add logging messages.

Product Availability

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

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

getProperties

IPropertySet getProperties()
                           throws IOException,
                                  AutomationException
Retrieves an IProperySet interface that provides access to the server configuration information.

Product Availability

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

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.

getJobTracker

IJobTracker getJobTracker()
                          throws IOException,
                                 AutomationException
Retrieves IJobTracker interface that provides access to members that track and control execution of jobs.

Product Availability

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

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

getJobDirectory

String getJobDirectory(String jobID)
                       throws IOException,
                              AutomationException
Retrieves job directory for given job.

Product Availability

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

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

getCurrentJobID

String getCurrentJobID()
                       throws IOException,
                              AutomationException
Retrieves current job ID.

Product Availability

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

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