com.esri.arcgis.server
Class ServerObjectAdmin

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IPermissionsAdmin, IPermissionsAdmin2, IServerErrorReports, IServerObjectAdmin, IServerObjectAdmin2, IServerObjectAdmin3, IServerObjectAdmin4, IServerObjectAdmin5, IServerObjectAdmin6, IServerObjectAdmin7, IServerObjectAdmin8, IServerStatistics, java.io.Serializable

public class ServerObjectAdmin
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerObjectAdmin, IServerObjectAdmin2, IServerObjectAdmin3, IServerObjectAdmin4, IServerObjectAdmin5, IServerObjectAdmin6, IServerObjectAdmin7, IServerObjectAdmin8, IServerStatistics, IPermissionsAdmin, IPermissionsAdmin2, IServerErrorReports

COM Class 'ServerObjectAdmin'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriServer.olb'

Description 'The ServerObjectAdmin object which administrates the GIS Server.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.server.IServerObjectAdmin8

IID, IID22930007_4a01_479f_8cb6_33c8ac33ccf4, xxDummy

Fields inherited from interface com.esri.arcgis.server.IServerObjectAdmin7

IIDc6cfc4df_7928_4ec2_9f34_87eed2bac0a3

Fields inherited from interface com.esri.arcgis.server.IServerObjectAdmin6

IIDdc0e02cd_e386_4324_b31f_56b2c5d22363

Fields inherited from interface com.esri.arcgis.server.IServerObjectAdmin5

IIDa7b0b4b3_1001_49ad_ad44_aa6441d7300a

Fields inherited from interface com.esri.arcgis.server.IServerObjectAdmin4

IID6fa1268d_0dd4_46b6_b890_02e20fc6341f

Fields inherited from interface com.esri.arcgis.server.IServerObjectAdmin3

IIDe5079624_e7c9_4b12_9df7_2bc1c341a2b7

Fields inherited from interface com.esri.arcgis.server.IServerObjectAdmin2

IID4bc97a90_0b03_478c_8eb8_2ba647297bf7

Fields inherited from interface com.esri.arcgis.server.IServerObjectAdmin

IID01f6db39_6458_4c12_bcc7_30f1021075e2

Fields inherited from interface com.esri.arcgis.server.IServerStatistics

IID, IIDa0500a17_b797_41f3_94eb_66a32fcf8d80, xxDummy

Fields inherited from interface com.esri.arcgis.server.IPermissionsAdmin2

IID, IID8f6ce835_8644_420d_a2a3_2a84e2c29bfd, xxDummy

Fields inherited from interface com.esri.arcgis.server.IPermissionsAdmin

IID1d869ab1_db39_4cb8_9e95_a64ac2beb029

Fields inherited from interface com.esri.arcgis.server.IServerErrorReports

IID, IIDa0c0005d_c630_4a08_9805_5b3e4c446dbb, xxDummy

Constructor Summary

