com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class CreateArcSDEConnectionFile

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.CreateArcSDEConnectionFile

All Implemented Interfaces:

GPTool

public class CreateArcSDEConnectionFile
extends AbstractGPTool

Creates an ArcSDE connection file for use in connecting to ArcSDE geodatabases. The Create ArcSDE Connection File tool is contained in the Data Management Tools tool box.

Usage tips:

• Although you can enter any file extension for the ArcSDE Connection File Name, you must use the standard file extension .sde in order for it to be recognised correctly by ArcGIS.
• When valid connection information is entered the tool will connect to the ArcSDE server in order to populate the versions list with versions the connected user has permissions to connect to.
• Please see for a more complete explanation of ArcSDE connection properties.

Field Summary

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

vals

Constructor Summary

CreateArcSDEConnectionFile()
Creates the Create ArcSDE Connection File tool with defaults.

CreateArcSDEConnectionFile(Object outFolderPath, String outName, String server, String service)
Creates the Create ArcSDE Connection File tool with the required parameters.

Method Summary

String	getAccountAuthentication() Returns the Database authentication parameter of this tool .
Object	getConnectionFileName() Returns the Connection File Name parameter of this tool (Read only).
String	getDatabase() Returns the Database parameter of this tool .
Object	getOutFolderPath() Returns the ArcSDE Connection File Location parameter of this tool .
String	getOutName() Returns the ArcSDE Connection File Name parameter of this tool .
Object	getPassword() Returns the Password parameter of this tool .
String	getSaveUsernamePassword() Returns the Save username and password parameter of this tool .
String	getSaveVersionInfo() Returns the Save the transactional version name with the connection file parameter of this tool .
String	getServer() Returns the Server parameter of this tool .
String	getService() Returns the Service 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.
String	getUsername() Returns the Username parameter of this tool .
String	getVersion() Returns the The following transactional version will be used parameter of this tool .
void	setAccountAuthentication(String accountAuthentication) Sets the Database authentication parameter of this tool .
void	setDatabase(String database) Sets the Database parameter of this tool .
void	setOutFolderPath(Object outFolderPath) Sets the ArcSDE Connection File Location parameter of this tool .
void	setOutName(String outName) Sets the ArcSDE Connection File Name parameter of this tool .
void	setPassword(Object password) Sets the Password parameter of this tool .
void	setSaveUsernamePassword(String saveUsernamePassword) Sets the Save username and password parameter of this tool .
void	setSaveVersionInfo(String saveVersionInfo) Sets the Save the transactional version name with the connection file parameter of this tool .
void	setServer(String server) Sets the Server parameter of this tool .
void	setService(String service) Sets the Service parameter of this tool .
void	setUsername(String username) Sets the Username parameter of this tool .
void	setVersion(String version) Sets the The following transactional version will be used 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

CreateArcSDEConnectionFile

public CreateArcSDEConnectionFile()

Creates the Create ArcSDE Connection File tool with defaults.

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

CreateArcSDEConnectionFile

public CreateArcSDEConnectionFile(Object outFolderPath,
                                  String outName,
                                  String server,
                                  String service)

Creates the Create ArcSDE Connection File 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:

outFolderPath - the folder path where the .sde file will be stored.

outName - the name of the ArcSDE Connection file. Use the .sde file extension.

server - the ArcSDE Server machine name.

service - the ArcSDE Service name or TCP port number.

Method Detail

getOutFolderPath

public Object getOutFolderPath()

Returns the ArcSDE Connection File Location parameter of this tool . This parameter is the folder path where the .sde file will be stored. This is a required parameter.

Returns:

the ArcSDE Connection File Location

setOutFolderPath

public void setOutFolderPath(Object outFolderPath)

Sets the ArcSDE Connection File Location parameter of this tool . This parameter is the folder path where the .sde file will be stored. This is a required parameter.

Parameters:

outFolderPath - the folder path where the .sde file will be stored.

getOutName

public String getOutName()

Returns the ArcSDE Connection File Name parameter of this tool . This parameter is the name of the ArcSDE Connection file. Use the .sde file extension. This is a required parameter.

