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

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

All Implemented Interfaces:

GPTool

public class ConvertMapServerCacheStorageFormat
extends AbstractGPTool

Converts the storage of a map service cache between the exploded (pre-10.0) format and the compact format. The tool converts the format "in place", meaning it does not make a copy of the existing format. Instead, it creates the new format cache in the same cache folder and deletes the old format. The Convert Map Server Cache Storage Format tool is contained in the Server Tools tool box.

Usage tips:

• To use this tool, specify the map service whose cache you want to convert. The tool detects the current storage format and uses that information to automatically set the target format to the opposite format. You can choose how many service instances to dedicate to cache conversion.

Field Summary

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

vals

Constructor Summary

ConvertMapServerCacheStorageFormat()
Creates the Convert Map Server Cache Storage Format tool with defaults.

ConvertMapServerCacheStorageFormat(String serverName, String objectName, String dataFrame)
Creates the Convert Map Server Cache Storage Format tool with the required parameters.

Method Summary

String	getDataFrame() Returns the Data Frame 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	getStorageFormatType() Returns the Storage Format Type parameter of this tool .
int	getThreadCount() Returns the Number of MapServer Instances 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	setObjectName(String objectName) Sets the Map Server parameter of this tool .
void	setServerName(String serverName) Sets the Host parameter of this tool .
void	setStorageFormatType(String storageFormatType) Sets the Storage Format Type parameter of this tool .
void	setThreadCount(int threadCount) Sets the Number of MapServer Instances 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

ConvertMapServerCacheStorageFormat

public ConvertMapServerCacheStorageFormat()

Creates the Convert Map Server Cache Storage Format tool with defaults.

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

ConvertMapServerCacheStorageFormat

public ConvertMapServerCacheStorageFormat(String serverName,
                                          String objectName,
                                          String dataFrame)

Creates the Convert Map Server Cache Storage Format 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 format will be changed.

objectName - the map service whose cache format will be changed the new cache format replaces the old cache format. Make a backup of your cache if you wish to go back to your old format.

dataFrame - the source data frame for the map service.

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 format will be changed. 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 format will be changed. This is a required parameter.

Parameters:

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

getObjectName

public String getObjectName()

Returns the Map Server parameter of this tool . This parameter is the map service whose cache format will be changed the new cache format replaces the old cache format. Make a backup of your cache if you wish to go back to your old format. 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 format will be changed the new cache format replaces the old cache format. Make a backup of your cache if you wish to go back to your old format. This is a required parameter.

Parameters:

objectName - the map service whose cache format will be changed the new cache format replaces the old cache format. Make a backup of your cache if you wish to go back to your old format.

getDataFrame

public String getDataFrame()

Returns the Data Frame parameter of this tool . This parameter is the source data frame for the map service. 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 for the map service. This is a required parameter.

Parameters:

dataFrame - the source data frame for the map service.

getStorageFormatType

public String getStorageFormatType()

Returns the Storage Format Type parameter of this tool . This parameter is the storage format to which the new cache will be converted. The tool user interface detects your current cache format and lists the other format as the only option for this parameter. The formats are EXPLODED and COMPACT. This is an optional parameter.

Returns:

the Storage Format Type

setStorageFormatType

public void setStorageFormatType(String storageFormatType)

Sets the Storage Format Type parameter of this tool . This parameter is the storage format to which the new cache will be converted. The tool user interface detects your current cache format and lists the other format as the only option for this parameter. The formats are EXPLODED and COMPACT. This is an optional parameter.

Parameters:

storageFormatType - the storage format to which the new cache will be converted. The tool user interface detects your current cache format and lists the other format as the only option for this parameter. The formats are EXPLODED and COMPACT.

getThreadCount

public int getThreadCount()

Returns the Number of MapServer Instances parameter of this tool . This parameter is number of map service instances to use while converting the cache. By default the maximum allowable number of instances will be used (default for an ArcGIS Server service is 2) . If you have more server power, you can raise the maximum allowable number of instances (accessible from the Service Properties dialog box in ArcCatalog, the Catalog window, or Manager), then raise this parameter when you run the tool. This is an optional parameter.

Returns:

the Number of MapServer Instances

setThreadCount

public void setThreadCount(int threadCount)

Sets the Number of MapServer Instances parameter of this tool . This parameter is number of map service instances to use while converting the cache. By default the maximum allowable number of instances will be used (default for an ArcGIS Server service is 2) . If you have more server power, you can raise the maximum allowable number of instances (accessible from the Service Properties dialog box in ArcCatalog, the Catalog window, or Manager), then raise this parameter when you run the tool. This is an optional parameter.

Parameters:

threadCount - number of map service instances to use while converting the cache. By default the maximum allowable number of instances will be used (default for an ArcGIS Server service is 2) . If you have more server power, you can raise the maximum allowable number of instances (accessible from the Service Properties dialog box in ArcCatalog, the Catalog window, or Manager), then raise this parameter when you run the tool.

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