ServerObjectAdmin(java.lang.Object obj)
Construct a ServerObjectAdmin using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	addConfiguration(IServerObjectConfiguration config) Adds a server object configuration (created with CreateConfiguration) to the GIS server.
void	addExtensionType(java.lang.String sOTypeName, IServerObjectExtensionType pSOEType) Registers a new server object extension type with the server object type indicated in the argument list.
void	addGeodatabase(java.lang.String gdbName, java.lang.String val) Add Geodatabase.
void	addMachine(IServerMachine machine) Adds a host machine (created with CreateMachine) to the GIS server.
void	addServerDirectory(IServerDirectory pSD) Adds a server directory (created with CreateServerDirectory) to the GIS server.
void	allowPermission(java.lang.String principal, java.lang.String resource, java.lang.String operation) Grants permission to the specified principal to perform the given operation on the indicated resource.
void	cleanPermissions(java.lang.String principal) Removes all permissions for a particular principal.
IServerObjectConfiguration	createConfiguration() Creates a new server object configuration.
IServerObjectExtensionType	createExtensionType() Creates a new empty server object extension type.
void	createFolder(java.lang.String folderName) Creates a server configuration folder.
IServerMachine	createMachine() Creates a new host machine.
IServerDirectory	createServerDirectory() Creates a new server directory.
void	deleteConfiguration(java.lang.String name, java.lang.String typeName) Deletes a server object configuration from the GIS server.
void	deleteExtensionType(java.lang.String sOTypeName, java.lang.String sOETypeName) Unregisters a server object extension type from the server object type indicated in the argument list.
void	deleteFolder(java.lang.String folderName) Deletes a server configuration folder.
void	deleteGeodatabase(java.lang.String gdbName) Delete Geodatabase.
void	deleteMachine(java.lang.String machineName) Deletes a host machine from the GIS server, making it unavailable to host server objects.
void	deleteServerDirectory(java.lang.String path) Deletes a server directory such that its cleanup is no longer managed by the GIS server.
void	denyPermission(java.lang.String principal, java.lang.String resource, java.lang.String operation) Revokes permission from the specified principal to perform the given operation on the indicated resource.
void	disable() Disables a started SOM.
void	enable() Enables a disabled SOM.
boolean	equals(java.lang.Object o) Compare this object with another
IEnumBSTR	getAllPrincipals() Enumrates all princiapls in the Permissions Store.
IStatisticsResults	getAllStatisticsForTimeInterval(int event, int period, int index, int length, java.lang.String name, java.lang.String type, java.lang.String machine) Gets a set of statistics, such as count, min, max, mean for an event (such as context usage time) for a specified time period.
IServerObjectConfiguration	getConfiguration(java.lang.String name, java.lang.String typeName) Get the server object configuration with the specified Name and TypeName.
IPropertySet	getConfigurationProperties(java.lang.String name, java.lang.String type) Retrieves properties of server object configuration.
IEnumServerObjectConfiguration	getConfigurations() An enumerator over all the server object configurations.
IEnumServerObjectConfiguration	getConfigurationsEx(java.lang.String folderName) An enumerator over all the server object configurations in a server configuration folder.
IEnumServerObjectConfiguration	getConfigurationsEx2(java.lang.String folderName, int stat) An enumerator over all the server object configurations in a server configuration folder.
IServerObjectConfigurationStatus	getConfigurationStatus(java.lang.String name, java.lang.String typeName) Get the configuration status for a server object configuration with the specified Name and TypeName.
int	getErrorReportCacheSize() Maximum number of stored crash dumps.
java.lang.String	getErrorReportDir() Crash dump directory.
java.lang.String	getErrorReportEmailAddress() E-mail address of server administrator.
int	getErrorReportInterval() Interval at which SOM checks crash dumps and uploads error reports.
int	getErrorReportMode() Exception handling mode of SOC processes.
int	getErrorReportModeSOM() Exception handling mode of SOM process.
int	getErrorReportType() Crash dump type.
IEnumServerObjectExtensionType	getExtensionTypes(java.lang.String sOTypeName) An enumerator over all the server object extension types.
IPropertySet	getFolderInfo(java.lang.String folderName) Properties associated with a server configuration folder.
IEnumBSTR	getFolders(java.lang.String folderName) An array of folder names in the server configuration folder.
java.lang.String	getGeodatabase(java.lang.String gdbName, java.lang.String[] pUpdateID) Get Geodatabase.
java.lang.String	getGeodatabases() Get Geodatabases.
java.lang.String	getInputDir(java.lang.String cfgName, java.lang.String cfgType) Returns the input directory for the given Server Object Configuration.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IServerMachine	getMachine(java.lang.String name) Get the host machine with the specified Name.
IEnumServerMachine	getMachines() An enumerator over all the GIS server's host machines.
IPropertySet	getProperties() The properties for the GIS server.
IEnumServerDirectory	getServerDirectories() An enumerator over the GIS server's output directories.
IServerDirectory	getServerDirectory(java.lang.String path) Get the server directory with the specified Path.
IServerLog	getServerLog() Retrieves a reference to the ArcGIS Server logs.
IDoubleArray	getSpecificStatisticForTimeIntervals(int event, int function, int period, int index, int length, java.lang.String name, java.lang.String type, java.lang.String machine) Gets a specific statistic (such as total count of server contexts created) for a specified time period.
IEnumServerObjectType	getTypes() An enumerator over all the server object types.
int	hashCode() the hashcode for this object
boolean	isAdminUser(java.lang.String userName) Checks if given user is a member of agsadmin group.
boolean	isErrorReportEnableUpload() Indicates whether error reporting is enabled.
boolean	isInputDirInUse() Checks if at least one service is currently using the input directory
boolean	isSecurityEnabled() Indicates whether security is switched on or off.
void	pauseConfiguration(java.lang.String name, java.lang.String typeName) Makes the configuration unavailable to clients for processing requests, but does not shut down running instances of server objects, or interrupt requests in progress.
void	putGeodatabase(java.lang.String gdbName, java.lang.String val) Put Geodatabase.
void	release() Release a ServerObjectAdmin.
void	renameFolder(java.lang.String folderName, java.lang.String newName) Renames a server configuration folder.
void	reportErrors() Uploads stored error reports to the reporting web service.
void	reset() Clears out the currently gathered statistics.
void	setErrorReportCacheSize(int pVal) Maximum number of stored crash dumps.
void	setErrorReportDir(java.lang.String pVal) Crash dump directory.
void	setErrorReportEmailAddress(java.lang.String pVal) E-mail address of server administrator.
void	setErrorReportEnableUpload(boolean pVal) Indicates whether error reporting is enabled.
void	setErrorReportInterval(int pVal) Interval at which SOM checks crash dumps and uploads error reports.
void	setErrorReportMode(int pVal) Exception handling mode of SOC processes.
void	setErrorReportModeSOM(int pVal) Exception handling mode of SOM process.
void	setErrorReportType(int pVal) Crash dump type.
void	setFolderInfo(java.lang.String folderName, IPropertySet ppInfo) Properties associated with a server configuration folder.
void	setIsSecurityEnabled(boolean pVal) Indicates whether security is switched on or off.
void	setProperties(IPropertySet props) The properties for the GIS server.
void	startConfiguration(java.lang.String name, java.lang.String typeName) Starts a server object configuration and makes it available to clients for processing requests.
void	stopConfiguration(java.lang.String name, java.lang.String typeName) Stops a server object configuration and shuts down any running instances of server objects defined by the configuration.
void	updateConfiguration(IServerObjectConfiguration config) Updates the properties of a server object configuration.
void	updateConfigurationProperties(java.lang.String name, java.lang.String type, IPropertySet pProps) Updates properties of server object configuration.
void	updateMachine(IServerMachine machine) Updates the properties of a host machine.
void	updateServerDirectory(IServerDirectory pSD) Updates the properties of a server directory.
void	uploadData(java.lang.String cfgName, java.lang.String cfgType, java.lang.String fileName, byte[] data) Uploads data to server and saves it as a file in the input directory of the given configuration.
void	validateConfiguration(java.lang.String name, java.lang.String typeName) Validates server object configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerObjectAdmin

public ServerObjectAdmin(java.lang.Object obj)
                  throws java.io.IOException

Construct a ServerObjectAdmin using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ServerObjectAdmin.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ServerObjectAdmin o = (ServerObjectAdmin)obj; // will not work

ServerObjectAdmin o = new ServerObjectAdmin(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems ServerObjectAdmin theServerObjectAdmin = (ServerObjectAdmin) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a ServerObjectAdmin.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

createServerDirectory

public IServerDirectory createServerDirectory()
                                       throws java.io.IOException,
                                              AutomationException

Creates a new server directory.

Specified by:

createServerDirectory in interface IServerObjectAdmin

Returns:

A reference to a com.esri.arcgis.server.IServerDirectory

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addServerDirectory

public void addServerDirectory(IServerDirectory pSD)
                        throws java.io.IOException,
                               AutomationException

Adds a server directory (created with CreateServerDirectory) to the GIS server.

Specified by:

addServerDirectory in interface IServerObjectAdmin

Parameters:

pSD - A reference to a com.esri.arcgis.server.IServerDirectory (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateServerDirectory

public void updateServerDirectory(IServerDirectory pSD)
                           throws java.io.IOException,
                                  AutomationException

Updates the properties of a server directory.

Specified by:

updateServerDirectory in interface IServerObjectAdmin

Parameters:

pSD - A reference to a com.esri.arcgis.server.IServerDirectory (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteServerDirectory

public void deleteServerDirectory(java.lang.String path)
                           throws java.io.IOException,
                                  AutomationException

Deletes a server directory such that its cleanup is no longer managed by the GIS server. It does not delete the physical directory from disk.

Specified by:

deleteServerDirectory in interface IServerObjectAdmin

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerDirectory

public IServerDirectory getServerDirectory(java.lang.String path)
                                    throws java.io.IOException,
                                           AutomationException

Get the server directory with the specified Path.

Specified by:

getServerDirectory in interface IServerObjectAdmin

Parameters:

path - The path (in)

Returns:

A reference to a com.esri.arcgis.server.IServerDirectory

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerDirectories

public IEnumServerDirectory getServerDirectories()
                                          throws java.io.IOException,
                                                 AutomationException

An enumerator over the GIS server's output directories.

Specified by:

getServerDirectories in interface IServerObjectAdmin

Returns:

A reference to a com.esri.arcgis.server.IEnumServerDirectory

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createConfiguration

public IServerObjectConfiguration createConfiguration()
                                               throws java.io.IOException,
                                                      AutomationException

Creates a new server object configuration.

Specified by:

createConfiguration in interface IServerObjectAdmin

Returns:

A reference to a com.esri.arcgis.server.IServerObjectConfiguration

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addConfiguration

public void addConfiguration(IServerObjectConfiguration config)
                      throws java.io.IOException,
                             AutomationException

Adds a server object configuration (created with CreateConfiguration) to the GIS server.

Specified by:

addConfiguration in interface IServerObjectAdmin

Parameters:

config - A reference to a com.esri.arcgis.server.IServerObjectConfiguration (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfiguration

public IServerObjectConfiguration getConfiguration(java.lang.String name,
                                                   java.lang.String typeName)
                                            throws java.io.IOException,
                                                   AutomationException

Get the server object configuration with the specified Name and TypeName.

Specified by:

getConfiguration in interface IServerObjectAdmin

Parameters:

name - The name (in)

typeName - The typeName (in)

Returns:

A reference to a com.esri.arcgis.server.IServerObjectConfiguration

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateConfiguration

public void updateConfiguration(IServerObjectConfiguration config)
                         throws java.io.IOException,
                                AutomationException

Updates the properties of a server object configuration.

Specified by:

updateConfiguration in interface IServerObjectAdmin

Parameters:

config - A reference to a com.esri.arcgis.server.IServerObjectConfiguration (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteConfiguration

public void deleteConfiguration(java.lang.String name,
                                java.lang.String typeName)
                         throws java.io.IOException,
                                AutomationException

Deletes a server object configuration from the GIS server.

Specified by:

deleteConfiguration in interface IServerObjectAdmin

Parameters:

name - The name (in)

typeName - The typeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfigurations

public IEnumServerObjectConfiguration getConfigurations()
                                                 throws java.io.IOException,
                                                        AutomationException

An enumerator over all the server object configurations.

Specified by:

getConfigurations in interface IServerObjectAdmin

Returns:

A reference to a com.esri.arcgis.server.IEnumServerObjectConfiguration

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfigurationStatus

public IServerObjectConfigurationStatus getConfigurationStatus(java.lang.String name,
                                                               java.lang.String typeName)
                                                        throws java.io.IOException,
                                                               AutomationException

Get the configuration status for a server object configuration with the specified Name and TypeName.

Specified by:

getConfigurationStatus in interface IServerObjectAdmin

Parameters:

name - The name (in)

typeName - The typeName (in)

Returns:

A reference to a com.esri.arcgis.server.IServerObjectConfigurationStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTypes

public IEnumServerObjectType getTypes()
                               throws java.io.IOException,
                                      AutomationException

An enumerator over all the server object types.

Specified by:

getTypes in interface IServerObjectAdmin

Returns:

A reference to a com.esri.arcgis.server.IEnumServerObjectType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startConfiguration

public void startConfiguration(java.lang.String name,
                               java.lang.String typeName)
                        throws java.io.IOException,
                               AutomationException

Starts a server object configuration and makes it available to clients for processing requests.

Specified by:

startConfiguration in interface IServerObjectAdmin

Parameters:

name - The name (in)

typeName - The typeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopConfiguration

public void stopConfiguration(java.lang.String name,
                              java.lang.String typeName)
                       throws java.io.IOException,
                              AutomationException

Stops a server object configuration and shuts down any running instances of server objects defined by the configuration.

Specified by:

stopConfiguration in interface IServerObjectAdmin

Parameters:

name - The name (in)

typeName - The typeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

pauseConfiguration

public void pauseConfiguration(java.lang.String name,
                               java.lang.String typeName)
                        throws java.io.IOException,
                               AutomationException

Makes the configuration unavailable to clients for processing requests, but does not shut down running instances of server objects, or interrupt requests in progress.

Specified by:

pauseConfiguration in interface IServerObjectAdmin

Parameters:

name - The name (in)

typeName - The typeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createMachine

public IServerMachine createMachine()
                             throws java.io.IOException,
                                    AutomationException

Creates a new host machine.

Specified by:

createMachine in interface IServerObjectAdmin

Returns:

A reference to a com.esri.arcgis.server.IServerMachine

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addMachine

public void addMachine(IServerMachine machine)
                throws java.io.IOException,
                       AutomationException

Adds a host machine (created with CreateMachine) to the GIS server.

Specified by:

addMachine in interface IServerObjectAdmin

Parameters:

machine - A reference to a com.esri.arcgis.server.IServerMachine (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMachines

public IEnumServerMachine getMachines()
                               throws java.io.IOException,
                                      AutomationException

An enumerator over all the GIS server's host machines.

Specified by:

getMachines in interface IServerObjectAdmin

Returns:

A reference to a com.esri.arcgis.server.IEnumServerMachine

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteMachine

public void deleteMachine(java.lang.String machineName)
                   throws java.io.IOException,
                          AutomationException

Deletes a host machine from the GIS server, making it unavailable to host server objects.

Specified by:

deleteMachine in interface IServerObjectAdmin

Parameters:

machineName - The machineName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMachine

public IServerMachine getMachine(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

Get the host machine with the specified Name.

Specified by:

getMachine in interface IServerObjectAdmin

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.server.IServerMachine

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateMachine

public void updateMachine(IServerMachine machine)
                   throws java.io.IOException,
                          AutomationException

Updates the properties of a host machine.

Specified by:

updateMachine in interface IServerObjectAdmin

Parameters:

machine - A reference to a com.esri.arcgis.server.IServerMachine (in)

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

The properties for the GIS server.

Specified by:

getProperties in interface IServerObjectAdmin

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.

setProperties

public void setProperties(IPropertySet props)
                   throws java.io.IOException,
                          AutomationException

The properties for the GIS server.

Specified by:

setProperties in interface IServerObjectAdmin

Parameters:

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

getExtensionTypes

public IEnumServerObjectExtensionType getExtensionTypes(java.lang.String sOTypeName)
                                                 throws java.io.IOException,
                                                        AutomationException

An enumerator over all the server object extension types.

Specified by:

getExtensionTypes in interface IServerObjectAdmin2

Parameters:

sOTypeName - The sOTypeName (in)

Returns:

A reference to a com.esri.arcgis.server.IEnumServerObjectExtensionType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerLog

public IServerLog getServerLog()
                        throws java.io.IOException,
                               AutomationException

Retrieves a reference to the ArcGIS Server logs.

Specified by:

getServerLog in interface IServerObjectAdmin2

Returns:

A reference to a com.esri.arcgis.server.IServerLog

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enable

public void enable()
            throws java.io.IOException,
                   AutomationException

Enables a disabled SOM.

Specified by:

enable in interface IServerObjectAdmin2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disable

public void disable()
             throws java.io.IOException,
                    AutomationException

Disables a started SOM.

Specified by:

disable in interface IServerObjectAdmin2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createExtensionType

public IServerObjectExtensionType createExtensionType()
                                               throws java.io.IOException,
                                                      AutomationException

Creates a new empty server object extension type.

Specified by:

createExtensionType in interface IServerObjectAdmin2

Returns:

A reference to a com.esri.arcgis.server.IServerObjectExtensionType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addExtensionType

public void addExtensionType(java.lang.String sOTypeName,
                             IServerObjectExtensionType pSOEType)
                      throws java.io.IOException,
                             AutomationException

Registers a new server object extension type with the server object type indicated in the argument list.

Specified by:

addExtensionType in interface IServerObjectAdmin2

Parameters:

sOTypeName - The sOTypeName (in)

pSOEType - A reference to a com.esri.arcgis.server.IServerObjectExtensionType (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteExtensionType

public void deleteExtensionType(java.lang.String sOTypeName,
                                java.lang.String sOETypeName)
                         throws java.io.IOException,
                                AutomationException

Unregisters a server object extension type from the server object type indicated in the argument list.

Specified by:

deleteExtensionType in interface IServerObjectAdmin2

Parameters:

sOTypeName - The sOTypeName (in)

sOETypeName - The sOETypeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createFolder

public void createFolder(java.lang.String folderName)
                  throws java.io.IOException,
                         AutomationException

Creates a server configuration folder.

Specified by:

createFolder in interface IServerObjectAdmin2

Parameters:

folderName - The folderName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteFolder

public void deleteFolder(java.lang.String folderName)
                  throws java.io.IOException,
                         AutomationException

Deletes a server configuration folder.

Specified by:

deleteFolder in interface IServerObjectAdmin2

Parameters:

folderName - The folderName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

renameFolder

public void renameFolder(java.lang.String folderName,
                         java.lang.String newName)
                  throws java.io.IOException,
                         AutomationException

Renames a server configuration folder.

Specified by:

renameFolder in interface IServerObjectAdmin2

Parameters:

folderName - The folderName (in)

newName - The newName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFolders

public IEnumBSTR getFolders(java.lang.String folderName)
                     throws java.io.IOException,
                            AutomationException

An array of folder names in the server configuration folder.

Specified by:

getFolders in interface IServerObjectAdmin2

Parameters:

folderName - The folderName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFolderInfo

public IPropertySet getFolderInfo(java.lang.String folderName)
                           throws java.io.IOException,
                                  AutomationException

Properties associated with a server configuration folder.

Specified by:

getFolderInfo in interface IServerObjectAdmin2

Parameters:

folderName - The folderName (in)

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.

setFolderInfo

public void setFolderInfo(java.lang.String folderName,
                          IPropertySet ppInfo)
                   throws java.io.IOException,
                          AutomationException

Properties associated with a server configuration folder.

Specified by:

setFolderInfo in interface IServerObjectAdmin2

Parameters:

folderName - The folderName (in)

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

getConfigurationsEx

public IEnumServerObjectConfiguration getConfigurationsEx(java.lang.String folderName)
                                                   throws java.io.IOException,
                                                          AutomationException

An enumerator over all the server object configurations in a server configuration folder.

Specified by:

getConfigurationsEx in interface IServerObjectAdmin2

Parameters:

folderName - The folderName (in)

Returns:

A reference to a com.esri.arcgis.server.IEnumServerObjectConfiguration

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validateConfiguration

public void validateConfiguration(java.lang.String name,
                                  java.lang.String typeName)
                           throws java.io.IOException,
                                  AutomationException

Validates server object configuration.

Specified by:

validateConfiguration in interface IServerObjectAdmin2

Parameters:

name - The name (in)

typeName - The typeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfigurationsEx2

public IEnumServerObjectConfiguration getConfigurationsEx2(java.lang.String folderName,
                                                           int stat)
                                                    throws java.io.IOException,
                                                           AutomationException

An enumerator over all the server object configurations in a server configuration folder.

Specified by:

getConfigurationsEx2 in interface IServerObjectAdmin3

Parameters:

folderName - The folderName (in)

stat - A com.esri.arcgis.server.esriConfigurationStatus constant (in)

Returns:

A reference to a com.esri.arcgis.server.IEnumServerObjectConfiguration

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSecurityEnabled

public boolean isSecurityEnabled()
                          throws java.io.IOException,
                                 AutomationException

Indicates whether security is switched on or off.

Specified by:

isSecurityEnabled in interface IServerObjectAdmin4

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsSecurityEnabled

public void setIsSecurityEnabled(boolean pVal)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether security is switched on or off.

Specified by:

setIsSecurityEnabled in interface IServerObjectAdmin4

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfigurationProperties

public IPropertySet getConfigurationProperties(java.lang.String name,
                                               java.lang.String type)
                                        throws java.io.IOException,
                                               AutomationException

Retrieves properties of server object configuration.

Specified by:

getConfigurationProperties in interface IServerObjectAdmin5

Parameters:

name - The name (in)

type - The type (in)

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.

updateConfigurationProperties

public void updateConfigurationProperties(java.lang.String name,
                                          java.lang.String type,
                                          IPropertySet pProps)
                                   throws java.io.IOException,
                                          AutomationException

Updates properties of server object configuration.

Specified by:

updateConfigurationProperties in interface IServerObjectAdmin5

Parameters:

name - The name (in)

type - The type (in)

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

getInputDir

public java.lang.String getInputDir(java.lang.String cfgName,
                                    java.lang.String cfgType)
                             throws java.io.IOException,
                                    AutomationException

Returns the input directory for the given Server Object Configuration.

Specified by:

getInputDir in interface IServerObjectAdmin6

Parameters:

cfgName - The cfgName (in)

cfgType - The cfgType (in)

Returns:

The dir

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isInputDirInUse

public boolean isInputDirInUse()
                        throws java.io.IOException,
                               AutomationException

Checks if at least one service is currently using the input directory

Specified by:

isInputDirInUse in interface IServerObjectAdmin6

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

uploadData

public void uploadData(java.lang.String cfgName,
                       java.lang.String cfgType,
                       java.lang.String fileName,
                       byte[] data)
                throws java.io.IOException,
                       AutomationException

Uploads data to server and saves it as a file in the input directory of the given configuration.

Specified by:

uploadData in interface IServerObjectAdmin6

Parameters:

cfgName - The cfgName (in)

cfgType - The cfgType (in)

fileName - The fileName (in)

data - An unsigned byte (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAdminUser

public boolean isAdminUser(java.lang.String userName)
                    throws java.io.IOException,
                           AutomationException

Checks if given user is a member of agsadmin group.

Specified by:

isAdminUser in interface IServerObjectAdmin7

Parameters:

userName - The userName (in)

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addGeodatabase

public void addGeodatabase(java.lang.String gdbName,
                           java.lang.String val)
                    throws java.io.IOException,
                           AutomationException

Add Geodatabase.

Specified by:

addGeodatabase in interface IServerObjectAdmin8

Parameters:

gdbName - The gdbName (in)

val - The val (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteGeodatabase

public void deleteGeodatabase(java.lang.String gdbName)
                       throws java.io.IOException,
                              AutomationException

Delete Geodatabase.

Specified by:

deleteGeodatabase in interface IServerObjectAdmin8

Parameters:

gdbName - The gdbName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeodatabases

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

Get Geodatabases.

Specified by:

getGeodatabases in interface IServerObjectAdmin8

Returns:

The pList

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeodatabase

public java.lang.String getGeodatabase(java.lang.String gdbName,
                                       java.lang.String[] pUpdateID)
                                throws java.io.IOException,
                                       AutomationException

Get Geodatabase.

Specified by:

getGeodatabase in interface IServerObjectAdmin8

Parameters:

gdbName - The gdbName (in)

pUpdateID - The pUpdateID (out: use single element array)

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putGeodatabase

public void putGeodatabase(java.lang.String gdbName,
                           java.lang.String val)
                    throws java.io.IOException,
                           AutomationException

Put Geodatabase.

Specified by:

putGeodatabase in interface IServerObjectAdmin8

Parameters:

gdbName - The gdbName (in)

val - The val (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws java.io.IOException,
                  AutomationException

Clears out the currently gathered statistics.

Specified by:

reset in interface IServerStatistics

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpecificStatisticForTimeIntervals

public IDoubleArray getSpecificStatisticForTimeIntervals(int event,
                                                         int function,
                                                         int period,
                                                         int index,
                                                         int length,
                                                         java.lang.String name,
                                                         java.lang.String type,
                                                         java.lang.String machine)
                                                  throws java.io.IOException,
                                                         AutomationException

Gets a specific statistic (such as total count of server contexts created) for a specified time period.

Specified by:

getSpecificStatisticForTimeIntervals in interface IServerStatistics

Parameters:

event - A com.esri.arcgis.server.esriServerStatEvent constant (in)

function - A com.esri.arcgis.server.esriServerStatFunction constant (in)

period - A com.esri.arcgis.server.esriServerTimePeriod constant (in)

index - The index (in)

length - The length (in)

name - The name (in)

type - The type (in)

machine - The machine (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAllStatisticsForTimeInterval

public IStatisticsResults getAllStatisticsForTimeInterval(int event,
                                                          int period,
                                                          int index,
                                                          int length,
                                                          java.lang.String name,
                                                          java.lang.String type,
                                                          java.lang.String machine)
                                                   throws java.io.IOException,
                                                          AutomationException

Gets a set of statistics, such as count, min, max, mean for an event (such as context usage time) for a specified time period.

Specified by:

getAllStatisticsForTimeInterval in interface IServerStatistics

Parameters:

event - A com.esri.arcgis.server.esriServerStatEvent constant (in)

period - A com.esri.arcgis.server.esriServerTimePeriod constant (in)

index - The index (in)

length - The length (in)

name - The name (in)

type - The type (in)

machine - The machine (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

allowPermission

public void allowPermission(java.lang.String principal,
                            java.lang.String resource,
                            java.lang.String operation)
                     throws java.io.IOException,
                            AutomationException

Grants permission to the specified principal to perform the given operation on the indicated resource.

Specified by:

allowPermission in interface IPermissionsAdmin

Parameters:

principal - The principal (in)

resource - The resource (in)

operation - The operation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

denyPermission

public void denyPermission(java.lang.String principal,
                           java.lang.String resource,
                           java.lang.String operation)
                    throws java.io.IOException,
                           AutomationException

Revokes permission from the specified principal to perform the given operation on the indicated resource.

Specified by:

denyPermission in interface IPermissionsAdmin

Parameters:

principal - The principal (in)

resource - The resource (in)

operation - The operation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAllPrincipals

public IEnumBSTR getAllPrincipals()
                           throws java.io.IOException,
                                  AutomationException

Enumrates all princiapls in the Permissions Store.

Specified by:

getAllPrincipals in interface IPermissionsAdmin

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

cleanPermissions

public void cleanPermissions(java.lang.String principal)
                      throws java.io.IOException,
                             AutomationException

Removes all permissions for a particular principal.

Specified by:

cleanPermissions in interface IPermissionsAdmin2

Parameters:

principal - The principal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setErrorReportMode

public void setErrorReportMode(int pVal)
                        throws java.io.IOException,
                               AutomationException

Exception handling mode of SOC processes.

Specified by:

setErrorReportMode in interface IServerErrorReports

Parameters:

pVal - A com.esri.arcgis.server.esriServerExceptionHandlingMode constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorReportMode

public int getErrorReportMode()
                       throws java.io.IOException,
                              AutomationException

Exception handling mode of SOC processes.

Specified by:

getErrorReportMode in interface IServerErrorReports

Returns:

A com.esri.arcgis.server.esriServerExceptionHandlingMode constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setErrorReportModeSOM

public void setErrorReportModeSOM(int pVal)
                           throws java.io.IOException,
                                  AutomationException

Exception handling mode of SOM process.

Specified by:

setErrorReportModeSOM in interface IServerErrorReports

Parameters:

pVal - A com.esri.arcgis.server.esriServerExceptionHandlingMode constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorReportModeSOM

public int getErrorReportModeSOM()
                          throws java.io.IOException,
                                 AutomationException

Exception handling mode of SOM process.

Specified by:

getErrorReportModeSOM in interface IServerErrorReports

Returns:

A com.esri.arcgis.server.esriServerExceptionHandlingMode constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setErrorReportType

public void setErrorReportType(int pVal)
                        throws java.io.IOException,
                               AutomationException

Crash dump type.

Specified by:

setErrorReportType in interface IServerErrorReports

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorReportType

public int getErrorReportType()
                       throws java.io.IOException,
                              AutomationException

Crash dump type.

Specified by:

getErrorReportType in interface IServerErrorReports

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setErrorReportDir

public void setErrorReportDir(java.lang.String pVal)
                       throws java.io.IOException,
                              AutomationException

Crash dump directory.

Specified by:

setErrorReportDir in interface IServerErrorReports

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorReportDir

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

Crash dump directory.

Specified by:

getErrorReportDir in interface IServerErrorReports

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setErrorReportCacheSize

public void setErrorReportCacheSize(int pVal)
                             throws java.io.IOException,
                                    AutomationException

Maximum number of stored crash dumps.

Specified by:

setErrorReportCacheSize in interface IServerErrorReports

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorReportCacheSize

public int getErrorReportCacheSize()
                            throws java.io.IOException,
                                   AutomationException

Maximum number of stored crash dumps.

Specified by:

getErrorReportCacheSize in interface IServerErrorReports

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setErrorReportEnableUpload

public void setErrorReportEnableUpload(boolean pVal)
                                throws java.io.IOException,
                                       AutomationException

Indicates whether error reporting is enabled.

Specified by:

setErrorReportEnableUpload in interface IServerErrorReports

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isErrorReportEnableUpload

public boolean isErrorReportEnableUpload()
                                  throws java.io.IOException,
                                         AutomationException

Indicates whether error reporting is enabled.

Specified by:

isErrorReportEnableUpload in interface IServerErrorReports

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setErrorReportEmailAddress

public void setErrorReportEmailAddress(java.lang.String pVal)
                                throws java.io.IOException,
                                       AutomationException

E-mail address of server administrator.

Specified by:

setErrorReportEmailAddress in interface IServerErrorReports

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorReportEmailAddress

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

E-mail address of server administrator.

Specified by:

getErrorReportEmailAddress in interface IServerErrorReports

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setErrorReportInterval

public void setErrorReportInterval(int pVal)
                            throws java.io.IOException,
                                   AutomationException

Interval at which SOM checks crash dumps and uploads error reports.

Specified by:

setErrorReportInterval in interface IServerErrorReports

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorReportInterval

public int getErrorReportInterval()
                           throws java.io.IOException,
                                  AutomationException

Interval at which SOM checks crash dumps and uploads error reports.

Specified by:

getErrorReportInterval in interface IServerErrorReports

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reportErrors

public void reportErrors()
                  throws java.io.IOException,
                         AutomationException

Uploads stored error reports to the reporting web service.

Specified by:

reportErrors in interface IServerErrorReports

Throws:

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

AutomationException - If the ArcObject component throws an exception.