com.esri.arcgis.datasourcesraster

Interface IAISImageServerManager

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AISImageServerManager, IAISImageServerManagerProxy

public interface IAISImageServerManager
extends java.io.Serializable

COM Interface 'IAISImageServerManager'. Generated 9/24/2024 11:01:31 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Server Manager Interface' 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID386959af_5544_4846_ba4b_934e1408008b
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
boolean	addService(java.lang.String servicePath, java.lang.String serviceName, java.lang.String serviceProperties, java.lang.String[] ispNames) Adds an image service to the specified image service providers.
boolean	addServiceProvider(java.lang.String ispName, java.lang.String ispHostMachine, java.lang.String ispHostPort) Add a new image service provider using the specified friendly name on the specified host machine and port.
boolean	connect(java.lang.String serverHost, java.lang.String serverPort) Connects to an image server given host name and port.
java.lang.String	getServerConfiguration() Obtains the current configuration of the image server service as an XML string.
java.lang.String	getServerInfo() Obtains server information containing the list of all image service providers and image services as an XML string.
java.lang.String	getServiceConfiguration() Obtains current configuration of all image services hosted by the image server as an XML string.
java.lang.String	getServiceDefinitionName(java.lang.String servicePath) Gets the service name of the image service, given the path to compiled service.
java.lang.String	getServiceProviderConfiguration(java.lang.String ispName) Obtains the current configuration of the specified image service provider as an XML string defined by ISPConfig.xsd
boolean	getSOMRegisteredServer(java.lang.String sOMHost, java.lang.String[] serverHost, java.lang.String[] serverPort) Gets the server registered to a given host.
java.lang.String	getStatus() Gets the status XML details for any failure.
void	refreshAllServices(boolean[] retStatus) Reloads all the services.
boolean	refreshService(java.lang.String serviceName) Reloads the given service.
boolean	registerToSOM(java.lang.String sOMHost, java.lang.String serverHost, java.lang.String serverPort) Registers the server to a given ArcGIS Server Object Manager SOM.
boolean	removeService(java.lang.String serviceName, java.lang.String[] ispNames) Removes an image service from specified image service providers.
boolean	removeServiceProvider(java.lang.String ispName) Removes the specified image service provider.
boolean	startServer(java.lang.String serverHost) Starts the image server service on the specified host machine using the default port or the last saved configuration on the host machine.
boolean	startService(java.lang.String serviceName) Publishes the specified compiled service definition file as an image service on the image service providers specified when the service was added.
boolean	startServiceProvider(java.lang.String ispName) Starts the specified image service provider using either the default or the last saved configuration.
boolean	stopServer() Stops the image server service.
boolean	stopService(java.lang.String serviceName) Stops an image service on the image service providers specified when the service was added.
boolean	stopServiceProvider(java.lang.String ispName) Stops the specified image service provider.
boolean	updateServerConfiguration(java.lang.String serverConfigXml) Updates configuration of the image server using the specified XML.
boolean	updateServiceConfiguration(java.lang.String serviceConfigXml) Updates configuration of the image server pertaining all image services using the specified XML string.
boolean	updateServiceProviderConfiguration(java.lang.String ispName, java.lang.String ispConfigXml) Updates configuration of an image service provider using the specifed XML.

Field Detail

IID386959af_5544_4846_ba4b_934e1408008b

static final int IID386959af_5544_4846_ba4b_934e1408008b

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

connect

boolean connect(java.lang.String serverHost,
                java.lang.String serverPort)
         throws java.io.IOException,
                AutomationException

Connects to an image server given host name and port.

Parameters:

serverHost - The serverHost (in)

