IAISImageServerManager Interface

Server Manager Interface

Members

	Name	Description
	AddService	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.
	AddServiceProvider	Add a new image service provider using the specified friendly name on the specified host machine and port.
	Connect	Connects to an image server given host name and port.
	GetServerConfiguration	Obtains the current configuration of the image server service as an XML string. The XML is defined by ISSConfig.xsd.
	GetServerInfo	Obtains server information containing the list of all image service providers and image services as an XML 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.
	GetServiceDefinitionName	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.
	GetServiceProviderConfiguration	Obtains the current configuration of the specified image service provider as an XML string defined by ISPConfig.xsd
	GetSOMRegisteredServer	Gets the server registered to a given host.
	GetStatus	Gets the status XML details for any failure.
	RefreshAllServices	Reloads all the services.
	RefreshService	Reloads the given service.
	RegisterToSOM	Registers the server to a given ArcGIS Server Object Manager SOM.
	RemoveService	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.
	RemoveServiceProvider	Removes the specified image service provider.
	StartServer	Starts the image server service on the specified host machine using the default port or the last saved configuration on the host machine.
	StartService	Publishes the specified compiled service definition file as an image service on the image service providers specified when the service was added.
	StartServiceProvider	Starts the specified image service provider using either the default or the last saved configuration.
	StopServer	Stops the image server service. Can be invoked only after connecting to the image server.
	StopService	Stops an image service on the image service providers specified when the service was added.
	StopServiceProvider	Stops the specified image service provider.
	UpdateServerConfiguration	Updates configuration of the image server using the specified XML. The XML is defined by ISSConfig.xsd.
	UpdateServiceConfiguration	Updates configuration of the image server pertaining all image services using the specified XML string. The XML is defined by ISServices.xsd.
	UpdateServiceProviderConfiguration	Updates configuration of an image service provider using the specifed XML. The XML is defined by ISPConfig.xsd

IAISImageServerManager.AddService Method

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.

Public Function AddService ( _
    ByVal servicePath As String, _
    ByVal serviceName As String, _
    ByVal ServiceProperties As String, _
    ByRef ispNames As String[]& _
) As Boolean

public bool AddService (
    string servicePath,
    string serviceName,
    string ServiceProperties,
    ref String[]& ispNames
);

IAISImageServerManager.AddServiceProvider Method

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

Public Function AddServiceProvider ( _
    ByVal ispName As String, _
    ByVal ispHostMachine As String, _
    ByVal ispHostPort As String _
) As Boolean

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

IAISImageServerManager.Connect Method

Connects to an image server given host name and port.

Public Function Connect ( _
    ByVal serverHost As String, _
    ByVal serverPort As String _
) As Boolean

public bool Connect (
    string serverHost,
    string serverPort
);

IAISImageServerManager.GetServerConfiguration Method

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

Public Function GetServerConfiguration ( _
) As String

public string GetServerConfiguration (
);

IAISImageServerManager.GetServerInfo Method

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

Public Function GetServerInfo ( _
) As String

public string GetServerInfo (
);

IAISImageServerManager.GetServiceConfiguration Method

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

Public Function GetServiceConfiguration ( _
) As String

public string GetServiceConfiguration (
);

IAISImageServerManager.GetServiceDefinitionName Method

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.

Public Function GetServiceDefinitionName ( _
    ByVal servicePath As String _
) As String

public string GetServiceDefinitionName (
    string servicePath
);

IAISImageServerManager.GetServiceProviderConfiguration Method

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

Public Function GetServiceProviderConfiguration ( _
    ByVal ispName As String _
) As String

public string GetServiceProviderConfiguration (
    string ispName
);

IAISImageServerManager.GetSOMRegisteredServer Method

Gets the server registered to a given host.

Public Function GetSOMRegisteredServer ( _
    ByVal SOMHost As String, _
    ByRef serverHost As String, _
    ByRef serverPort As String _
) As Boolean

public bool GetSOMRegisteredServer (
    string SOMHost,
    ref string serverHost,
    ref string serverPort
);

IAISImageServerManager.GetStatus Method

Gets the status XML details for any failure.

Public Function GetStatus ( _
) As String

public string GetStatus (
);

IAISImageServerManager.RefreshAllServices Method

Reloads all the services.

Public Sub RefreshAllServices ( _
    ByRef retStatus As Boolean _
)

public void RefreshAllServices (
    ref bool retStatus
);

IAISImageServerManager.RefreshService Method

Reloads the given service.

Public Function RefreshService ( _
    ByVal serviceName As String _
) As Boolean

public bool RefreshService (
    string serviceName
);

IAISImageServerManager.RegisterToSOM Method

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

Public Function RegisterToSOM ( _
    ByVal SOMHost As String, _
    ByVal serverHost As String, _
    ByVal serverPort As String _
) As Boolean

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

IAISImageServerManager.RemoveService Method

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.

Public Function RemoveService ( _
    ByVal serviceName As String, _
    ByRef ispNames As String[]& _
) As Boolean

public bool RemoveService (
    string serviceName,
    ref String[]& ispNames
);

IAISImageServerManager.RemoveServiceProvider Method

Removes the specified image service provider.

Public Function RemoveServiceProvider ( _
    ByVal ispName As String _
) As Boolean

public bool RemoveServiceProvider (
    string ispName
);

IAISImageServerManager.StartServer Method

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

Public Function StartServer ( _
    ByVal serverHost As String _
) As Boolean

public bool StartServer (
    string serverHost
);

IAISImageServerManager.StartService Method

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

Public Function StartService ( _
    ByVal serviceName As String _
) As Boolean

public bool StartService (
    string serviceName
);

IAISImageServerManager.StartServiceProvider Method

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

Public Function StartServiceProvider ( _
    ByVal ispName As String _
) As Boolean

public bool StartServiceProvider (
    string ispName
);

IAISImageServerManager.StopServer Method

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

Public Function StopServer ( _
) As Boolean

public bool StopServer (
);

IAISImageServerManager.StopService Method

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

Public Function StopService ( _
    ByVal serviceName As String _
) As Boolean

public bool StopService (
    string serviceName
);

IAISImageServerManager.StopServiceProvider Method

Stops the specified image service provider.

Public Function StopServiceProvider ( _
    ByVal ispName As String _
) As Boolean

public bool StopServiceProvider (
    string ispName
);

IAISImageServerManager.UpdateServerConfiguration Method

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

Public Function UpdateServerConfiguration ( _
    ByVal serverConfigXml As String _
) As Boolean

public bool UpdateServerConfiguration (
    string serverConfigXml
);

IAISImageServerManager.UpdateServiceConfiguration Method

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

Public Function UpdateServiceConfiguration ( _
    ByVal serviceConfigXml As String _
) As Boolean

public bool UpdateServiceConfiguration (
    string serviceConfigXml
);

IAISImageServerManager.UpdateServiceProviderConfiguration Method

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

Public Function UpdateServiceProviderConfiguration ( _
    ByVal ispName As String, _
    ByVal ispConfigXml As String _
) As Boolean

public bool UpdateServiceProviderConfiguration (
    string ispName,
    string ispConfigXml
);

Classes that implement IAISImageServerManager

Classes	Description
AISImageServerManager	Image Server Manager CoClass