com.esri.arcgis.server
Interface IServerEnvironmentXHelper

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IServerEnvironmentXHelperProxy, ServerEnvironmentXHelper

public interface IServerEnvironmentXHelper
extends java.io.Serializable

COM Interface 'IServerEnvironmentXHelper'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriServer.olb'

Description: 'Helper interface to set properties on the server environment.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID9fc0c623_186b_4a67_a4c9_5dec2fb8377d
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addEnvProperty(java.lang.String name, java.lang.String value) Adds or updates a property into the server environment.
void	addServerDirectory(java.lang.String dirPath, java.lang.String uRL, java.lang.String description, int cleaningMode, int maxFileAge, int type) Adds a new server directory into the server environment.
void	changeLogDirectory(java.lang.String newLogDirectory) Changes the log directory for the logger configured in the server environment.
void	changeLogLevel(java.lang.String newLogLevel) Changes the log level for the logger configured in the server environment.
void	changeLogMachineName(java.lang.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(java.lang.String name) Removes a property from the server environment.
void	removeServerDirectory(java.lang.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(java.lang.String jobID) Sets the job ID in the server environment.
void	setUserInfo(java.lang.String userInfo) Sets the user information into the server environment.

Field Detail

IID9fc0c623_186b_4a67_a4c9_5dec2fb8377d

static final int IID9fc0c623_186b_4a67_a4c9_5dec2fb8377d

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

changeLogLevel

void changeLogLevel(java.lang.String newLogLevel)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

newLogLevel - The newLogLevel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resetJobID

void resetJobID()
                throws java.io.IOException,
                       AutomationException

Resets the job ID.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setJobID

void setJobID(java.lang.String jobID)
              throws java.io.IOException,
                     AutomationException

Sets the job ID in the server environment.

Parameters:

jobID - The jobID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addServerDirectory

void addServerDirectory(java.lang.String dirPath,
                        java.lang.String uRL,
                        java.lang.String description,
                        int cleaningMode,
                        int maxFileAge,
                        int type)
                        throws java.io.IOException,
                               AutomationException

Adds a new server directory into the server environment.

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:

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

AutomationException - If the ArcObject component throws an exception.

removeServerDirectory

void removeServerDirectory(java.lang.String dirPath)
                           throws java.io.IOException,
                                  AutomationException

Removes a server directory from the server environment.

Parameters:

dirPath - The dirPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUserInfo

void setUserInfo(java.lang.String userInfo)
                 throws java.io.IOException,
                        AutomationException

Sets the user information into the server environment.

Parameters:

userInfo - The userInfo (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnvProperties

void setEnvProperties(IPropertySet ipProps)
                      throws java.io.IOException,
                             AutomationException

Sets the environment properties.

Parameters:

ipProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addEnvProperty

void addEnvProperty(java.lang.String name,
                    java.lang.String value)
                    throws java.io.IOException,
                           AutomationException

Adds or updates a property into the server environment.

Parameters:

name - The name (in)

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeEnvProperty

void removeEnvProperty(java.lang.String name)
                       throws java.io.IOException,
                              AutomationException

Removes a property from the server environment.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

changeLogMachineName

void changeLogMachineName(java.lang.String newMachineName)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

newMachineName - The newMachineName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

changeLogDirectory

void changeLogDirectory(java.lang.String newLogDirectory)
                        throws java.io.IOException,
                               AutomationException

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

Parameters:

newLogDirectory - The newLogDirectory (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

changeMaxLogFileSize

void changeMaxLogFileSize(int maxLogFileSize)
                          throws java.io.IOException,
                                 AutomationException

Change the max log file size

Parameters:

maxLogFileSize - The maxLogFileSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enableCrashDumpGeneration

void enableCrashDumpGeneration(boolean bEnable)
                               throws java.io.IOException,
                                      AutomationException

Enable crash dump files generation

Parameters:

bEnable - The bEnable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.