Returns:

the ArcSDE Connection File Name

setOutName

public void setOutName(String outName)

Sets the ArcSDE Connection File Name parameter of this tool . This parameter is the name of the ArcSDE Connection file. Use the .sde file extension. This is a required parameter.

Parameters:

outName - the name of the ArcSDE Connection file. Use the .sde file extension.

getServer

public String getServer()

Returns the Server parameter of this tool . This parameter is the ArcSDE Server machine name. This is a required parameter.

Returns:

the Server

setServer

public void setServer(String server)

Sets the Server parameter of this tool . This parameter is the ArcSDE Server machine name. This is a required parameter.

Parameters:

server - the ArcSDE Server machine name.

getService

public String getService()

Returns the Service parameter of this tool . This parameter is the ArcSDE Service name or TCP port number. This is a required parameter.

Returns:

the Service

setService

public void setService(String service)

Sets the Service parameter of this tool . This parameter is the ArcSDE Service name or TCP port number. This is a required parameter.

Parameters:

service - the ArcSDE Service name or TCP port number.

getDatabase

public String getDatabase()

Returns the Database parameter of this tool . This parameter is for non-Oracle databases only. The DBMS database to connect to. This is an optional parameter.

Returns:

the Database

setDatabase

public void setDatabase(String database)

Sets the Database parameter of this tool . This parameter is for non-Oracle databases only. The DBMS database to connect to. This is an optional parameter.

Parameters:

database - for non-Oracle databases only. The DBMS database to connect to.

getAccountAuthentication

public String getAccountAuthentication()

Returns the Database authentication parameter of this tool . This is an optional parameter.

Returns:

the Database authentication

setAccountAuthentication

public void setAccountAuthentication(String accountAuthentication)

Sets the Database authentication parameter of this tool . This is an optional parameter.

Parameters:

accountAuthentication - null

getUsername

public String getUsername()

Returns the Username parameter of this tool . This parameter is database username to connect with using Database Authentication. This is an optional parameter.

Returns:

the Username

setUsername

public void setUsername(String username)

Sets the Username parameter of this tool . This parameter is database username to connect with using Database Authentication. This is an optional parameter.

Parameters:

username - database username to connect with using Database Authentication.

getPassword

public Object getPassword()

Returns the Password parameter of this tool . This parameter is the database user password when using Database Authentication. This is an optional parameter.

Returns:

the Password

setPassword

public void setPassword(Object password)

Sets the Password parameter of this tool . This parameter is the database user password when using Database Authentication. This is an optional parameter.

Parameters:

password - the database user password when using Database Authentication.

getSaveUsernamePassword

public String getSaveUsernamePassword()

Returns the Save username and password parameter of this tool . This is an optional parameter.

Returns:

the Save username and password

setSaveUsernamePassword

public void setSaveUsernamePassword(String saveUsernamePassword)

Sets the Save username and password parameter of this tool . This is an optional parameter.

Parameters:

saveUsernamePassword - null

getVersion

public String getVersion()

Returns the The following transactional version will be used parameter of this tool . This parameter is the Geodatabase version to connect to. This is an optional parameter.

Returns:

the The following transactional version will be used

setVersion

public void setVersion(String version)

Sets the The following transactional version will be used parameter of this tool . This parameter is the Geodatabase version to connect to. This is an optional parameter.

Parameters:

version - the Geodatabase version to connect to.

getSaveVersionInfo

public String getSaveVersionInfo()

Returns the Save the transactional version name with the connection file parameter of this tool . This is an optional parameter.

Returns:

the Save the transactional version name with the connection file

setSaveVersionInfo

public void setSaveVersionInfo(String saveVersionInfo)

Sets the Save the transactional version name with the connection file parameter of this tool . This is an optional parameter.

Parameters:

saveVersionInfo - null

getConnectionFileName

public Object getConnectionFileName()

Returns the Connection File Name parameter of this tool (Read only). This is an derived parameter.

Returns:

the Connection File Name

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