serverPort - The serverPort (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startServer

boolean startServer(java.lang.String serverHost)
             throws java.io.IOException,
                    AutomationException

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

Parameters:

serverHost - The serverHost (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopServer

boolean stopServer()
            throws java.io.IOException,
                   AutomationException

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

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerInfo

java.lang.String getServerInfo()
                        throws java.io.IOException,
                               AutomationException

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

Returns:

The serverInfo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerConfiguration

java.lang.String getServerConfiguration()
                                 throws java.io.IOException,
                                        AutomationException

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

Returns:

The serverConfigXml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateServerConfiguration

boolean updateServerConfiguration(java.lang.String serverConfigXml)
                           throws java.io.IOException,
                                  AutomationException

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

Parameters:

serverConfigXml - The serverConfigXml (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServiceProviderConfiguration

java.lang.String getServiceProviderConfiguration(java.lang.String ispName)
                                          throws java.io.IOException,
                                                 AutomationException

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

Parameters:

ispName - The ispName (in)

Returns:

The configXml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateServiceProviderConfiguration

boolean updateServiceProviderConfiguration(java.lang.String ispName,
                                           java.lang.String ispConfigXml)
                                    throws java.io.IOException,
                                           AutomationException

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

Parameters:

ispName - The ispName (in)

ispConfigXml - The ispConfigXml (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startServiceProvider

boolean startServiceProvider(java.lang.String ispName)
                      throws java.io.IOException,
                             AutomationException

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

Parameters:

ispName - The ispName (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopServiceProvider

boolean stopServiceProvider(java.lang.String ispName)
                     throws java.io.IOException,
                            AutomationException

Stops the specified image service provider.

Parameters:

ispName - The ispName (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addServiceProvider

boolean addServiceProvider(java.lang.String ispName,
                           java.lang.String ispHostMachine,
                           java.lang.String ispHostPort)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

ispName - The ispName (in)

ispHostMachine - The ispHostMachine (in)

ispHostPort - The ispHostPort (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeServiceProvider

boolean removeServiceProvider(java.lang.String ispName)
                       throws java.io.IOException,
                              AutomationException

Removes the specified image service provider.

Parameters:

ispName - The ispName (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServiceConfiguration

java.lang.String getServiceConfiguration()
                                  throws java.io.IOException,
                                         AutomationException

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

Returns:

The serviceConfigXml

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateServiceConfiguration

boolean updateServiceConfiguration(java.lang.String serviceConfigXml)
                            throws java.io.IOException,
                                   AutomationException

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

Parameters:

serviceConfigXml - The serviceConfigXml (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startService

boolean startService(java.lang.String serviceName)
              throws java.io.IOException,
                     AutomationException

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

Parameters:

serviceName - The serviceName (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopService

boolean stopService(java.lang.String serviceName)
             throws java.io.IOException,
                    AutomationException

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

Parameters:

serviceName - The serviceName (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeService

boolean removeService(java.lang.String serviceName,
                      java.lang.String[] ispNames)
               throws java.io.IOException,
                      AutomationException

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.

Parameters:

serviceName - The serviceName (in)

ispNames - The ispNames (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addService

boolean addService(java.lang.String servicePath,
                   java.lang.String serviceName,
                   java.lang.String serviceProperties,
                   java.lang.String[] ispNames)
            throws java.io.IOException,
                   AutomationException

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.

Parameters:

servicePath - The servicePath (in)

serviceName - The serviceName (in)

serviceProperties - The serviceProperties (in)

ispNames - The ispNames (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServiceDefinitionName

java.lang.String getServiceDefinitionName(java.lang.String servicePath)
                                   throws java.io.IOException,
                                          AutomationException

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.

Parameters:

servicePath - The servicePath (in)

Returns:

The serviceName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshService

boolean refreshService(java.lang.String serviceName)
                throws java.io.IOException,
                       AutomationException

Reloads the given service.

Parameters:

serviceName - The serviceName (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshAllServices

void refreshAllServices(boolean[] retStatus)
                 throws java.io.IOException,
                        AutomationException

Reloads all the services.

Parameters:

retStatus - The retStatus (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

registerToSOM

boolean registerToSOM(java.lang.String sOMHost,
                      java.lang.String serverHost,
                      java.lang.String serverPort)
               throws java.io.IOException,
                      AutomationException

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

Parameters:

sOMHost - The sOMHost (in)

serverHost - The serverHost (in)

serverPort - The serverPort (in)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSOMRegisteredServer

boolean getSOMRegisteredServer(java.lang.String sOMHost,
                               java.lang.String[] serverHost,
                               java.lang.String[] serverPort)
                        throws java.io.IOException,
                               AutomationException

Gets the server registered to a given host.

Parameters:

sOMHost - The sOMHost (in)

serverHost - The serverHost (out: use single element array)

serverPort - The serverPort (out: use single element array)

Returns:

The retStatus

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatus

java.lang.String getStatus()
                    throws java.io.IOException,
                           AutomationException

Gets the status XML details for any failure.

Returns:

The serverStatusXml

Throws:

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

AutomationException - If the ArcObject component throws an exception.