com.esri.arcgis.server
Interface IServiceCatalogAdmin

All Superinterfaces:

Serializable

All Known Subinterfaces:

IServiceCatalogAdmin2, IServiceCatalogAdmin3

All Known Implementing Classes:

IServiceCatalogAdmin2Proxy, IServiceCatalogAdmin3Proxy, IServiceCatalogAdminProxy, ServiceCatalog

public interface IServiceCatalogAdmin
extends Serializable

Provides access to members that control the contents of an ArcGIS Server web services catalog.

When To Use

The IServiceCatalogAdmin interface is intended only for use by the web service catalog template applications that are included as part of the Application Developer Framework for ArcGIS Server. To learn more about these templates, refer to the ArcGIS Server developer documentation.

Product Availability

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

Method Summary

IServiceDescription	createServiceDescription() Creates a new web service description.
IServiceDescriptionArray	createServiceDescriptionArray() Creates a new array of web service descriptions.
byte[]	getCatalogDescriptionDocument(String catalogName, String catalogUrl) The WSDL for the Service Catalog.
byte[]	getDescriptionDocument(String serviceName, String serviceType, String serviceURL) The WSDL for a specified service.
void	setServiceDescriptionsByRef(IServiceDescriptionArray rhs1) The array of the web service descriptions for the web service catalog.

Method Detail

createServiceDescription

IServiceDescription createServiceDescription()
                                             throws IOException,
                                                    AutomationException

Creates a new web service description.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.server.IServiceDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createServiceDescriptionArray

IServiceDescriptionArray createServiceDescriptionArray()
                                                       throws IOException,
                                                              AutomationException

Creates a new array of web service descriptions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.server.IServiceDescriptionArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServiceDescriptionsByRef

void setServiceDescriptionsByRef(IServiceDescriptionArray rhs1)
                                 throws IOException,
                                        AutomationException

The array of the web service descriptions for the web service catalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - A reference to a com.esri.arcgis.server.IServiceDescriptionArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescriptionDocument

byte[] getDescriptionDocument(String serviceName,
                              String serviceType,
                              String serviceURL)
                              throws IOException,
                                     AutomationException

The WSDL for a specified service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

serviceName - The serviceName (in)

serviceType - The serviceType (in)

serviceURL - The serviceURL (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCatalogDescriptionDocument

byte[] getCatalogDescriptionDocument(String catalogName,
                                     String catalogUrl)
                                     throws IOException,
                                            AutomationException

The WSDL for the Service Catalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

catalogName - The catalogName (in)

catalogUrl - The catalogUrl (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.