com.esri.arcgis.geoprocessing.tools.servertools
Class DeleteGlobeServerCache

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.servertools.DeleteGlobeServerCache

All Implemented Interfaces:

GPTool

public class DeleteGlobeServerCache
extends AbstractGPTool

Deletes an existing globe service cache and all tiles in it. The Delete Globe Server Cache tool is contained in the Server Tools tool box.

Usage tips:

• This is an unrecoverable operation so only use it if you are sure you no longer need the cache.
• This tool can be used to delete an existing globe server cache. To delete a cache, specify the ArcGIS Server (host) machine and select the globe service. The layers list will be populated with all available layers in the selected service.
• By default all layers of the service are displayed and selected. If you intend to delete only a particular layer's cache, make sure to unselect the ones you want to keep the cache for.
• Delete Globe Server Cache deletes the entire cache folder. Note that after Delete Globe Server Cache tool runs it will restart the service. This will in turn generate a new set of caches for each layer in the service that was deleted by the delete operation. This is because all globe servicesa cache configuration to exist on disk. The cache that gets created automatically on startup of a service is a skeleton representation that does not contain any tiles.
• This tool requires the 3D Analyst extension.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

DeleteGlobeServerCache()
Creates the Delete Globe Server Cache tool with defaults.

DeleteGlobeServerCache(String serverName, String objectName, Object layer)
Creates the Delete Globe Server Cache tool with the required parameters.

Method Summary

Object	getLayer() Returns the Input Layers parameter of this tool .
String	getObjectName() Returns the GlobeServer Object parameter of this tool .
String	getServerName() Returns the Host parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setLayer(Object layer) Sets the Input Layers parameter of this tool .
void	setObjectName(String objectName) Sets the GlobeServer Object parameter of this tool .
void	setServerName(String serverName) Sets the Host parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteGlobeServerCache

public DeleteGlobeServerCache()

Creates the Delete Globe Server Cache tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

DeleteGlobeServerCache

public DeleteGlobeServerCache(String serverName,
                              String objectName,
                              Object layer)

Creates the Delete Globe Server Cache tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

serverName - the ArcGIS Server machine hosting the service whose cache will be deleted.

objectName - the name of the globe service whose cache will be deleted.

layer - the layers in the globe service whose caches will be deleted. All layers of the service are included by default. If a layer is excluded the layer's cache will not be deleted.

Method Detail

getServerName

public String getServerName()

Returns the Host parameter of this tool . This parameter is the ArcGIS Server machine hosting the service whose cache will be deleted. This is a required parameter.

Returns:

the Host

setServerName

public void setServerName(String serverName)

Sets the Host parameter of this tool . This parameter is the ArcGIS Server machine hosting the service whose cache will be deleted. This is a required parameter.

Parameters:

serverName - the ArcGIS Server machine hosting the service whose cache will be deleted.

getObjectName

public String getObjectName()

Returns the GlobeServer Object parameter of this tool . This parameter is the name of the globe service whose cache will be deleted. This is a required parameter.

Returns:

the GlobeServer Object

setObjectName

public void setObjectName(String objectName)

Sets the GlobeServer Object parameter of this tool . This parameter is the name of the globe service whose cache will be deleted. This is a required parameter.

Parameters:

objectName - the name of the globe service whose cache will be deleted.

getLayer

public Object getLayer()

Returns the Input Layers parameter of this tool . This parameter is the layers in the globe service whose caches will be deleted. All layers of the service are included by default. If a layer is excluded the layer's cache will not be deleted. This is a required parameter.

Returns:

the Input Layers

setLayer

public void setLayer(Object layer)

Sets the Input Layers parameter of this tool . This parameter is the layers in the globe service whose caches will be deleted. All layers of the service are included by default. If a layer is excluded the layer's cache will not be deleted. This is a required parameter.

Parameters:

layer - the layers in the globe service whose caches will be deleted. All layers of the service are included by default. If a layer is excluded the layer's cache will not be deleted.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias