Server

• Engine
• ArcGIS for Desktop Basic
• ArcGIS for Desktop Standard
• ArcGIS for Desktop Advanced
• Server

• Server connection objects
• Server consumer objects
• Server administration objects
• Server object extension objects

Server connection objects

• The goal of the security architecture is to implement security for systems with a Web (Hypertext Transfer Protocol [HTTP]) front end.
• Web users connect to and use GIS services via Web service endpoints using Simple Object Access Protocol (SOAP), Representational State Transfer (REST), Open Geospatial Consortium (OGC), or Keyhole Markup Language (KML) specifications.
• The security system being set up applies to these external Web users.
• An ArcGIS Server system has the following two user or identity spaces:
• External Web GIS users who connect to the Web service endpoints
• Local users who connect directly to the SOM
• Web service endpoint implementations connect locally to the GIS server (the SOM) and perform work on behalf of the external (Web GIS) user.
• Security is implemented in the Web tier such that Web users are allowed to access only those resources for which they are authorized.
• The permissions stored within the SOM apply to external users and roles.
• A local connection to the SOM can be used to determine if a specified external user has permission on a specified resource.
• Local connections to the SOM are made as a local user (using an operating system login that must be in the agsusers or agsadmin group).
• All local users, whether in the agsadmin or the agsusers group, are internal trusted users and by definition are able to see all information.

• User—An individual identified by a unique user name who wants to consume resources provided by ArcGIS Server. Users are stored in a user store, which can be a database or the active directory on a Windows server or a Lightweight Directory Access Protocol (LDAP) sever. All user authentication takes place in the Web tier.
• Role—A collection of users based on functional, departmental, or classification groupings (for example, planners, editors, classified, unclassified, and so on). A role can be assigned a permission to use or invoke operations on a resource. Roles are stored in a Role Store, which can be a database or the active directory on a Windows server or an LDAP server.
• Principal—A general term that denotes a iser or role.
• Resource—An item or object that is to be secured. In ArcGIS for Server, resources are Web applications and GIS services and server folders containing GIS services.
• Operation—An action or method that can be invoked on a secured resource. In ArcGIS for Server, no distinction is made between operations, and the only valid value, "*", is used to denote all actions.
• Permission—The ability of a role to use or invoke operations on a specific resource. Permissions are assigned in a Continuous Inheritance model. A child resource inherits permissions from its parent resource and the child can be changed to differ from the parent. Changing the permission on the parent for a specific user/role restores inheritance to match the parent recursively; all children will be changed to match the parent.

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect("myServer")

Dim serverObjectManager As IServerObjectManager=gisServerConnection.ServerObjectManager
Dim enumConfigInfo As IEnumServerObjectConfigurationInfo=serverObjectManager.GetConfigurationInfos

Dim configInfo As IServerObjectConfigurationInfo=enumConfigInfo.Next

Do Until configInfo Is Nothing
    Debug.Print (configInfo.Name & ": " & configInfo.TypeName)
    configInfo=enumConfigInfo.Next()
Loop

IGISServerConnection connection=new GISServerConnection();
connection.Connect("myServer");

IServerObjectManager serverObjectManager=connection.ServerObjectManager;
IEnumServerObjectConfigurationInfo enumConfigInfo =
    serverObjectManager.GetConfigurationInfos();

IServerObjectConfigurationInfo configInfo=enumConfigInfo.Next();

while (configInfo != null)
{
    Debug.Print(configInfo.Name + ": " + configInfo.TypeName);
    configInfo=enumConfigInfo.Next();
}

• X is the user name
• R1,R2,R3 are roles in which the user is a member

string userName="John";
string roles="Planner,Editor";
string userInfo=userName + ";" + roles;
string serverName="myServer";

IGISServerConnection2 connection2=new GISServerConnection();
connection2.Connect2(userInfo, serverName);
IServerObjectManager som=connection2.ServerObjectManager;

// Note: Attempts to call CreateServerContext through the SOM on a server object 
// configuration (GIS service) for which the specified roles (Planner, Editor) do not 
// have access will result in an Access Denied error.

• "?" Anonymous—A role that represents any anonymous user that has neither credentials recorded in the user store nor a supplied token.
• "@" Authenticated—A super role that includes all users with explicit credentials recorded in the user store.
• "*" Everyone—A super role that includes all authenticated users and all anonymous users.

string roles="Planner,Editor";
string serverName="myServer";
string resourceName="Countries/USA.MapServer";
string operation="*";

IGISServerConnection connection=new GISServerConnection();
connection.Connect(serverName);

IServerObjectManager som=connection.ServerObjectManager;
IPermissionsManager permissionsManager=(IPermissionsManager)som;

if (permissionsManager.CheckPermission(roles, resourceName, operation))
{
    Debug.Print("Access Allowed.");
}

else
{
    Debug.Print("Access Denied. The " + resourceName + 
        " resource does not allow the " + operation + " operation for the " + roles 
        + "  role(s).");
}

string serverName="myServer";
string roles="Planners,Editors";
string resourceName="Countries/USA.MapServer";
string operation="*";

IGISServerConnection connection=new GISServerConnection();
connection.Connect(serverName);

IServerObjectAdmin4 soa=(IServerObjectAdmin4)connection.ServerObjectAdmin;
IPermissionsAdmin permissionsAdmin=(IPermissionsAdmin)soa;

// Allow roles all operations on resourceName.
permissionsAdmin.AllowPermission(roles, resourceName, operation);

// Enable role-based security on the serverName server.
permissionsAdmin.IsSecurityEnabled=true;

Server consumer objects

Dim connection As IGISServerConnection=New GISServerConnectionClass()
connection.Connect("server_name")

Dim som As IServerObjectManager2=TryCast(connection.ServerObjectManager, IServerObjectManager2)
Dim props As IPropertySet=som.SystemInfo

Dim objkeys As Object
Dim objvalues As Object
Dim Keys As String()
Dim vals As Object()
props.GetAllProperties(objkeys, objvalues)
Keys=CType(objkeys, String())
vals=CType(objvalues, Object())

For i As Integer=0 To props.Count - 1
    Console.WriteLine(Keys(i) & ": " & vals(i))
Next i

IGISServerConnection connection=new GISServerConnectionClass();
connection.Connect("server_name");

IServerObjectManager2 som=connection.ServerObjectManager as IServerObjectManager2;
IPropertySet props=som.SystemInfo;

object objkeys=null;
object objvalues=null;
string[] keys=null;
object[] vals=null;
props.GetAllProperties(out objkeys, out objvalues);
keys=(string[])objkeys;
vals=(object[])objvalues;

for (int i=0; i < props.Count; i++)
{
    Console.WriteLine(keys[i] + ": " + vals[i]);
}

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect("myServer")

Dim serverObjectManager As IServerObjectManager=gisServerConnection.ServerObjectManager
Dim serverContext As IServerContext=serverObjectManager.CreateServerContext("RedlandsMap", "MapServer")
Dim serverObject As IServerObject=serverContext.ServerObject
Dim mapServer As IMapServer=TryCast(serverObject, IMapServer)

Debug.Print mapServer.DefaultMapName
serverContext.ReleaseContext()

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");

IServerObjectManager serverObjectManager=gisServerConnection.ServerObjectManager;
IServerContext serverContext=serverObjectManager.CreateServerContext("RedlandsMap",
    "MapServer");
IServerObject serverObject=serverContext.ServerObject;
IMapServer mapServer=serverObject as IMapServer;

Debug.Print(mapServer.DefaultMapName);
serverContext.ReleaseContext();

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect("myServer")
Dim serverObjectManager As IServerObjectManager
serverObjectManager=gisServerConnection.ServerObjectManager
Dim serverContext As IServerContext=serverObjectManager.CreateServerContext(String.Empty, String.Empty)
' Create a new polygon in the server context.
Dim pointColl As IPointCollection=CType(serverContext.CreateObject("esriGeometry.Polygon"), IPointCollection)
' Create the points in the server context.
Dim point(4) As IPoint
Dim i As Integer
For i=0 To 3
    point(i)=CType(serverContext.CreateObject("esriGeometry.Point"), IPoint)
Next
point(0).PutCoords(0, 0)
point(1).PutCoords(10, 0)
point(2).PutCoords(10, 10)
point(3).PutCoords(0, 10)
'Add the points to the polygon.
pointColl.AddPoints(4, point(0))
Dim area As IArea=TryCast(pointColl, IArea)
Debug.Print(CStr(area.Area))
serverContext.ReleaseContext()

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");

IServerObjectManager serverObjectManager=null;
serverObjectManager=gisServerConnection.ServerObjectManager;
IServerContext serverContext=serverObjectManager.CreateServerContext(string.Empty,
    string.Empty);

// Create a new polygon in the server context.
IPointCollection pointColl=(IPointCollection)(serverContext.CreateObject(
    "esriGeometry.Polygon"));

// Create the points in the server context.
IPoint[] point=new IPoint[5];
int i=0;
for (i=0; i <= 3; i++)
{
    point[i]=(IPoint)(serverContext.CreateObject("esriGeometry.Point"));
}

point[0].PutCoords(0, 0);
point[1].PutCoords(10, 0);
point[2].PutCoords(10, 10);
point[3].PutCoords(0, 10);

//Add the points to the polygon.
pointColl.AddPoints(4, ref point[0]);
IArea area=pointColl as IArea;
Debug.Print(System.Convert.ToString(area.Area));
serverContext.ReleaseContext();

Dim serverContext As IServerContext=serverObjectManager.CreateServerContext("RedlandsMap", "MapServer")
Dim mapServer As IMapServer=serverContext.ServerObject

IServerContext serverContext=serverObjectManager.CreateServerContext("RedlandsMap",
    "MapServer");
IMapServer mapServer=serverContext.ServerObject;

Dim serverContext As IServerContext=serverObjectManager.CreateServerContext(String.Empty, String.Empty)
Dim workspaceFactory As IWorkspaceFactory=serverContext.CreateObject("esriDataSourcesGDB.SdeWorkspaceFactory")

IServerContext serverContext=serverObjectManager.CreateServerContext(string.Empty,
    string.Empty);
IWorkspaceFactory workspaceFactory=serverContext.CreateObject(
    "esriDataSourcesGDB.SdeWorkspaceFactory");

Dim point As IPoint=New Point()

IPoint point=new Point();

Dim point As IPoint=serverContext.CreateObject("esriGeometry.Point")

IPoint point=serverContext.CreateObject("esriGeometry.Point");

Dim serverContext As IServerContext=serverObjectManager.CreateServerContext("RedlandsMap", "MapServer")
Dim mapServer As IMapServer=serverContext.ServerObject
' Do something with the object.
serverContext.ReleaseContext()

IServerContext serverContext=serverObjectManager.CreateServerContext("RedlandsMap",
    "MapServer");
IMapServer mapServer=serverContext.ServerObject;
// Do something with the object.
serverContext.ReleaseContext();

Dim pointCollection As IPointCollection=serverContext.CreateObject("esriGeometry.Polygon")

IPointCollection pointCollection=serverContext.CreateObject("esriGeometry.Polygon")
    ;

Dim pointCollection As IPointCollection=serverContext.CreateObject("esriGeometry.Polygon")
Dim point As IPoint=serverContext.CreateObject("esriGeometry.Point")
point.X=1
point.Y=1
pointCollection.AddPoint (point)

IPointCollection pointCollection=serverContext.CreateObject("esriGeometry.Polygon")
    ;
IPoint point=serverContext.CreateObject("esriGeometry.Point");
point.X=1;
point.Y=1;
pointCollection.AddPoint(point);

Dim remotePoint As IPoint=serverContext.CreateObject("esriGeometry.Point")

