Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.datasourcesraster
Interface IAISImageServerManager

All Superinterfaces:
Serializable
All Known Implementing Classes:
AISImageServerManager, IAISImageServerManagerProxy
public interface IAISImageServerManager
extends Serializable

Server Manager Interface

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

Method Detail

connect

boolean connect(String serverHost,
                String serverPort)
                throws IOException,
                       AutomationException
Connects to an image server given host name and port.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
serverHost - The serverHost (in)
serverPort - The serverPort (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startServer

boolean startServer(String serverHost)
                    throws 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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
serverHost - The serverHost (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stopServer

boolean stopServer()
                   throws IOException,
                          AutomationException
Stops the image server service. Can be invoked only after connecting to the image server.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerInfo

String getServerInfo()
                     throws IOException,
                            AutomationException
Obtains server information containing the list of all image service providers and image services as an XML string.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The serverInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerConfiguration

String getServerConfiguration()
                              throws IOException,
                                     AutomationException
Obtains the current configuration of the image server service as an XML string. The XML is defined by ISSConfig.xsd.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The serverConfigXml
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateServerConfiguration

boolean updateServerConfiguration(String serverConfigXml)
                                  throws IOException,
                                         AutomationException
Updates configuration of the image server using the specified XML. The XML is defined by ISSConfig.xsd.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
serverConfigXml - The serverConfigXml (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServiceProviderConfiguration

String getServiceProviderConfiguration(String ispName)
                                       throws IOException,
                                              AutomationException
Obtains the current configuration of the specified image service provider as an XML string defined by ISPConfig.xsd

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ispName - The ispName (in)
Returns:
The configXml
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateServiceProviderConfiguration

boolean updateServiceProviderConfiguration(String ispName,
                                           String ispConfigXml)
                                           throws IOException,
                                                  AutomationException
Updates configuration of an image service provider using the specifed XML. The XML is defined by ISPConfig.xsd

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ispName - The ispName (in)
ispConfigXml - The ispConfigXml (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startServiceProvider

boolean startServiceProvider(String ispName)
                             throws IOException,
                                    AutomationException
Starts the specified image service provider using either the default or the last saved configuration.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ispName - The ispName (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stopServiceProvider

boolean stopServiceProvider(String ispName)
                            throws IOException,
                                   AutomationException
Stops the specified image service provider.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ispName - The ispName (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addServiceProvider

boolean addServiceProvider(String ispName,
                           String ispHostMachine,
                           String ispHostPort)
                           throws IOException,
                                  AutomationException
Add a new image service provider using the specified friendly name on the specified host machine and port.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ispName - The ispName (in)
ispHostMachine - The ispHostMachine (in)
ispHostPort - The ispHostPort (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeServiceProvider

boolean removeServiceProvider(String ispName)
                              throws IOException,
                                     AutomationException
Removes the specified image service provider.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ispName - The ispName (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServiceConfiguration

String getServiceConfiguration()
                               throws 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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The serviceConfigXml
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateServiceConfiguration

boolean updateServiceConfiguration(String serviceConfigXml)
                                   throws IOException,
                                          AutomationException
Updates configuration of the image server pertaining all image services using the specified XML string. The XML is defined by ISServices.xsd.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
serviceConfigXml - The serviceConfigXml (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startService

boolean startService(String serviceName)
                     throws IOException,
                            AutomationException
Publishes the specified compiled service definition file as an image service on the image service providers specified when the service was added.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
serviceName - The serviceName (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stopService

boolean stopService(String serviceName)
                    throws IOException,
                           AutomationException
Stops an image service on the image service providers specified when the service was added.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
serviceName - The serviceName (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeService

boolean removeService(String serviceName,
                      String[] ispNames)
                      throws 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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
serviceName - The serviceName (in)
ispNames - The ispNames (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addService

boolean addService(String servicePath,
                   String serviceName,
                   String serviceProperties,
                   String[] ispNames)
                   throws 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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
servicePath - The servicePath (in)
serviceName - The serviceName (in)
serviceProperties - The serviceProperties (in)
ispNames - The ispNames (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServiceDefinitionName

String getServiceDefinitionName(String servicePath)
                                throws 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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
servicePath - The servicePath (in)
Returns:
The serviceName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshService

boolean refreshService(String serviceName)
                       throws IOException,
                              AutomationException
Reloads the given service.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
serviceName - The serviceName (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshAllServices

void refreshAllServices(boolean[] retStatus)
                        throws IOException,
                               AutomationException
Reloads all the services.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
retStatus - The retStatus (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

registerToSOM

boolean registerToSOM(String sOMHost,
                      String serverHost,
                      String serverPort)
                      throws IOException,
                             AutomationException
Registers the server to a given ArcGIS Server Object Manager SOM.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
sOMHost - The sOMHost (in)
serverHost - The serverHost (in)
serverPort - The serverPort (in)
Returns:
The retStatus
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSOMRegisteredServer

boolean getSOMRegisteredServer(String sOMHost,
                               String[] serverHost,
                               String[] serverPort)
                               throws IOException,
                                      AutomationException
Gets the server registered to a given host.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStatus

String getStatus()
                 throws IOException,
                        AutomationException
Gets the status XML details for any failure.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The serverStatusXml
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD