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

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

All Implemented Interfaces:

GPTool

public class DeleteMapServerCache
extends AbstractGPTool

Deletes an existing map service cache, including all associated files on disk. The Delete Map Server Cache tool is contained in the Server Tools tool box.

Usage tips:

• This is an unrecoverable operation so only use if you are sure you no longer need the cache. If you want to delete tiles but leave the cache folder structure and tiling scheme, use with the Update Mode set to Delete Tiles.
• If there are caches for more than one data frame in the cache directory, only the active data frame of the specified map service will be removed.
• If there is only one data frame in the cache directory the entire directory will be removed.
• After this tool runs the map service will be restarted.

Field Summary

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

vals

Constructor Summary

DeleteMapServerCache()
Creates the Delete Map Server Cache tool with defaults.

DeleteMapServerCache(String serverName, String objectName, String dataFrame, Object layer)
Creates the Delete Map Server Cache tool with the required parameters.

Method Summary

String	getDataFrame() Returns the Data Frame parameter of this tool .
Object	getLayer() Returns the Input Layers parameter of this tool .
String	getObjectName() Returns the Map Server parameter of this tool .
String	getOutObjectName() Returns the Output Map Server parameter of this tool (Read only).
String	getOutServerName() Returns the Output Host parameter of this tool (Read only).
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	setDataFrame(String dataFrame) Sets the Data Frame parameter of this tool .
void	setLayer(Object layer) Sets the Input Layers parameter of this tool .
void	setObjectName(String objectName) Sets the Map Server 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

DeleteMapServerCache

public DeleteMapServerCache()

Creates the Delete Map Server Cache tool with defaults.

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

DeleteMapServerCache

public DeleteMapServerCache(String serverName,
                            String objectName,
                            String dataFrame,
                            Object layer)

Creates the Delete Map 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 map service whose cache will be deleted.

dataFrame - the source data frame of the cache to be deleted. This appears in the user interface for informational purposes only and cannot be changed.

layer - the layers to delete from the cache (only applies to multi-layer caches). Layers that are included will be removed from the cache. Excluded layers will remain.

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 Map Server parameter of this tool . This parameter is the map service whose cache will be deleted. This is a required parameter.

Returns:

the Map Server

setObjectName

public void setObjectName(String objectName)

Sets the Map Server parameter of this tool . This parameter is the map service whose cache will be deleted. This is a required parameter.

Parameters:

objectName - the map service whose cache will be deleted.

getDataFrame

public String getDataFrame()

Returns the Data Frame parameter of this tool . This parameter is the source data frame of the cache to be deleted. This appears in the user interface for informational purposes only and cannot be changed. This is a required parameter.

Returns:

the Data Frame

setDataFrame

public void setDataFrame(String dataFrame)

Sets the Data Frame parameter of this tool . This parameter is the source data frame of the cache to be deleted. This appears in the user interface for informational purposes only and cannot be changed. This is a required parameter.

Parameters:

dataFrame - the source data frame of the cache to be deleted. This appears in the user interface for informational purposes only and cannot be changed.

getLayer

public Object getLayer()

Returns the Input Layers parameter of this tool . This parameter is the layers to delete from the cache (only applies to multi-layer caches). Layers that are included will be removed from the cache. Excluded layers will remain. 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 to delete from the cache (only applies to multi-layer caches). Layers that are included will be removed from the cache. Excluded layers will remain. This is a required parameter.

Parameters:

layer - the layers to delete from the cache (only applies to multi-layer caches). Layers that are included will be removed from the cache. Excluded layers will remain.

getOutServerName

public String getOutServerName()

Returns the Output Host parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Host

getOutObjectName

public String getOutObjectName()

Returns the Output Map Server parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Map Server

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