com.esri.arcgis.server
Class ServerObjectManager

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IPermissionsManager, IServerObjectManager, IServerObjectManager2, IServerObjectManager3, IServerObjectManager4, java.io.Serializable

public class ServerObjectManager
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerObjectManager, IServerObjectManager2, IServerObjectManager3, IServerObjectManager4, IPermissionsManager

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

Description 'The ServerObjectManager object which creates ServerContext, ServerObjectConfigurationInfo and ServerObjectTypeInfo objects.' 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.IServerObjectManager4

IID, IIDb87e5523_e612_4d71_a37f_89be65d783fd, xxDummy

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

IID0f25131d_5521_4e06_9a7f_bb246f25309c

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

IID2e3707f3_dae3_45ba_ac15_47ef7ec69946

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

IIDcf25ea7a_b5bc_47aa_94b2_4cd598b0c428

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

IID, IID05d95968_651a_4c97_b63e_d26f2bb0e97b, xxDummy

Constructor Summary

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

Method Summary

boolean	checkForDescendentsWithDifferentPermissions(java.lang.String principal, java.lang.String resource, java.lang.String operation) Checks whether the specified principal has different permissions among the descendents of the specified parent resource/operation combination.
boolean	checkPermission(java.lang.String principal, java.lang.String resource, java.lang.String operation) Checks whether the specified principal has permission to perform the given operation on the indicated resource.
IServerContext	createServerContext(java.lang.String configName, java.lang.String typeName) Gets a reference to a server context.
IServiceCatalog2	createServiceCatalog() Gets the ServiceCatalog for the services running on the server.
boolean	equals(java.lang.Object o) Compare this object with another
IServerObjectConfigurationInfo	getConfigurationInfo(java.lang.String name, java.lang.String typeName) Gets the ServerObjectConfigurationInfo for the specified Name and TypeName.
IEnumServerObjectConfigurationInfo	getConfigurationInfos() An enumerator over all the GIS server's ServerObjectConfigurationInfos.
IEnumServerObjectConfigurationInfo	getConfigurationInfosEx(java.lang.String folderName) An enumerator over all the ArcGIS server's ServerObjectExtensionInfos in a given folder.
IEnumServerObjectConfigurationInfo	getConfigurationInfosEx2(java.lang.String folderName, int stat) An enumerator over the ArcGIS server's ServerObjectExtensionInfos in a given 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.
IEnumServerObjectExtensionTypeInfo	getExtensionTypeInfos(java.lang.String sOTypeName) An enumerator over all the ArcGIS server's ServerObjectExtensionTypeInfos.
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IEnumBSTR	getPrincipalsWithPermissionOnResource(java.lang.String resource, java.lang.String operation) Enumerates all principals having permission to perform the specified operation on the given resource.
IEnumServerDirectoryInfo	getServerDirectoryInfos() An enumerator over all the GIS server's ServerDirectoryInfos.
IPropertySet	getSystemInfo() The properties of the underlying system hardware and software.
IEnumServerObjectTypeInfo	getTypeInfos() An enumerator over all the GIS server's ServerObjectTypeInfos.
int	hashCode() the hashcode for this object
void	release() Release a ServerObjectManager.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerObjectManager

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

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

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

Throws:

java.io.IOException - if there are interop problems ServerObjectManager theServerObjectManager = (ServerObjectManager) 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 ServerObjectManager.

Specified by:

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

createServerContext

public IServerContext createServerContext(java.lang.String configName,
                                          java.lang.String typeName)
                                   throws java.io.IOException,
                                          AutomationException

Gets a reference to a server context. The server context can be based on a specified server object configuration, or can be an empty server context if no server object configuration is specified.

Specified by:

createServerContext in interface IServerObjectManager

Parameters:

configName - The configName (in)

typeName - The typeName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfigurationInfo

public IServerObjectConfigurationInfo getConfigurationInfo(java.lang.String name,
                                                           java.lang.String typeName)
                                                    throws java.io.IOException,
                                                           AutomationException

Gets the ServerObjectConfigurationInfo for the specified Name and TypeName.

Specified by:

getConfigurationInfo in interface IServerObjectManager

Parameters:

name - The name (in)

typeName - The typeName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfigurationInfos

public IEnumServerObjectConfigurationInfo getConfigurationInfos()
                                                         throws java.io.IOException,
                                                                AutomationException

An enumerator over all the GIS server's ServerObjectConfigurationInfos.

Specified by:

getConfigurationInfos in interface IServerObjectManager

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTypeInfos

public IEnumServerObjectTypeInfo getTypeInfos()
                                       throws java.io.IOException,
                                              AutomationException

An enumerator over all the GIS server's ServerObjectTypeInfos.

Specified by:

getTypeInfos in interface IServerObjectManager

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerDirectoryInfos

public IEnumServerDirectoryInfo getServerDirectoryInfos()
                                                 throws java.io.IOException,
                                                        AutomationException

An enumerator over all the GIS server's ServerDirectoryInfos.

Specified by:

getServerDirectoryInfos in interface IServerObjectManager

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSystemInfo

public IPropertySet getSystemInfo()
                           throws java.io.IOException,
                                  AutomationException

The properties of the underlying system hardware and software.

Specified by:

getSystemInfo in interface IServerObjectManager2

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.

getExtensionTypeInfos

public IEnumServerObjectExtensionTypeInfo getExtensionTypeInfos(java.lang.String sOTypeName)
                                                         throws java.io.IOException,
                                                                AutomationException

An enumerator over all the ArcGIS server's ServerObjectExtensionTypeInfos.

Specified by:

getExtensionTypeInfos in interface IServerObjectManager2

Parameters:

sOTypeName - The sOTypeName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfigurationInfosEx

public IEnumServerObjectConfigurationInfo getConfigurationInfosEx(java.lang.String folderName)
                                                           throws java.io.IOException,
                                                                  AutomationException

An enumerator over all the ArcGIS server's ServerObjectExtensionInfos in a given folder.

Specified by:

getConfigurationInfosEx in interface IServerObjectManager2

Parameters:

folderName - The folderName (in)

Returns:

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

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 IServerObjectManager2

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 IServerObjectManager2

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.

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 IServerObjectManager2

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.

getConfigurationInfosEx2

public IEnumServerObjectConfigurationInfo getConfigurationInfosEx2(java.lang.String folderName,
                                                                   int stat)
                                                            throws java.io.IOException,
                                                                   AutomationException

An enumerator over the ArcGIS server's ServerObjectExtensionInfos in a given folder.

Specified by:

getConfigurationInfosEx2 in interface IServerObjectManager3

Parameters:

folderName - The folderName (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createServiceCatalog

public IServiceCatalog2 createServiceCatalog()
                                      throws java.io.IOException,
                                             AutomationException

Gets the ServiceCatalog for the services running on the server.

Specified by:

createServiceCatalog in interface IServerObjectManager4

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

checkPermission

public boolean checkPermission(java.lang.String principal,
                               java.lang.String resource,
                               java.lang.String operation)
                        throws java.io.IOException,
                               AutomationException

Checks whether the specified principal has permission to perform the given operation on the indicated resource.

Specified by:

checkPermission in interface IPermissionsManager

Parameters:

principal - The principal (in)

resource - The resource (in)

operation - The operation (in)

Returns:

The pbRes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrincipalsWithPermissionOnResource

public IEnumBSTR getPrincipalsWithPermissionOnResource(java.lang.String resource,
                                                       java.lang.String operation)
                                                throws java.io.IOException,
                                                       AutomationException

Enumerates all principals having permission to perform the specified operation on the given resource.

Specified by:

getPrincipalsWithPermissionOnResource in interface IPermissionsManager

Parameters:

resource - The resource (in)

operation - The operation (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.

checkForDescendentsWithDifferentPermissions

public boolean checkForDescendentsWithDifferentPermissions(java.lang.String principal,
                                                           java.lang.String resource,
                                                           java.lang.String operation)
                                                    throws java.io.IOException,
                                                           AutomationException

Checks whether the specified principal has different permissions among the descendents of the specified parent resource/operation combination.

Specified by:

checkForDescendentsWithDifferentPermissions in interface IPermissionsManager

Parameters:

principal - The principal (in)

resource - The resource (in)

operation - The operation (in)

Returns:

The pbRes

Throws:

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

AutomationException - If the ArcObject component throws an exception.