com.esri.arcgis.system
Class IServerEnvironmentProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.system.IServerEnvironmentProxy
All Implemented Interfaces:
IServerEnvironment, Externalizable, Serializable
Direct Known Subclasses:
IServerEnvironment2Proxy

public class IServerEnvironmentProxy
extends com.esri.arcgis.interop.Dispatch
implements IServerEnvironment, 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.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IServerEnvironmentProxy()
           
  IServerEnvironmentProxy(Object obj)
           
protected IServerEnvironmentProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IServerEnvironmentProxy

public IServerEnvironmentProxy()

IServerEnvironmentProxy

public IServerEnvironmentProxy(Object obj)
                        throws IOException
Throws:
IOException

IServerEnvironmentProxy

protected IServerEnvironmentProxy(Object obj,
                                  String iid)
                           throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getLog

public 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.

Specified by:
getLog in interface IServerEnvironment
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

public 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.

Specified by:
getProperties in interface IServerEnvironment
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

public 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.

Specified by:
getJobTracker in interface IServerEnvironment
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

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

Product Availability

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

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

getCurrentJobID

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

Product Availability

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

Specified by:
getCurrentJobID in interface IServerEnvironment
Returns:
The pJobID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException