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
Returns
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
Returns
Connect(string, string)
Connects to an image server given host name and port.
bool Connect(string serverHost, string serverPort)
Parameters
Returns
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
Returns
GetServerConfiguration()
Obtains the current configuration of the image server service as an XML string. The XML is defined by ISSConfig.xsd.
string GetServerConfiguration()
Returns
GetServerInfo()
Obtains server information containing the list of all image service providers and image services as an XML string.
string GetServerInfo()
Returns
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
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
servicePathstring
Returns
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
ispNamestring
Returns
GetStatus()
Gets the status XML details for any failure.
string GetStatus()
Returns
RefreshAllServices(ref bool)
Reloads all the services.
void RefreshAllServices(ref bool retStatus)
Parameters
retStatusbool
RefreshService(string)
Reloads the given service.
bool RefreshService(string serviceName)
Parameters
serviceNamestring
Returns
RegisterToSOM(string, string, string)
Registers the server to a given ArcGIS Server Object Manager SOM.
bool RegisterToSOM(string SOMHost, string serverHost, string serverPort)
Parameters
Returns
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
Returns
RemoveServiceProvider(string)
Removes the specified image service provider.
bool RemoveServiceProvider(string ispName)
Parameters
ispNamestring
Returns
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
serverHoststring
Returns
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
serviceNamestring
Returns
StartServiceProvider(string)
Starts the specified image service provider using either the default or the last saved configuration.
bool StartServiceProvider(string ispName)
Parameters
ispNamestring
Returns
StopServer()
Stops the image server service. Can be invoked only after connecting to the image server.
bool StopServer()
Returns
StopService(string)
Stops an image service on the image service providers specified when the service was added.
bool StopService(string serviceName)
Parameters
serviceNamestring
Returns
StopServiceProvider(string)
Stops the specified image service provider.
bool StopServiceProvider(string ispName)
Parameters
ispNamestring
Returns
UpdateServerConfiguration(string)
Updates configuration of the image server using the specified XML. The XML is defined by ISSConfig.xsd.
bool UpdateServerConfiguration(string serverConfigXml)
Parameters
serverConfigXmlstring
Returns
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
serviceConfigXmlstring
Returns
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)