IPoint remotePoint=serverContext.CreateObject("esriGeometry.Point");

Dim localPoint As IPoint=New Point()

IPoint localPoint=New Point();

' This is incorrect:
localPoint=remotePoint

' This is also incorrect:
localElement.Geometry=remotePoint

//This is incorrect:
localPoint=remotePoint;

//This is also incorrect:
localElement.Geometry=remotePoint;

' This is incorrect:
localPoint=remotePointCollection.Point(0)

// This is incorrect:
localPoint=remotePointCollection.Point(0);

' This is incorrect:
remoteWorkspace=remoteWorkspaceFactory.Open(localPropertySet, 0)

// This is incorrect:
remoteWorkspace=remoteWorkspaceFactory.Open(localPropertySet, 0);

' This is acceptable:
localPoint.X=remotePoint.X
localPoint.Y=remotePoint.Y

// This is acceptable:
localPoint.X=remotePoint.X localPoint.Y=remotePoint.Y

Dim pointCollection As IPointCollection=serverContext.CreateObject("esriGeometry.Polygon")
serverContext.SetObject ("myPoly", pointCollection)
Dim poly As IPolygon=serverContext.GetObject("myPoly")

IPointCollection pointCollection=serverContext.CreateObject("esriGeometry.Polygon")
    ;
serverContext.SetObject("myPoly", pointCollection);
IPolygon poly=serverContext.GetObject("myPoly");

serverContext.Remove ("myPoly")

serverContext.Remove("myPoly");

Dim serverContext As IServerContext=SOM.CreateServerContext("RedlandsMap", "MapServer")
Dim serverContext2 As IServerContext=SOM.CreateServerContext("RedlandsGeocode", "GeocodeServer")

Dim gcServer As IGeocodeServer=TryCast(serverContext2.ServerObject, IGeocodeServer)

Dim propertySet As IPropertySet=TryCast(serverContext2.CreateObject("esriSystem.PropertySet"), IPropertySet)

propertySet.SetProperty("Street", "380 New York St")
    Dim results As IPropertySet=gcServer.GeocodeAddress(propertySet, Nothing)
    Dim point As IPoint=TryCast(results.GetProperty("Shape"), IPoint)
    
    ' Copy the point to the MapServer's context.
    Dim stringPoint As String=serverContext2.SaveObject(point)
    Dim pointCopy As IPoint=TryCast(serverContext.LoadObject(stringPoint), IPoint)

IServerContext serverContext=SOM.CreateServerContext("RedlandsMap", "MapServer");
IServerContext serverContext2=SOM.CreateServerContext("RedlandsGeocode", 
    "GeocodeServer");

IGeocodeServer gcServer=serverContext2.ServerObject as IGeocodeServer;

IPropertySet propertySet=serverContext2.CreateObject("esriSystem.PropertySet")as
    IPropertySet;
propertySet.SetProperty("Street", "380 New York St");
IPropertySet results=gcServer.GeocodeAddress(propertySet, null);
IPoint point=results.GetProperty("Shape")as IPoint;

// Copy the point to the MapServer's context.
string stringPoint=serverContext2.SaveObject(point);
IPoint pointCopy=serverContext.LoadObject(stringPoint)as IPoint;

1. The client application gets or creates an object within a server context.
2. The application uses the SaveObject method on the object's context to serialize the object as a string that is held in the application's session state.
3. The client application gets a reference to another server context and calls the LoadObject method, passing in the string created by SaveObject. LoadObject creates a new instance of the object in the new server context.

• MapServer is a coarse-grained server object that provides access to the contents of a map document and methods for querying and drawing the map.
• GeocodeServer is a coarse-grained server object that provides access to an address locator and methods for single address and batch geocoding.
• GeoDataServer is a coarse-grained server object that provides access to a geodatabase and methods for data management.
• GlobeServer is a coarse-grained server object that provides access to a globe document and methods for displaying the globe.
• GPServer is a coarse-grained server object that provides access to one or more geoprocessing tools and methods for executing those tools in the GIS server.
• ImageServer is a coarse-grained server object that provides access to a raster data source and methods for displaying and extracting the raster.
• GeometryServer is a coarse-grained server object that provides access to methods that support geometric operations in the Web Application Developer Framework (ADF).

Dim serverObjectFactory As ServerObjectFactory=New ServerObjectFactory()
Dim serverObject As IServerObject=serverObjectFactory.CreateServerObject("43E4F6B6-7B17-4536-B7CF-C0454EBB0F5A", "SomeMap", "MapServer")
Dim extensionMgr As IServerObjectExtensionManager=CType(serverObject, IServerObjectExtensionManager)
Dim serverObjectExtension As IServerObjectExtension=extensionMgr.FindExtensionByName("MySOE")

' Set a property called PropName to the Value for your server object extension called MySOE.
Dim mySOE As IMySOE=TryCast(soe, IMySOE)
Dim propSet As IPropertySet=New PropertySet()
propSet.SetProperty("PropName", "Value")

Dim objConstruct As IObjectConstruct=TryCast(mySOE, IObjectConstruct)
objConstruct.Construct(propSet)

ServerObjectFactory serverObjectFactory=new ServerObjectFactory();
IServerObject serverObject=serverObjectFactory.CreateServerObject(
    "43E4F6B6-7B17-4536-B7CF-C0454EBB0F5A", "SomeMap", "MapServer");
IServerObjectExtensionManager extensionMgr=serverObject as
    IServerObjectExtensionManager;
IServerObjectExtension serverObjectExtension=extensionMgr.FindExtensionByTypeName(
    "MySOE");

// Set a property called PropName to the Value for your server object extension called MySOE.
IMySOE mySOE=(IMySOE)serverObjectExtension;
IPropertySet propSet=new PropertySet();
propSet.SetProperty("PropName", "Value");

IObjectConstruct objConstruct=mySOE as IObjectConstruct;
objConstruct.Construct(propSet);

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect ("padisha")

