com.esri.arcgis.system
Interface IServerEnvironment

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IServerEnvironmentProxy

public interface IServerEnvironment

extends java.io.Serializable

Provides access to Server configuration information.

Product Availability

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

Description

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

When To Use

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

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.

Method Summary

java.lang.String	getCurrentJobID() Retrieves current job ID.
java.lang.String	getJobDirectory(java.lang.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

public ILog getLog()
            throws java.io.IOException,
                   AutomationException

Retrieves an ILog interface that can be used to add logging messages.

Returns:

A reference to a com.esri.arcgis.system.ILog

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

public IPropertySet getProperties()
                           throws java.io.IOException,
                                  AutomationException

Retrieves an IProperySet interface that provides access to the server configuration information.

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.

getJobTracker

public IJobTracker getJobTracker()
                          throws java.io.IOException,
                                 AutomationException

Retrieves IJobTracker interface that provides access to members that track and control execution of jobs.

Returns:

A reference to a com.esri.arcgis.system.IJobTracker

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobDirectory

public java.lang.String getJobDirectory(java.lang.String jobID)
                                 throws java.io.IOException,
                                        AutomationException

Retrieves job directory for given job.

Parameters:

jobID - The jobID (in)

Returns:

The pDirPath

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentJobID

public java.lang.String getCurrentJobID()
                                 throws java.io.IOException,
                                        AutomationException

Retrieves current job ID.

Returns:

The pJobID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.