com.esri.arcgis.gisclient
Interface IRESTServerObjectAdmin

All Superinterfaces:
Serializable

public interface IRESTServerObjectAdmin
extends Serializable

Provides access to methods adminstrating AGS rest services.

Product Availability

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


Method Summary
 double getAdminVersion()
          Returns the version of the server's admin API.
 IEnumServerObjectConfigurationInfo getConfigurationInfos(String folderName)
          The configuration infos within a folder (use empty string for root).
 IItemInfo getItemInfo(String name, String type, String soeType)
          The ItemInfo of a service.
 IPropertySet getMetadata(String name, String type, String soeType)
          The metadata of a service.
 void putItemInfo(String name, String type, String soeType, IItemInfo pItemInfo)
          Add or update the ItemInfo of a service.
 void putMetadata(String name, String type, String soeType, IPropertySet pMetadata)
          Add or update the metadata of a service.
 

Method Detail

getConfigurationInfos

IEnumServerObjectConfigurationInfo getConfigurationInfos(String folderName)
                                                         throws IOException,
                                                                AutomationException
The configuration infos within a folder (use empty string for root).

Product Availability

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

Parameters:
folderName - The folderName (in)
Returns:
A reference to a com.esri.arcgis.server.IEnumServerObjectConfigurationInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAdminVersion

double getAdminVersion()
                       throws IOException,
                              AutomationException
Returns the version of the server's admin API.

Product Availability

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

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

getItemInfo

IItemInfo getItemInfo(String name,
                      String type,
                      String soeType)
                      throws IOException,
                             AutomationException
The ItemInfo of a service.

Product Availability

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

Parameters:
name - The name (in)
type - The type (in)
soeType - The soeType (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IItemInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putItemInfo

void putItemInfo(String name,
                 String type,
                 String soeType,
                 IItemInfo pItemInfo)
                 throws IOException,
                        AutomationException
Add or update the ItemInfo of a service.

Product Availability

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

Parameters:
name - The name (in)
type - The type (in)
soeType - The soeType (in)
pItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetadata

IPropertySet getMetadata(String name,
                         String type,
                         String soeType)
                         throws IOException,
                                AutomationException
The metadata of a service.

Product Availability

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

Parameters:
name - The name (in)
type - The type (in)
soeType - The soeType (in)
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putMetadata

void putMetadata(String name,
                 String type,
                 String soeType,
                 IPropertySet pMetadata)
                 throws IOException,
                        AutomationException
Add or update the metadata of a service.

Product Availability

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

Parameters:
name - The name (in)
type - The type (in)
soeType - The soeType (in)
pMetadata - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.