Dim SOM As IServerObjectManager=gisServerConnection.ServerObjectManager
Dim context As IServerContext=SOM.CreateServerContext("MyMapServer", "MapServer")
Dim serverObject As IServerObject=context.ServerObject
Dim mapServer As IMapServer=TryCast(serverObject, IMapServer)

' Do something with the MapServer.
context.ReleaseContext()

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("padisha");

IServerObjectManager SOM=gisServerConnection.ServerObjectManager;
IServerContext context=SOM.CreateServerContext("MyMapServer", "MapServer");
IServerObject serverObject=context.ServerObject;
IMapServer mapServer=serverObject as IMapServer;

// Do something with the MapServer.
context.ReleaseContext();

• NAServer—Extends the MapServer server object to include network analysis functions for operations such as routing and service area analysis
• MobileServer—Extends the MapServer server object to allow mobile devices to extract data from a map on the server
• WMSServer—Extends the MapServer server object to provide the capabilities required for publishing the MapServer as an Open Geospatial Consortium, Inc. (OGC), Web Map Service (WMS)
• KmlServer—Extends the MapServer server object to return a stream of vector and raster layers to any client capable of reading compressed Keyhole Markup Language (KMZ) [KML] documents

Dim serverContext As IServerContext=SOM.CreateServerContext("usa", "MapServer")
Dim mapServer As IMapServer=CType(serverContext.ServerObject, IMapServer)Dim soExtManager As IServerObjectExtensionManager=TryCast(mapServer, IServerObjectExtensionManager)
Dim soExt As IServerObjectExtension=soExtManager.FindExtensionByTypeName("NAServer")
Dim naServer As INAServer=TryCast(soExt, INAServer)
Dim layers As String()=naServer.GetNALayerNames(esriNAServerLayerType.esriNAServerRouteLayer)
serverContext.ReleaseContext()

IServerContext serverContext=SOM.CreateServerContext("usa", "MapServer");
IMapServer mapServer=(IMapServer)serverContext.ServerObject;
IServerObjectExtensionManager soExtManager=mapServer as
    IServerObjectExtensionManager;
IServerObjectExtension soExt=soExtManager.FindExtensionByTypeName("NAServer");
INAServer naServer=soExt as INAServer;
string[] layers=naServer.GetNALayerNames
    (esriNAServerLayerType.esriNAServerRouteLayer);
serverContext.ReleaseContext();

• The ServerObjectConfigurationInfo class provides read-only access to some of the properties of a server object configuration.
• The ServerObjectTypeInfo class provides read-only access to some of the properties of a server object type.
• The ServerObjectExtensionTypeInfo class provides read-only access to some of the properties of an SOE type.
• A ServerDirectoryInfo object is an Info object that describes the properties of a server directory.

• Path—Physical path of the directory on disk.
• URL—Uniform resource locator (URL) of the virtual directory corresponding to the physical directory.
• Description—Description of the server directory.
• CleaningMode—Indicates whether the directory is cleaned by file age (esriSDCAbsolute), by last accessed (esriSDCSliding), or if its contents are not cleaned up (esriSDCNone).
• MaxFileAge—Indicates the maximum age or the maximum time since last accessed that files can be in the server directory before they are cleaned up.

Dim serverConn As IGISServerConnection=New GISServerConnection()
serverConn.Connect ("padisha")

Dim SOM As IServerObjectManager=serverConn.ServerObjectManager
Dim enumSDirInfo As IEnumServerDirectoryInfo=SOM.GetServerDirectoryInfos
Dim serverDirInfo As IServerDirectoryInfo=enumSDirInfo.Next()

Do Until serverDirInfo Is Nothing
    Debug.Print (serverDirInfo.Path)
    serverDirInfo=enumSDirInfo.Next()
Loop

IGISServerConnection serverConn=new GISServerConnection();
serverConn.Connect("padisha");

IServerObjectManager SOM=serverConn.ServerObjectManager;
IEnumServerDirectoryInfo enumSDirInfo=SOM.GetServerDirectoryInfos();
IServerDirectoryInfo serverDirInfo=enumSDirInfo.Next();

while (serverDirInfo != null)
{
    Debug.Print(serverDirInfo.Path);
    serverDirInfo=enumSDirInfo.Next();
}

• Name—Name of the server object configuration.
• TypeName—Type of server object configuration (for example, MapServer or GeocodeServer).
• Description—Description of the server object configuration.
• IsPooled—Indicates whether the server objects described by this configuration are pooled or nonpooled.

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect ("myServer")

Dim SOM As IServerObjectManager=gisServerConnection.ServerObjectManager
Dim enumSOCInfo As IEnumServerObjectConfigurationInfo=SOM.GetConfigurationInfos
Dim socInfo As IServerObjectConfigurationInfo=enumSOCInfo.Next()

Do Until socInfo Is Nothing
    Debug.Print (socInfo.Name & ": " & socInfo.TypeName)
    socInfo=(enumSOCInfo.Next)
Loop

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");

IServerObjectManager SOM=gisServerConnection.ServerObjectManager;
IEnumServerObjectConfigurationInfo enumSOCInfo=SOM.GetConfigurationInfos();
IServerObjectConfigurationInfo socInfo=enumSOCInfo.Next();

while (socInfo != null)
{
    Debug.Print(socInfo.Name + ": " + socInfo.TypeName);
    socInfo=(enumSOCInfo.Next());
}

• Name—Name of the server object type (for example, MapServer or GeocodeServer).
• Description—Description of the server object type.

• Name—Name of the SOE type (for example, NetworkAnalysis or OGCWebService).
• Description—Description of the SOE type.

Server administration objects

• Add and delete server object configurations.
• Update a server object configuration's properties.
• Start, stop, and pause server object configurations.
• Report the status of a server object configuration.
• Get all server object configurations and their properties.
• Get all server object types and their properties.
• Enable and disable SOEs for a server object.
• Add and remove SOE types.

