com.esri.arcgis.server
Class ServerEnvironmentXHelper

java.lang.Object
  com.esri.arcgis.server.ServerEnvironmentXHelper

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IServerEnvironmentXHelper, ISupportErrorInfo, Serializable

public class ServerEnvironmentXHelper
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, IServerEnvironmentXHelper

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ServerEnvironmentXHelper()
Constructs a ServerEnvironmentXHelper using ArcGIS Engine.

ServerEnvironmentXHelper(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ServerEnvironmentXHelper theServerEnvironmentXHelper = (ServerEnvironmentXHelper) obj;

Method Summary

void	addEnvProperty(String name, String value) Adds or updates a property into the server environment.
void	addServerDirectory(String dirPath, String uRL, String description, int cleaningMode, int maxFileAge, int type) Adds a new server directory into the server environment.
void	changeLogDirectory(String newLogDirectory) Changes the log directory for the logger configured in the server environment.
void	changeLogLevel(String newLogLevel) Changes the log level for the logger configured in the server environment.
void	changeLogMachineName(String newMachineName) Changes the machine name for the logger configured in the server environment.
void	changeMaxLogFileSize(int maxLogFileSize) Change the max log file size
void	enableCrashDumpGeneration(boolean bEnable) Enable crash dump files generation
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	removeEnvProperty(String name) Removes a property from the server environment.
void	removeServerDirectory(String dirPath) Removes a server directory from the server environment.
void	resetJobID() Resets the job ID.
void	setEnvProperties(IPropertySet ipProps) Sets the environment properties.
void	setJobID(String jobID) Sets the job ID in the server environment.
void	setUserInfo(String userInfo) Sets the user information into the server environment.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ServerEnvironmentXHelper

public ServerEnvironmentXHelper()
                         throws IOException,
                                UnknownHostException

Constructs a ServerEnvironmentXHelper using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ServerEnvironmentXHelper

public ServerEnvironmentXHelper(Object obj)
                         throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ServerEnvironmentXHelper theServerEnvironmentXHelper = (ServerEnvironmentXHelper) obj;

Construct a ServerEnvironmentXHelper using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ServerEnvironmentXHelper.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changeLogLevel

public void changeLogLevel(String newLogLevel)
                    throws IOException,
                           AutomationException

Changes the log level for the logger configured in the server environment.

Product Availability

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

Specified by:

changeLogLevel in interface IServerEnvironmentXHelper

Parameters:

newLogLevel - The newLogLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetJobID

public void resetJobID()
                throws IOException,
                       AutomationException

Resets the job ID.

Product Availability

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

Specified by:

resetJobID in interface IServerEnvironmentXHelper

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJobID

public void setJobID(String jobID)
              throws IOException,
                     AutomationException

Sets the job ID in the server environment.

Product Availability

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

Specified by:

setJobID in interface IServerEnvironmentXHelper

Parameters:

jobID - The jobID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addServerDirectory

public void addServerDirectory(String dirPath,
                               String uRL,
                               String description,
                               int cleaningMode,
                               int maxFileAge,
                               int type)
                        throws IOException,
                               AutomationException

Adds a new server directory into the server environment.

Product Availability

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

Specified by:

addServerDirectory in interface IServerEnvironmentXHelper

Parameters:

dirPath - The dirPath (in)

uRL - The uRL (in)

description - The description (in)

cleaningMode - A com.esri.arcgis.server.esriServerDirectoryCleaningMode constant (in)

maxFileAge - The maxFileAge (in)

type - A com.esri.arcgis.server.esriServerDirectoryType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeServerDirectory

public void removeServerDirectory(String dirPath)
                           throws IOException,
                                  AutomationException

Removes a server directory from the server environment.

Product Availability

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

Specified by:

removeServerDirectory in interface IServerEnvironmentXHelper

Parameters:

dirPath - The dirPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserInfo

public void setUserInfo(String userInfo)
                 throws IOException,
                        AutomationException

Sets the user information into the server environment.

Product Availability

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

Specified by:

setUserInfo in interface IServerEnvironmentXHelper

Parameters:

userInfo - The userInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnvProperties

public void setEnvProperties(IPropertySet ipProps)
                      throws IOException,
                             AutomationException

Sets the environment properties.

Product Availability

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

Specified by:

setEnvProperties in interface IServerEnvironmentXHelper

Parameters:

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

addEnvProperty

public void addEnvProperty(String name,
                           String value)
                    throws IOException,
                           AutomationException

Adds or updates a property into the server environment.

Product Availability

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

Specified by:

addEnvProperty in interface IServerEnvironmentXHelper

Parameters:

name - The name (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeEnvProperty

public void removeEnvProperty(String name)
                       throws IOException,
                              AutomationException

Removes a property from the server environment.

Product Availability

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

Specified by:

removeEnvProperty in interface IServerEnvironmentXHelper

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changeLogMachineName

public void changeLogMachineName(String newMachineName)
                          throws IOException,
                                 AutomationException

Changes the machine name for the logger configured in the server environment.

Product Availability

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

Specified by:

changeLogMachineName in interface IServerEnvironmentXHelper

Parameters:

newMachineName - The newMachineName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changeLogDirectory

public void changeLogDirectory(String newLogDirectory)
                        throws IOException,
                               AutomationException

Changes the log directory for the logger configured in the server environment.

Product Availability

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

Specified by:

changeLogDirectory in interface IServerEnvironmentXHelper

Parameters:

newLogDirectory - The newLogDirectory (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changeMaxLogFileSize

public void changeMaxLogFileSize(int maxLogFileSize)
                          throws IOException,
                                 AutomationException

Change the max log file size

Product Availability

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

Specified by:

changeMaxLogFileSize in interface IServerEnvironmentXHelper

Parameters:

maxLogFileSize - The maxLogFileSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableCrashDumpGeneration

public void enableCrashDumpGeneration(boolean bEnable)
                               throws IOException,
                                      AutomationException

Enable crash dump files generation

Product Availability

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

Specified by:

enableCrashDumpGeneration in interface IServerEnvironmentXHelper

Parameters:

bEnable - The bEnable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.