com.esri.arcgis.server
Class ServiceCatalog

java.lang.Object
  com.esri.arcgis.server.ServiceCatalog

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IServiceCatalog, IServiceCatalog2, IServiceCatalogAdmin, IServiceCatalogAdmin2, IRequestHandler, Serializable

public class ServiceCatalog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IServiceCatalog, IServiceCatalog2, IServiceCatalogAdmin, IServiceCatalogAdmin2, IRequestHandler

The ServiceCatalog object, which implements the Service Catalog.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.system.IRequestHandler

IID, IID46a0e2ea_3b64_4a46_bd78_88a1660f35bb, xxDummy

Constructor Summary

ServiceCatalog()
Constructs a ServiceCatalog using ArcGIS Engine.

ServiceCatalog(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ServiceCatalog theServiceCatalog = (ServiceCatalog) obj;

Method Summary

IServiceDescription	createServiceDescription() Creates a new web service description.
IServiceDescriptionArray	createServiceDescriptionArray() Creates a new array of web service descriptions.
IStringArray	createServiceFolderArray() Creates a new array of web service folders.
boolean	equals(Object o) Compare this object with another
byte[]	getCatalogDescriptionDocument(String catalogName, String catalogUrl) The WSDL for the Service Catalog.
static String	getClsid() getClsid.
byte[]	getDescriptionDocument(String serviceName, String serviceType, String serviceURL) The WSDL for a specified service.
IStringArray	getFolders(String folderName) Gets an IStringArray of service folder names.
int	getMessageFormats() The message formats supported by the web services in the catalog.
int	getMessageVersion() The message version this server version supports.
IServiceDescriptionArray	getServiceDescriptions() An array of the web service descriptions in the web service catalog.
IServiceDescriptionArray	getServiceDescriptionsEx(String folderName) An array of the web service descriptions in the web service catalog.
byte[]	handleBinaryRequest(byte[] request) Handles a binary request.
String	handleStringRequest(String capabilities, String request) Handles a SOAP string request.
int	hashCode() the hashcode for this object
void	setMessageFormats(int rhs1) The message formats supported by the web services in the catalog.
void	setMessageVersion(int rhs1) The message version supported by the server.
void	setServiceDescriptionsByRef(IServiceDescriptionArray rhs1) The array of the web service descriptions for the web service catalog.
void	setServiceFoldersByRef(IStringArray rhs1) The array of the web service folders for the web service catalog.

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

ServiceCatalog

public ServiceCatalog()
               throws IOException,
                      UnknownHostException

Constructs a ServiceCatalog using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ServiceCatalog

public ServiceCatalog(Object obj)
               throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ServiceCatalog theServiceCatalog = (ServiceCatalog) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

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

getServiceDescriptions

public IServiceDescriptionArray getServiceDescriptions()
                                                throws IOException,
                                                       AutomationException

An array of the web service descriptions in the web service catalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getServiceDescriptions in interface IServiceCatalog

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.

getMessageVersion

public int getMessageVersion()
                      throws IOException,
                             AutomationException

The message version this server version supports.

Product Availability

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

Specified by:

getMessageVersion in interface IServiceCatalog2

Returns:

A com.esri.arcgis.system.esriArcGISVersion constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessageFormats

public int getMessageFormats()
                      throws IOException,
                             AutomationException

The message formats supported by the web services in the catalog.

Product Availability

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

Specified by:

getMessageFormats in interface IServiceCatalog2

Returns:

A com.esri.arcgis.server.esriServiceCatalogMessageFormat constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceDescriptionsEx

public IServiceDescriptionArray getServiceDescriptionsEx(String folderName)
                                                  throws IOException,
                                                         AutomationException

An array of the web service descriptions in the web service catalog.

Product Availability

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

Specified by:

getServiceDescriptionsEx in interface IServiceCatalog2

Parameters:

folderName - The folderName (in)

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.

getFolders

public IStringArray getFolders(String folderName)
                        throws IOException,
                               AutomationException

Gets an IStringArray of service folder names.

Product Availability

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

Specified by:

getFolders in interface IServiceCatalog2

Parameters:

folderName - The folderName (in)

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createServiceDescription

public 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

Specified by:

createServiceDescription in interface IServiceCatalogAdmin

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

public 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

Specified by:

createServiceDescriptionArray in interface IServiceCatalogAdmin

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

public 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

Specified by:

setServiceDescriptionsByRef in interface IServiceCatalogAdmin

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

public 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

Specified by:

getDescriptionDocument in interface IServiceCatalogAdmin

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

public 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

Specified by:

getCatalogDescriptionDocument in interface IServiceCatalogAdmin

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.

setMessageFormats

public void setMessageFormats(int rhs1)
                       throws IOException,
                              AutomationException

The message formats supported by the web services in the catalog.

Product Availability

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

Specified by:

setMessageFormats in interface IServiceCatalogAdmin2

Parameters:

rhs1 - A com.esri.arcgis.server.esriServiceCatalogMessageFormat constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMessageVersion

public void setMessageVersion(int rhs1)
                       throws IOException,
                              AutomationException

The message version supported by the server.

Product Availability

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

Specified by:

setMessageVersion in interface IServiceCatalogAdmin2

Parameters:

rhs1 - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createServiceFolderArray

public IStringArray createServiceFolderArray()
                                      throws IOException,
                                             AutomationException

Creates a new array of web service folders.

Product Availability

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

Specified by:

createServiceFolderArray in interface IServiceCatalogAdmin2

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServiceFoldersByRef

public void setServiceFoldersByRef(IStringArray rhs1)
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Specified by:

setServiceFoldersByRef in interface IServiceCatalogAdmin2

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

handleBinaryRequest

public byte[] handleBinaryRequest(byte[] request)
                           throws IOException,
                                  AutomationException

Handles a binary request.

Specified by:

handleBinaryRequest in interface IRequestHandler

Parameters:

request - An unsigned byte (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

handleStringRequest

public String handleStringRequest(String capabilities,
                                  String request)
                           throws IOException,
                                  AutomationException

Handles a SOAP string request.

Specified by:

handleStringRequest in interface IRequestHandler

Parameters:

capabilities - The capabilities (in)

request - The request (in)

Returns:

The response

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.