• Enable and disable the server to suspend access from client applications.
• Start and stop the server.
• Add and remove server container machines.
• Get all server container machines.
• Add and remove server directories.
• Get all server directories.
• Get all SOE types.
• Add and remove SOE types.
• Configure the server's logging properties.
• Get a reference to the server's log.
• Get statistics about events in the server.
• Get information about the system on which the server is running.
• Enable and disable role-based security.
• Allow and deny roles access to operations on resources (folders and services).

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect ("myServer")
Dim serverObjectAdmin As IServerObjectAdmin=gisServerConnection.ServerObjectAdmin

' Create the new configuration.
Dim configuration As IServerObjectConfiguration=serverObjectAdmin.CreateConfiguration()
configuration.Name="California"
configuration.TypeName="GeocodeServer"

Dim propSet As IPropertySet=configuration.Properties
propSet.SetProperty ("LocatorWorkspacePath", "\\myServer\Geocoding\California")
propSet.SetProperty ("Locator", "California")
propSet.SetProperty ("SuggestedBatchSize", "500")

configuration.IsPooled=True
configuration.MinInstances=1
configuration.MaxInstances=1
configuration.WaitTimeout=10
configuration.UsageTimeout=120

' Add the configuration to the server.
serverObjectAdmin.AddConfiguration(configuration)

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");
IServerObjectAdmin serverObjectAdmin=gisServerConnection.ServerObjectAdmin;

// Create the new configuration.
IServerObjectConfiguration configuration=serverObjectAdmin.CreateConfiguration();
configuration.Name="California";
configuration.TypeName="GeocodeServer";

IPropertySet propSet=configuration.Properties;
propSet.SetProperty("LocatorWorkspacePath", "\\\\myServer\\Geocoding\\California");
propSet.SetProperty("Locator", "California");
propSet.SetProperty("SuggestedBatchSize", "500");

configuration.IsPooled=true;
configuration.MinInstances=1;
configuration.MaxInstances=1;
configuration.WaitTimeout=10;
configuration.UsageTimeout=120;

// Add the configuration to the server.
serverObjectAdmin.AddConfiguration(configuration);

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect("myServer")

Dim serverObjectAdmin As IServerObjectAdmin=gisServerConnection.ServerObjectAdmin
Dim serverConfig As IServerObjectConfiguration=serverObjectAdmin.GetConfiguration("RedlandsMap", "MapServer")
serverConfig.MinInstances=3
serverObjectAdmin.UpdateConfiguration(serverConfig)

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");

IServerObjectAdmin serverObjectAdmin=gisServerConnection.ServerObjectAdmin;
IServerObjectConfiguration serverConfig=serverObjectAdmin.GetConfiguration(
    "RedlandsMap", "MapServer");
serverConfig.MinInstances=3;
serverObjectAdmin.UpdateConfiguration(serverConfig);

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect("myServer")

Dim serverObjectAdmin As IServerObjectAdmin=gisServerConnection.ServerObjectAdmin
serverObjectAdmin.StopConfiguration("RedlandsMap", "MapServer")
serverObjectAdmin.DeleteConfiguration("RedlandsMap", "MapServer")

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");

IServerObjectAdmin serverObjectAdmin=gisServerConnection.ServerObjectAdmin;
serverObjectAdmin.StopConfiguration("RedlandsMap", "MapServer");
serverObjectAdmin.DeleteConfiguration("RedlandsMap", "MapServer");

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect ("myServer")

Dim serverObjectAdmin As IServerObjectAdmin=gisServerConnection.ServerObjectAdmin
Dim enumSOC As IEnumServerObjectConfiguration=serverObjectAdmin.GetConfigurations()
Dim SOC As IServerObjectConfiguration=enumSOC.Next()

Do Until SOC Is Nothing
    Debug.Print (SOC.Name & ": " & SOC.TypeName)
    SOC=enumSOC.Next()
Loop

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");

IServerObjectAdmin serverObjectAdmin=gisServerConnection.ServerObjectAdmin;
IEnumServerObjectConfiguration enumSOC=serverObjectAdmin.GetConfigurations();
IServerObjectConfiguration SOC=enumSOC.Next();

while (SOC != null)
{
    Debug.Print(SOC.Name + ": " + SOC.TypeName);
    SOC=enumSOC.Next();
}

• Properties
• RecycleProperties
• MinInstances
• MaxInstances
• IsolationLevel
• StartupType
• WaitTimeout
• UsageTimeout

• Name
• TypeName
• Description
• IsPooled
• Extensions

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect("myServer")
Dim serverObjectAdmin As IServerObjectAdmin=gisServerConnection.ServerObjectAdmin

' Create the new configuration.
Dim configuration As IServerObjectConfiguration=serverObjectAdmin.CreateConfiguration()
configuration.Name="California"
configuration.TypeName="GeocodeServer"

Dim propSet As IPropertySet=configuration.Properties
propSet.SetProperty("LocatorWorkspacePath", "\\myServer\Geocoding\California")
propSet.SetProperty("Locator", "California")
propSet.SetProperty("SuggestedBatchSize", "500")

configuration.IsPooled=True
configuration.MinInstances=1
configuration.MaxInstances=1
configuration.WaitTimeout=10
configuration.UsageTimeout=120

' Add the configuration to the server.
serverObjectAdmin.AddConfiguration(configuration)

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");
IServerObjectAdmin serverObjectAdmin=gisServerConnection.ServerObjectAdmin;

// Create the new configuration.
IServerObjectConfiguration configuration=serverObjectAdmin.CreateConfiguration();
configuration.Name="California";
configuration.TypeName="GeocodeServer";

IPropertySet propSet=configuration.Properties;
propSet.SetProperty("LocatorWorkspacePath", "\\\\myServer\\Geocoding\\California");
propSet.SetProperty("Locator", "California");
propSet.SetProperty("SuggestedBatchSize", "500");

configuration.IsPooled=true;
configuration.MinInstances=1;
configuration.MaxInstances=1;
configuration.WaitTimeout=10;
configuration.UsageTimeout=120;

// Add the configuration to the server.
serverObjectAdmin.AddConfiguration(configuration);

• A–Z
• a–z
• 0–9
• _ (underscore)
• – (minus)

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect("myServer")
Dim serverObjectAdmin As IServerObjectAdmin=gisServerConnection.ServerObjectAdmin

' Create the new configuration.
Dim configuration As IServerObjectConfiguration=serverObjectAdmin.CreateConfiguration()
configuration.Name="California"
configuration.TypeName="GeocodeServer"

Dim propSet As IPropertySet=configuration.Properties
propSet.SetProperty("LocatorWorkspacePath", "\\myServer\Geocoding\California")
propSet.SetProperty("Locator", "California")
propSet.SetProperty("SuggestedBatchSize", "500")

configuration.IsPooled=True
configuration.MinInstances=1
configuration.MaxInstances=1
Dim recProps As IPropertySet=configuration.RecycleProperties
recProps.SetProperty("StartTime", "00:00")
recProps.SetProperty("Interval", "3600")

' Add the configuration to the server.
serverObjectAdmin.AddConfiguration(configuration)

' Start the configuration.
serverObjectAdmin.StartConfiguration(configuration.Name, configuration.TypeName)

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");
IServerObjectAdmin serverObjectAdmin=gisServerConnection.ServerObjectAdmin;

// Create the new configuration.
IServerObjectConfiguration configuration=serverObjectAdmin.CreateConfiguration();
configuration.Name="California";
configuration.TypeName="GeocodeServer";

IPropertySet propSet=configuration.Properties;
propSet.SetProperty("LocatorWorkspacePath", "\\myServer\\Geocoding\\California");
propSet.SetProperty("Locator", "California");
propSet.SetProperty("SuggestedBatchSize", "500");

configuration.IsPooled=true;
configuration.MinInstances=1;
configuration.MaxInstances=1;
IPropertySet recProps=configuration.RecycleProperties;
recProps.SetProperty("StartTime", "00:00");
recProps.SetProperty("Interval", "3600");

// Add the configuration to the server.
serverObjectAdmin.AddConfiguration(configuration);

// Start the configuration.
serverObjectAdmin.StartConfiguration(configuration.Name, configuration.TypeName);

• StartTime—The time at which the recycling interval is initialized. The time specified is in 24-hour notation. For example, to set the start time at 2:00 p.m., the StartTime property is 14:00. This property is of type esriStartupType.
• Interval—The time between recycling operations in seconds. For example, to recycle the configuration every hour, set this property to 3600.

• StartupTimeout—The maximum time (in seconds) the server allows for an instance of the server object to start.
• CleanupTimeout—The maximum time (in seconds) the server allows for an instance of the server object to shut down.

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect ("myServer")

Dim serverObjectAdmin As IServerObjectAdmin=gisServerConnection.ServerObjectAdmin
Dim serverMachine As IServerMachine=serverObjectAdmin.CreateMachine()
serverMachine.Name="callum"

Dim serverMachine2 As IServerMachine2=TryCast(serverMachine, IServerMachine2)
serverMachine2.Capacity=20

serverObjectAdmin.AddMachine (serverMachine)

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");

IServerObjectAdmin serverObjectAdmin=gisServerConnection.ServerObjectAdmin;
IServerMachine serverMachine=serverObjectAdmin.CreateMachine();
serverMachine.Name="callum";

IServerMachine2 serverMachine2=serverMachine as IServerMachine2;
serverMachine2.Capacity=20;

serverObjectAdmin.AddMachine(serverMachine);

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect ("myServer")

Dim serverObjectAdmin As IServerObjectAdmin=gisServerConnection.ServerObjectAdmin
Dim serverDir As IServerDirectory=serverObjectAdmin.CreateServerDirectory()

serverDir.CleaningMode=esriServerDirectoryCleaningMode.esriSDCAbsolute
serverDir.Description="Default output directory"
serverDir.Path="\\myServer\serveroutput"
serverDir.URL="http://myServer/serveroutput"
serverDir.MaxFileAge=100

serverObjectAdmin.AddServerDirectory (serverDir)

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");

IServerObjectAdmin serverObjectAdmin=gisServerConnection.ServerObjectAdmin;
IServerDirectory serverDir=serverObjectAdmin.CreateServerDirectory();

serverDir.CleaningMode=esriServerDirectoryCleaningMode.esriSDCAbsolute;
serverDir.Description="Default output directory";
serverDir.Path="\\myServer\\serveroutput";
serverDir.URL="http://myServer/serveroutput";
serverDir.MaxFileAge=100;

serverObjectAdmin.AddServerDirectory(serverDir);

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect ("padisha")

Dim serverObjectAdmin As IServerObjectAdmin=gisServerConnection.ServerObjectAdmin
Dim serverDir As IServerDirectory=serverObjectAdmin.GetServerDirectory("\\myServer\serveroutput")

serverDir.MaxFileAge=200
serverObjectAdmin.UpdateServerDirectory (serverDir)

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("padisha");

IServerObjectAdmin serverObjectAdmin=gisServerConnection.ServerObjectAdmin;
IServerDirectory serverDir=serverObjectAdmin.GetServerDirectory(
    "\\myServer\\serveroutput");

serverDir.MaxFileAge=200;
serverObjectAdmin.UpdateServerDirectory(serverDir);

