com.esri.arcgis.datasourcesraster
Class AISImageServerManager

java.lang.Object
  com.esri.arcgis.datasourcesraster.AISImageServerManager

All Implemented Interfaces:

IAISImageServerManager, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class AISImageServerManager
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAISImageServerManager

Image Server Manager CoClass

Product Availability

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

See Also:

Serialized Form

Constructor Summary

AISImageServerManager()
Constructs a AISImageServerManager using ArcGIS Engine.

AISImageServerManager(Object obj)
Construct a AISImageServerManager using a reference to such an object returned from ArcGIS Engine or 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.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

AISImageServerManager

public AISImageServerManager()
                      throws IOException,
                             UnknownHostException

Constructs a AISImageServerManager using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AISImageServerManager

public AISImageServerManager(Object obj)
                      throws IOException

Construct a AISImageServerManager using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AISImageServerManager.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems AISImageServerManager theAISImageServerManager = (AISImageServerManager) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

connect

public 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.

Specified by:

connect in interface IAISImageServerManager

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

public 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.

Specified by:

startServer in interface IAISImageServerManager

Parameters:

serverHost - The serverHost (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopServer

public 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.

Specified by:

stopServer in interface IAISImageServerManager

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerInfo

public 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.

Specified by:

getServerInfo in interface IAISImageServerManager

Returns:

The serverInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerConfiguration

public 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.

Specified by:

getServerConfiguration in interface IAISImageServerManager

Returns:

The serverConfigXml

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateServerConfiguration

public 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.

Specified by:

updateServerConfiguration in interface IAISImageServerManager

Parameters:

serverConfigXml - The serverConfigXml (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceProviderConfiguration

public 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.

Specified by:

getServiceProviderConfiguration in interface IAISImageServerManager

Parameters:

ispName - The ispName (in)

Returns:

The configXml

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateServiceProviderConfiguration

public 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.

Specified by:

updateServiceProviderConfiguration in interface IAISImageServerManager

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

public 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.

Specified by:

startServiceProvider in interface IAISImageServerManager

Parameters:

ispName - The ispName (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopServiceProvider

public boolean stopServiceProvider(String ispName)
                            throws IOException,
                                   AutomationException

Stops the specified image service provider.

Product Availability

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

Specified by:

stopServiceProvider in interface IAISImageServerManager

Parameters:

ispName - The ispName (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addServiceProvider

public 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.

Specified by:

addServiceProvider in interface IAISImageServerManager

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

public boolean removeServiceProvider(String ispName)
                              throws IOException,
                                     AutomationException

Removes the specified image service provider.

Product Availability

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

Specified by:

removeServiceProvider in interface IAISImageServerManager

Parameters:

ispName - The ispName (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceConfiguration

public 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.

Specified by:

getServiceConfiguration in interface IAISImageServerManager

Returns:

The serviceConfigXml

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateServiceConfiguration

public 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.

Specified by:

updateServiceConfiguration in interface IAISImageServerManager

Parameters:

serviceConfigXml - The serviceConfigXml (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startService

public 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.

Specified by:

startService in interface IAISImageServerManager

Parameters:

serviceName - The serviceName (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopService

public 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.

Specified by:

stopService in interface IAISImageServerManager

Parameters:

serviceName - The serviceName (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeService

public 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.

Specified by:

removeService in interface IAISImageServerManager

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

public 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.

Specified by:

addService in interface IAISImageServerManager

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

public 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.

Specified by:

getServiceDefinitionName in interface IAISImageServerManager

Parameters:

servicePath - The servicePath (in)

Returns:

The serviceName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshService

public boolean refreshService(String serviceName)
                       throws IOException,
                              AutomationException

Reloads the given service.

Product Availability

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

Specified by:

refreshService in interface IAISImageServerManager

Parameters:

serviceName - The serviceName (in)

Returns:

The retStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshAllServices

public void refreshAllServices(boolean[] retStatus)
                        throws IOException,
                               AutomationException

Reloads all the services.

Product Availability

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

Specified by:

refreshAllServices in interface IAISImageServerManager

Parameters:

retStatus - The retStatus (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

registerToSOM

public 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.

Specified by:

registerToSOM in interface IAISImageServerManager

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

public 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.

Specified by:

getSOMRegisteredServer in interface IAISImageServerManager

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

public String getStatus()
                 throws IOException,
                        AutomationException

Gets the status XML details for any failure.

Product Availability

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

Specified by:

getStatus in interface IAISImageServerManager

Returns:

The serverStatusXml

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.