Interface IAISImageServerManager

Namespace
ESRI.ArcGIS.DatasourcesRaster
Assembly
ESRI.Server.DatasourcesRaster.dll

Server Manager Interface

[Guid("386959AF-5544-4846-BA4B-934E1408008B")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IAISImageServerManager

Methods

AddService(string, string, string, ref string[])

Adds an image service to the specified image service providers. Pass an empty array to indicate all available image service providers known by the server. Service name and service properties are optional.

bool AddService(string servicePath, string serviceName, string ServiceProperties, ref string[] ispNames)

Parameters

servicePath string
serviceName string
ServiceProperties string
ispNames string[]

Returns

bool

AddServiceProvider(string, string, string)

Add a new image service provider using the specified friendly name on the specified host machine and port.

bool AddServiceProvider(string ispName, string ispHostMachine, string ispHostPort)

Parameters

ispName string
ispHostMachine string
ispHostPort string

Returns

bool

Connect(string, string)

Connects to an image server given host name and port.

bool Connect(string serverHost, string serverPort)

Parameters

serverHost string
serverPort string

Returns

bool

GetSOMRegisteredServer(string, out string, out string)

Gets the server registered to a given host.

bool GetSOMRegisteredServer(string SOMHost, out string serverHost, out string serverPort)

Parameters

SOMHost string
serverHost string
serverPort string

Returns

bool

GetServerConfiguration()

Obtains the current configuration of the image server service as an XML string. The XML is defined by ISSConfig.xsd.

string GetServerConfiguration()

Returns

string

GetServerInfo()

Obtains server information containing the list of all image service providers and image services as an XML string.

string GetServerInfo()

Returns

string

GetServiceConfiguration()

Obtains current configuration of all image services hosted by the image server as an XML string. The XML is defined by ISServices.xsd.

string GetServiceConfiguration()

Returns

string

GetServiceDefinitionName(string)

Gets the service name of the image service, given the path to compiled service. Returns an empty string if the service was never published or has not been started.

string GetServiceDefinitionName(string servicePath)

Parameters

servicePath string

Returns

string

GetServiceProviderConfiguration(string)

Obtains the current configuration of the specified image service provider as an XML string defined by ISPConfig.xsd

string GetServiceProviderConfiguration(string ispName)

Parameters

ispName string

Returns

string

GetStatus()

Gets the status XML details for any failure.

string GetStatus()

Returns

string

RefreshAllServices(ref bool)

Reloads all the services.

void RefreshAllServices(ref bool retStatus)

Parameters

retStatus bool

RefreshService(string)

Reloads the given service.

bool RefreshService(string serviceName)

Parameters

serviceName string

Returns

bool

RegisterToSOM(string, string, string)

Registers the server to a given ArcGIS Server Object Manager SOM.

bool RegisterToSOM(string SOMHost, string serverHost, string serverPort)

Parameters

SOMHost string
serverHost string
serverPort string

Returns

bool

RemoveService(string, ref string[])

Removes an image service from specified image service providers. Pass an empty array to indicate all available image service providers known by the server. ServiceName is optional.

bool RemoveService(string serviceName, ref string[] ispNames)

Parameters

serviceName string
ispNames string[]

Returns

bool

RemoveServiceProvider(string)

Removes the specified image service provider.

bool RemoveServiceProvider(string ispName)

Parameters

ispName string

Returns

bool

StartServer(string)

Starts the image server service on the specified host machine using the default port or the last saved configuration on the host machine.

bool StartServer(string serverHost)

Parameters

serverHost string

Returns

bool

StartService(string)

Publishes the specified compiled service definition file as an image service on the image service providers specified when the service was added.

bool StartService(string serviceName)

Parameters

serviceName string

Returns

bool

StartServiceProvider(string)

Starts the specified image service provider using either the default or the last saved configuration.

bool StartServiceProvider(string ispName)

Parameters

ispName string

Returns

bool

StopServer()

Stops the image server service. Can be invoked only after connecting to the image server.

bool StopServer()

Returns

bool

StopService(string)

Stops an image service on the image service providers specified when the service was added.

bool StopService(string serviceName)

Parameters

serviceName string

Returns

bool

StopServiceProvider(string)

Stops the specified image service provider.

bool StopServiceProvider(string ispName)

Parameters

ispName string

Returns

bool

UpdateServerConfiguration(string)

Updates configuration of the image server using the specified XML. The XML is defined by ISSConfig.xsd.

bool UpdateServerConfiguration(string serverConfigXml)

Parameters

serverConfigXml string

Returns

bool

UpdateServiceConfiguration(string)

Updates configuration of the image server pertaining all image services using the specified XML string. The XML is defined by ISServices.xsd.

bool UpdateServiceConfiguration(string serviceConfigXml)

Parameters

serviceConfigXml string

Returns

bool

UpdateServiceProviderConfiguration(string, string)

Updates configuration of an image service provider using the specifed XML. The XML is defined by ISPConfig.xsd

bool UpdateServiceProviderConfiguration(string ispName, string ispConfigXml)

Parameters

ispName string
ispConfigXml string

Returns

bool