• LogPath—The path to the location on disk to which log files are written. By default, the LogPath is \log.
• LogSize—The size to which a single log file can grow (in MB) before a new log file is created. By default, the LogSize is 10.
• LogLevel—A number between 0 and 5 that indicates the level of detail that the server logs. By default, the LogLevel is 3. The following is a description of each log level:
  • 0 (None)—No logging
  • 1 (Error)—Serious problems that require immediate attention
  • 2 (Warning)—Problems that require attention
  • 3 (Normal)—Common administrative messages of the server
  • 4 (Detailed)—Common messages from user use of the server, including server objects
  • 5 (Debug)—Verbose messages to aid in troubleshooting

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect ("myServer")

Dim serverObjectAdmin As IServerObjectAdmin=gisServerConnection.ServerObjectAdmin
Dim logProps As IPropertySet=serverObjectAdmin.Properties

logProps.SetProperty ("LogPath", "c:\ServerLogs")
logProps.SetProperty ("LogLevel", 5)

serverObjectAdmin.Properties=logProps

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");

IServerObjectAdmin serverObjectAdmin=gisServerConnection.ServerObjectAdmin;
IPropertySet logProps=serverObjectAdmin.Properties;

logProps.SetProperty("LogPath", "c:\\ServerLogs");
logProps.SetProperty("LogLevel", 5);

serverObjectAdmin.Properties=logProps;

• esriSSFCount
• esriSSFMinimum
• esriSSFMaximum
• esriSSFSum
• esriSSFSumSquares
• esriSSFMean
• esriSSFStandardDeviation

• By second for the current minute
• By minute for the current hour
• By hour for the current day
• By day for events that happened previous to the current day

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect ("myServer")

Dim serverStats As IServerStatistics=TryCast(gisServerConnection.ServerObjectAdmin, IServerStatistics)
Dim statsRes As IStatisticsResults=serverStats.GetAllStatisticsForTimeInterval(esriServerStatEvent.esriSSEContextCreated, _
                                     esriServerTimePeriod.esriSTPNone, 0, 1, String.Empty, String.Empty, String.Empty)
Dim serverTR As IServerTimeRange=TryCast(statsRes, IServerTimeRange)

Debug.Print (statsRes.Count & ": " & serverTR.StartTime & " to " & serverTR.EndTime)

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");

IServerStatistics serverStats=gisServerConnection.ServerObjectAdmin as
    IServerStatistics;
IStatisticsResults statsRes=serverStats.GetAllStatisticsForTimeInterval
    (esriServerStatEvent.esriSSEContextCreated, esriServerTimePeriod.esriSTPNone, 0,
    1, string.Empty, string.Empty, string.Empty);

IServerTimeRange serverTR=statsRes as IServerTimeRange;
Debug.Print(statsRes.Count + ": " + serverTR.StartTime + " to " + serverTR.EndTime);

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect ("myServer")

Dim serverStats As IServerStatistics=TryCast(gisServerConnection.ServerObjectAdmin, IServerStatistics)
Dim statsRes As IStatisticsResults=serverStats.GetAllStatisticsForTimeInterval(esriServerStatEvent.esriSSEContextCreated, _
                                     esriServerTimePeriod.esriSTPHour, 0, 2, String.Empty, String.Empty, String.Empty)
Dim serverTR As IServerTimeRange=TryCast(statsRes, IServerTimeRange)

Debug.Print (statsRes.Count & ": " & serverTR.StartTime & " to " & serverTR.EndTime)

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");

IServerStatistics serverStats=gisServerConnection.ServerObjectAdmin as
    IServerStatistics;
IStatisticsResults statsRes=serverStats.GetAllStatisticsForTimeInterval
    (esriServerStatEvent.esriSSEContextCreated, esriServerTimePeriod.esriSTPHour, 0,
    2, string.Empty, string.Empty, string.Empty);
IServerTimeRange serverTR=statsRes as IServerTimeRange;

Debug.Print(statsRes.Count + ": " + serverTR.StartTime + " to " + serverTR.EndTime);

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect ("myServer")

Dim serverStats As IServerStatistics=TryCast(gisServerConnection.ServerObjectAdmin, IServerStatistics)
Dim statsRes As IStatisticsResults=serverStats.GetAllStatisticsForTimeInterval(esriServerStatEvent.esriSSEContextCreated, esriServerTimePeriod.esriSTPNone, 0, 1, "Yellowstone", "MapServer", String.Empty)
Dim serverTR As IServerTimeRange=TryCast(statsRes, IServerTimeRange)

Debug.Print (statsRes.Count & ": " & serverTR.StartTime & " to " & serverTR.EndTime)

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");

IServerStatistics serverStats=gisServerConnection.ServerObjectAdmin as
    IServerStatistics;
IStatisticsResults statsRes=serverStats.GetAllStatisticsForTimeInterval
    (esriServerStatEvent.esriSSEContextCreated, esriServerTimePeriod.esriSTPNone, 0,
    1, "Yellowstone", "MapServer", string.Empty);
IServerTimeRange serverTR=statsRes as IServerTimeRange;

Debug.Print(statsRes.Count + ": " + serverTR.StartTime + " to " + serverTR.EndTime);

Dim gisServerConnection As IGISServerConnection=New GISServerConnection()
gisServerConnection.Connect("myServer")
Dim serverStats As IServerStatistics=TryCast(gisServerConnection.ServerObjectAdmin, IServerStatistics)
Dim dr As IDoubleArray=serverStats.GetSpecificStatisticForTimeIntervals(esriServerStatEvent.esriSSEContextCreated, esriServerStatFunction.esriSSFCount, esriServerTimePeriod.esriSTPMinute, 0, 60, String.Empty, String.Empty, String.Empty)
Dim i As Integer
For i=0 To dr.Count - 1
    Debug.Print(dr.Element(i).ToString)
Next i

IGISServerConnection gisServerConnection=new GISServerConnection();
gisServerConnection.Connect("myServer");
IServerStatistics serverStats=gisServerConnection.ServerObjectAdmin as
    IServerStatistics;
IDoubleArray dr=serverStats.GetSpecificStatisticForTimeIntervals
    (esriServerStatEvent.esriSSEContextCreated, esriServerStatFunction.esriSSFCount,
    esriServerTimePeriod.esriSTPMinute, 0, 60, string.Empty, string.Empty,
    string.Empty);
int i=0;
for (i=0; i < dr.Count; i++)
{
    Debug.Print(dr.get_Element(i).ToString());
}

Server object extension objects

• You don't need to explicitly create instances of an SOE in a context. The SOE is created by the GIS server when the server object instance itself is created.
• If the functionality that is exposed by the extension requires resources that can be costly to acquire, the initialization cost of creating the object is paid once when the server object and its extensions are created.
• If the functionality that is exposed by the extension can benefit from some caching logic, it's possible to implement such logic because the cache remains for as long as the server object instance itself remains in the pool.
• The ArcGIS for Server administration applications can be extended to include custom properties dialog boxes for configuring custom extensions for specific server object configurations.

1. Create a COM object that implements IServerObjectExtension and includes any additional custom interfaces and methods. Optionally, implement IObjectConstruct, ILogSupport, and IObjectActivate.
2. Optionally, create a COM object that implements IAGSSOEParameterPage and IComPropertyPage that includes a user form that encapsulates any initialization properties that must be configured for the extension.
3. Register the server extension COM object created in Step 1 on each container machine, the SOM machine, and any client machine (that is, Web servers or ArcGIS for Desktop machines that administer the GIS server).
4. Register the SOE with the GIS server (using the AddExtensionType method on IServerObjectAdmin2).
5. Optionally, register the property page created in Step 2 in the AGS Extension Parameter Pages component category on each ArcGIS for Desktop client machine.
6. Create a server object configuration that includes the SOE.
7. Create your application that consumes the server object and its extension.

Private m_SOH As IServerObjectHelper

Public Sub Init(ByVal SOH As IServerObjectHelper)
    m_SOH=SOH
End Sub

Public Sub Shutdown()
    m_SOH=Nothing
End Sub

private IServerObjectHelper m_SOH;

public void Init(IServerObjectHelper SOH)
{
    m_SOH=SOH;
}

public void Shutdown()
{
    m_SOH=null;
}

Dim mapsrv As IMapServer=TryCast(m_SOH.ServerObject, IMapServer)

IMapServer mapsrv=m_SOH.ServerObject as IMapServer;

Private m_log As ILog

Public Sub InitLogging(ByVal Log As ILog)
    m_log=Log
End Sub

private ILog m_log;
public void InitLogging(ILog log)
{
    m_log=log;
}

m_log.AddMessage(3, 8000, "This is a normal level log message.")
m_log.AddMessage(1, 8000, "This is an error level log message.")

m_log.AddMessage(3, 8000, "This is a normal level log message.");
m_log.AddMessage(1, 8000, "This is an error level log message.");

Dim conn As IGISServerConnection=New GISServerConnectionClass()
conn.Connect("your_server")

Dim SOA2 As IServerObjectAdmin2=TryCast(conn.ServerObjectAdmin, IServerObjectAdmin2)
Dim serverObjExtensionType As IServerObjectExtensionType=SOA2.CreateExtensionType()

serverObjExtensionType.CLSID="vegSOE.vegUtilSOE"
serverObjExtensionType.Description="test server obj extension"
serverObjExtensionType.Name="VegUtilitiesExtension"
SOA2.AddExtensionType("MapServer", serverObjExtensionType)

IGISServerConnection conn=new GISServerConnectionClass();
conn.Connect("your_server");

IServerObjectAdmin2 SOA2=conn.ServerObjectAdmin as IServerObjectAdmin2;
IServerObjectExtensionType serverObjExtensionType=SOA2.CreateExtensionType();

serverObjExtensionType.CLSID="vegSOE.vegUtilSOE";
serverObjExtensionType.Description="test server obj extension";
serverObjExtensionType.Name="VegUtilitiesExtension";
SOA2.AddExtensionType("MapServer", serverObjExtensionType);

Dim serverConn As IGISServerConnection=New GISServerConnectionClass()
serverConn.Connect("your_server")

Dim soa As IServerObjectAdmin=serverConn.ServerObjectAdmin
Dim soc As IServerObjectConfiguration2=TryCast(soa.GetConfiguration("Yellowstone", "MapServer"), IServerObjectConfiguration2)
soa.StopConfiguration("Yellowstone", "MapServer")
soc.ExtensionEnabled("AreaSumExtension")=True

Dim props As IPropertySet=soc.ExtensionProperties("AreaSumExtension")
props.SetProperty("LayerName", "Veg")

soa.UpdateConfiguration(soc)
soa.StartConfiguration("Yellowstone", "MapServer")

IGISServerConnection serverConn=new GISServerConnectionClass();
serverConn.Connect("your_server");

IServerObjectAdmin soa=serverConn.ServerObjectAdmin;
IServerObjectConfiguration2 soc=soa.GetConfiguration("Yellowstone", "MapServer")as
    IServerObjectConfiguration2;
soa.StopConfiguration("Yellowstone", "MapServer");
soc.set_ExtensionEnabled("AreaSumExtension", true);

IPropertySet props=soc.get_ExtensionProperties("AreaSumExtension");
props.SetProperty("LayerName", "Veg");

soa.UpdateConfiguration(soc);
soa.StartConfiguration("Yellowstone", "MapServer");

string userName=null;
string roles=null;

// Set a reference to GUID for esriServer.IServerEnvironment2.
UID uid=new UIDClass();
uid.Value="32D4C328-E473-4615-922C-63C108F55E60";

// CoCreate an EnvironmentManager and retrieve the IServerEnvironment.
IEnvironmentManager environmentManager=new EnvironmentManager()as
    IEnvironmentManager;
IServerEnvironment2 serverEnvironment=environmentManager.getEnvironment(uid);

// Get UserInfo.
IServerUserInfo userInfo=serverEnvironment.UserInfo;
userName=userInfo.Name;
roles=userInfo.Roles;