com.esri.arcgis.server
Interface IServerEnvironmentXHelper

All Superinterfaces:

Serializable

All Known Implementing Classes:

ServerEnvironmentXHelper

public interface IServerEnvironmentXHelper
extends Serializable

Helper interface to set properties on the server environment.

Product Availability

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

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

Method Detail

changeLogLevel

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.

Parameters:

newLogLevel - The newLogLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetJobID

void resetJobID()
                throws IOException,
                       AutomationException

Resets the job ID.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJobID

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.

Parameters:

jobID - The jobID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addServerDirectory

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.

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

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.

Parameters:

dirPath - The dirPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserInfo

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.

Parameters:

userInfo - The userInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnvProperties

void setEnvProperties(IPropertySet ipProps)
                      throws IOException,
                             AutomationException

Sets the environment properties.

Product Availability

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

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

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.

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

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.

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changeLogMachineName

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.

Parameters:

newMachineName - The newMachineName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changeLogDirectory

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.

Parameters:

newLogDirectory - The newLogDirectory (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changeMaxLogFileSize

void changeMaxLogFileSize(int maxLogFileSize)
                          throws IOException,
                                 AutomationException

Change the max log file size

Product Availability

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

Parameters:

maxLogFileSize - The maxLogFileSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableCrashDumpGeneration

void enableCrashDumpGeneration(boolean bEnable)
                               throws IOException,
                                      AutomationException

Enable crash dump files generation

Product Availability

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

Parameters:

bEnable - The bEnable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.