com.esri.arcgis.globecore
Interface IGlobeServerSetup

All Superinterfaces:

Serializable

All Known Implementing Classes:

GlobeServer

public interface IGlobeServerSetup
extends Serializable

Provides access to members for initializing a Globe server.

Product Availability

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

Method Summary

String	getPhysicalCacheDirectory() The physical directory for Globe cache.
String	getPhysicalOutputDirectory() The physical directory for output files.
String	getSOMPhysicalCacheDirectory() The SOM physical directory for Globe cache.
String	getSOMVirtualCacheDirectory() The SOM virtual directory for Globe cache.
String	getVirtualCacheDirectory() The virtual directory for Globe cache.
String	getVirtualOutputDirectory() The virtual directory for output files.
void	init(String docFile) Initializes the server from a globe document path.
void	initFromLayer(String layerFile) Initializes the server from from a layer file.
void	setPhysicalCacheDirectory(String pPath) The physical directory for Globe cache.
void	setPhysicalOutputDirectory(String pPath) The physical directory for output files.
void	setSOMPhysicalCacheDirectory(String pPath) The SOM physical directory for Globe cache.
void	setVirtualCacheDirectory(String pPath) The virtual directory for Globe cache.
void	setVirtualOutputDirectory(String pPath) The virtual directory for output files.

Method Detail

init

void init(String docFile)
          throws IOException,
                 AutomationException

Initializes the server from a globe document path. The path must be accessible to the server machine.

Product Availability

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

Parameters:

docFile - The docFile (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initFromLayer

void initFromLayer(String layerFile)
                   throws IOException,
                          AutomationException

Initializes the server from from a layer file. The path must be accessible to the server machine.

Product Availability

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

Parameters:

layerFile - The layerFile (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPhysicalOutputDirectory

void setPhysicalOutputDirectory(String pPath)
                                throws IOException,
                                       AutomationException

The physical directory for output files.

Product Availability

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

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPhysicalOutputDirectory

String getPhysicalOutputDirectory()
                                  throws IOException,
                                         AutomationException

The physical directory for output files.

Product Availability

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

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVirtualOutputDirectory

void setVirtualOutputDirectory(String pPath)
                               throws IOException,
                                      AutomationException

The virtual directory for output files.

Product Availability

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

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVirtualOutputDirectory

String getVirtualOutputDirectory()
                                 throws IOException,
                                        AutomationException

The virtual directory for output files.

Product Availability

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

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPhysicalCacheDirectory

void setPhysicalCacheDirectory(String pPath)
                               throws IOException,
                                      AutomationException

The physical directory for Globe cache.

Product Availability

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

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPhysicalCacheDirectory

String getPhysicalCacheDirectory()
                                 throws IOException,
                                        AutomationException

The physical directory for Globe cache.

Product Availability

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

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSOMPhysicalCacheDirectory

void setSOMPhysicalCacheDirectory(String pPath)
                                  throws IOException,
                                         AutomationException

The SOM physical directory for Globe cache.

Product Availability

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

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSOMPhysicalCacheDirectory

String getSOMPhysicalCacheDirectory()
                                    throws IOException,
                                           AutomationException

The SOM physical directory for Globe cache.

Product Availability

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

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVirtualCacheDirectory

void setVirtualCacheDirectory(String pPath)
                              throws IOException,
                                     AutomationException

The virtual directory for Globe cache.

Product Availability

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

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVirtualCacheDirectory

String getVirtualCacheDirectory()
                                throws IOException,
                                       AutomationException

The virtual directory for Globe cache.

Product Availability

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

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSOMVirtualCacheDirectory

String getSOMVirtualCacheDirectory()
                                   throws IOException,
                                          AutomationException

The SOM virtual directory for Globe cache.

Product Availability

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

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.