com.esri.arcgis.datasourcesGDB
Class SdeWorkspaceFactory

java.lang.Object
  com.esri.arcgis.datasourcesGDB.SdeWorkspaceFactory

All Implemented Interfaces:

IEnterpriseWorkspaceFactory, IRemoteDatabaseWorkspaceFactory, ISetDefaultConnectionInfo, ISetDefaultConnectionInfo2, ISetDefaultConnectionInfo3, IWorkspaceFactory, IWorkspaceFactory2, IWorkspaceFactorySchemaCache, IWorkspaceFactoryStatus, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class SdeWorkspaceFactory
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspaceFactory, IRemoteDatabaseWorkspaceFactory, IEnterpriseWorkspaceFactory, ISetDefaultConnectionInfo, IWorkspaceFactory2, ISupportErrorInfo, ISetDefaultConnectionInfo2, IWorkspaceFactorySchemaCache, IWorkspaceFactoryStatus, ISetDefaultConnectionInfo3

Esri SDE Workspace Factory.

Remarks

The SdeWorkspaceFactory object provides SDE workspaces which are just connections to SDE.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Singleton:

This type is a singleton.

See Also:

Serialized Form

Constructor Summary

SdeWorkspaceFactory()
Constructs a SdeWorkspaceFactory using ArcGIS Engine.

SdeWorkspaceFactory(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SdeWorkspaceFactory theSdeWorkspaceFactory = (SdeWorkspaceFactory) obj;

Method Summary

void	clearParameters(String server, String instance) Clears ArcSDE connection property parameters.
void	clearParameters3(String server, String instance, String authenticationMode) Clears ArcSDE connection property parameters.
boolean	containsWorkspace(String parentDirectory, IFileNames fileNames) Indicates if parentDirectory contains a valid workspace, or is a valid file-system workspace.
boolean	copy(IWorkspaceName workspaceName, String destinationFolder, IWorkspaceName[] workspaceNameCopy) Copies a workspace to the specified destination folder.
IWorkspaceName	create(String parentDirectory, String name, IPropertySet connectionProperties, int hWnd) Creates a new workspace specified by the directory, file name, and connection properties.
void	deleteConnectionFile(String pathName) Deletes the remote database workspace connection file.
void	disableAllSchemaCaches() Disable the schema caches of all open workspaces.
void	disableSchemaCache(IWorkspace workspace) Disable the schema cache for a specific workspace.
void	disableSchemaCaching() All new workspaces handed out by the factory will not have schema caching enabled.
IWorkspaceName	editConnectionFile(String pathName, int hWnd) Edits the properties of a remote database workspace connection file.
void	enableAllSchemaCaches() Enable the schema caches of all open workspaces.
void	enableSchemaCache(IWorkspace workspace) Enable the schema cache for a specific workspace.
void	enableSchemaCaching() All new workspaces handed out by the factory will have schema caching enabled.
boolean	equals(Object o) Compare this object with another
IUID	getClassID() The class ID of the WorkspaceFactory.
static String	getClsid() getClsid.
String	getWorkspaceDescription(boolean plural) A singular or plural description of the type of workspace the workspace factory opens/creates.
IWorkspaceName	getWorkspaceName(String parentDirectory, IFileNames fileNames) Retrieves the workspace name of a workspace from the given list of file names.
IEnumWorkspaceStatus	getWorkspaceStatus() Retrieve the workspace status information for all currently opened workspaces.
int	getWorkspaceType() The type of workspace the workspace factory opens/creates.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isAnySchemaCacheStale() Checks all current schema caches for staleness.
boolean	isSchemaCacheStale(IWorkspace workspace) Checks a specific schema cache for staleness.
boolean	isWorkspace(String fileName) True if the specified file identifies a workspace supported by the workspace factory.
boolean	move(IWorkspaceName workspaceName, String destinationFolder) Moves a workspace to the specified destination folder.
IWorkspace	open(IPropertySet connectionProperties, int hWnd) Opens the workspace specified by the connection properties.
IWorkspace	openAvailableWorkspace(IWorkspaceStatus wstatus) Makes an attempt to open a new instance of a workspace that is esriWCSDown but has since become esriWCSAvailable.
IWorkspace	openFromFile(String fileName, int hWnd) Opens the workspace specified by the given file name.
IWorkspace	openFromString(String connectStr, int hWnd) Opens the workspace specified by a connection string.
IWorkspace	openWithNewLicense(IPropertySet pConnectionProperties, int hWnd, String newLicensePath) Open the enterprise database connection with new license file.
IWorkspace	openWithNewPassword(IPropertySet connectionProperties, int hWnd, String newPassword) Opens the workspace specified by the connection properties.
IWorkspaceStatus	pingWorkspaceStatus(IWorkspace workspace) Checks if the status of an esriWCSDown workspace has changed.
IPropertySet	readConnectionPropertiesFromFile(String fileName) The connection properties from the specified file.
void	refreshAllSchemaCaches() Refreshes all current schema caches.
void	refreshSchemaCache(IWorkspace workspace) Refreshes the schema cache for a specific workspace.
IWorkspaceName	renameConnectionFile(String oldPathName, String newName) Renames the remote database workspace connection file.
void	setParameters(String server, String instance, String user, String password, String versName) Sets ArcSDE connection property parameters.
void	setParameters3(String server, String instance, String authenticationMode, String userName, String password, String versionName, Object historicalInfo) Sets ArcSDE connection property parameters.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

SdeWorkspaceFactory

public SdeWorkspaceFactory()
                    throws IOException,
                           UnknownHostException

Constructs a SdeWorkspaceFactory using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SdeWorkspaceFactory

public SdeWorkspaceFactory(Object obj)
                    throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SdeWorkspaceFactory theSdeWorkspaceFactory = (SdeWorkspaceFactory) obj;

Construct a SdeWorkspaceFactory using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SdeWorkspaceFactory.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

open

public IWorkspace open(IPropertySet connectionProperties,
                       int hWnd)
                throws IOException,
                       AutomationException

Opens the workspace specified by the connection properties.

Remarks

Open takes as input a property set of connection properties that specify the workspace to connect to. In the case of file system workspaces and local database workspaces, a single property named DATABASE, whose value is the pathname to the workspace, is usually all that is required. In the case of remote database workspaces accessed via ArcSDE the properties can include the USER, PASSWORD, DATABASE, SERVER, INSTANCE, VERSION, HISTORICAL_NAME, HISTORICAL_TIMESTAMP, and AUTHENTICATION_MODE properties of the database being connected to.

List of acceptable connection property names and a brief description of each

"SERVER" – SDE server name you are connecting to.

"INSTANCE" – Instance you are connection to.

"DATABASE" – Database connected to.

"USER" – Connected user.

"PASSWORD" – Connected password.

"AUTHENTICATION_MODE" – Credential authentication mode of the connection. Acceptable values are "OSA" and "DBMS".

"VERSION" – Transactional version to connect to. Acceptable value is a string that represents a transaction version name.

"HISTORICAL_NAME" – Historical version to connect to. Acceptable value is a string type that represents a historical marker name.

"HISTORICAL_TIMESTAMP" – Moment in history to establish an historical version connection. Acceptable value is a date time that represents a moment timestamp.

Notes:

• The "DATABASE" property is optional and is required for ArcSDE instances that manage multiple databases (for example, SQL Server).
• If “AUTHENTICATION_MODE” is “OSA” then “USER” and “PASSWORD” are not required. “OSA” represents operating system authentication and uses the operating system credentials to establish a connection with the database.
• Since the workspace connection can only represent one version only 1 of the 3 version properties (“VERSION” or “HISTORICAL_NAME” or “HISTORICAL_TIMESTAMP”) should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IWorkspaceFactory

Parameters:

connectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openFromFile

public IWorkspace openFromFile(String fileName,
                               int hWnd)
                        throws IOException,
                               AutomationException

Opens the workspace specified by the given file name.

Remarks

OpenFromFile takes the pathname of a file or directory that represents either a FileSystemWorkspace or LocalDatabaseWorkspace, or a connection file to a RemoteDatabase workspace and returns an interface on the specified workspace. Clients of these methods can then proceed to open and access datasets in the workspace. If these methods are called with insufficient properties, then the user will be presented with a connection dialog that will prompt for the required properties.

The hWnd argument is the parent window or application's window. The hWnd will guarantee that the connection dialog, if presented to you because of insufficient properties, has the correct parent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

openFromFile in interface IWorkspaceFactory

Parameters:

fileName - The fileName (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

create

public IWorkspaceName create(String parentDirectory,
                             String name,
                             IPropertySet connectionProperties,
                             int hWnd)
                      throws IOException,
                             AutomationException

Creates a new workspace specified by the directory, file name, and connection properties.

Remarks

Create has different results depending on the type of workspace factory. If you are working with ArcSDE, a new connection file (.sde) is created. If you are working with an ArcGIS for Desktop Advanced workspace factory, a folder with an INFO subfolder is created. The optional ConnectionProperties parameter specifies any additional connection properties needed, such as the server, instance, user and password in the case where a connection file to a remote database workspace is being created. If no connection properties are specified, this method will result in a dialog being displayed that prompts the user for the required properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

create in interface IWorkspaceFactory

Parameters:

parentDirectory - The parentDirectory (in)

name - The name (in)

connectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

containsWorkspace

public boolean containsWorkspace(String parentDirectory,
                                 IFileNames fileNames)
                          throws IOException,
                                 AutomationException

Indicates if parentDirectory contains a valid workspace, or is a valid file-system workspace.

Remarks

ContainsWorkspace is useful when browsing the file system for workspaces. It takes a parent directory and the list of file names in the directory to be examined. It returns true if the parent directory represents a workspace covered by this factory or if the parent directory contains a workspace or a connection file to a workspace covered by this factory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

containsWorkspace in interface IWorkspaceFactory

Parameters:

parentDirectory - The parentDirectory (in)

fileNames - A reference to a com.esri.arcgis.system.IFileNames (in)

Returns:

The containsWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName(String parentDirectory,
                                       IFileNames fileNames)
                                throws IOException,
                                       AutomationException

Retrieves the workspace name of a workspace from the given list of file names.

Remarks

GetWorkspaceName is useful when browsing the file system for workspaces. It is handed in a parent directory and the list of file names in the directory to be examined. It returns a WorkspaceName object representing the first workspace it finds in the list of filenames and removes any filenames representing the workspace from the input list of filenames.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceName in interface IWorkspaceFactory

Parameters:

parentDirectory - The parentDirectory (in)

fileNames - A reference to a com.esri.arcgis.system.IFileNames (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException

The class ID of the WorkspaceFactory.

Remarks

GetClassID returns the unique identifier for the workspace factory. You can use this to distinguish different versions of the same type of factory, for example, whether you are working with an SDEWorkspace, FileGDBWorkspace or AccessWorkspace factory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IWorkspaceFactory

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isWorkspace

public boolean isWorkspace(String fileName)
                    throws IOException,
                           AutomationException

True if the specified file identifies a workspace supported by the workspace factory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isWorkspace in interface IWorkspaceFactory

Parameters:

fileName - The fileName (in)

Returns:

The isWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

readConnectionPropertiesFromFile

public IPropertySet readConnectionPropertiesFromFile(String fileName)
                                              throws IOException,
                                                     AutomationException

The connection properties from the specified file.

Remarks

The filename parameter represents the pathname of a file that contains the connection information to be placed into the IPropertySet variable.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

readConnectionPropertiesFromFile in interface IWorkspaceFactory

Parameters:

fileName - The fileName (in)

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceDescription

public String getWorkspaceDescription(boolean plural)
                               throws IOException,
                                      AutomationException

A singular or plural description of the type of workspace the workspace factory opens/creates.

Product Availability

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

Specified by:

getWorkspaceDescription in interface IWorkspaceFactory

Parameters:

plural - The plural (in)

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceType

public int getWorkspaceType()
                     throws IOException,
                            AutomationException

The type of workspace the workspace factory opens/creates.

Remarks

The WorkspaceType property of a WorkspaceFactory returns information on the type of workspace managed by the WorkspaceFactory. Workspaces are classified into the following types specified by the esriWorkspaceType enumeration; FileSystemWorkspace, LocalDatabaseWorkspace, and RemoteDatabaseWorkspace.

See esriWorkspaceType for information on the types of workspaces.

Shapefiles workspaces are examples of FileSystemWorkspace. Personal and File Geodatabases are examples of LocalDatabaseWorkspace. An ArcSDE Geodatabase is an example of a RemoteDatabaseWorkspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceType in interface IWorkspaceFactory

Returns:

A com.esri.arcgis.geodatabase.esriWorkspaceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public boolean copy(IWorkspaceName workspaceName,
                    String destinationFolder,
                    IWorkspaceName[] workspaceNameCopy)
             throws IOException,
                    AutomationException

Copies a workspace to the specified destination folder.

Remarks

The Copy and Move methods can be used to copy or move workspaces or connection files between folders in the file system. The Boolean result indicates if the operation was successful. In the case of remote database workspaces, these operations work on the connection file representing the workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

copy in interface IWorkspaceFactory

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

destinationFolder - The destinationFolder (in)

workspaceNameCopy - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (out: use single element array)

Returns:

The successfulCopy

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

move

public boolean move(IWorkspaceName workspaceName,
                    String destinationFolder)
             throws IOException,
                    AutomationException

Moves a workspace to the specified destination folder.

Remarks

The Copy and Move methods can be used to copy or move workspaces or connection files between folders in the file system. The Boolean result indicates if the operation was successful. In the case of remote database workspaces, these operations work on the connection file representing the workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

move in interface IWorkspaceFactory

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

destinationFolder - The destinationFolder (in)

Returns:

The successfulMove

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteConnectionFile

public void deleteConnectionFile(String pathName)
                          throws IOException,
                                 AutomationException

Deletes the remote database workspace connection file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteConnectionFile in interface IRemoteDatabaseWorkspaceFactory

Parameters:

pathName - The pathName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

renameConnectionFile

public IWorkspaceName renameConnectionFile(String oldPathName,
                                           String newName)
                                    throws IOException,
                                           AutomationException

Renames the remote database workspace connection file.

Remarks

The oldPathName is the path and connection file name. the newName is the new file name without a path. An error is returned if newName has a fully qualified path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

renameConnectionFile in interface IRemoteDatabaseWorkspaceFactory

Parameters:

oldPathName - The oldPathName (in)

newName - The newName (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

editConnectionFile

public IWorkspaceName editConnectionFile(String pathName,
                                         int hWnd)
                                  throws IOException,
                                         AutomationException

Edits the properties of a remote database workspace connection file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

editConnectionFile in interface IRemoteDatabaseWorkspaceFactory

Parameters:

pathName - The pathName (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openWithNewPassword

public IWorkspace openWithNewPassword(IPropertySet connectionProperties,
                                      int hWnd,
                                      String newPassword)
                               throws IOException,
                                      AutomationException

Opens the workspace specified by the connection properties. Changes the connection password if it's expiring or expired.

Product Availability

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

Specified by:

openWithNewPassword in interface IEnterpriseWorkspaceFactory

Parameters:

connectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

hWnd - The hWnd (A COM typedef) (in)

newPassword - The newPassword (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openWithNewLicense

public IWorkspace openWithNewLicense(IPropertySet pConnectionProperties,
                                     int hWnd,
                                     String newLicensePath)
                              throws IOException,
                                     AutomationException

Open the enterprise database connection with new license file.

Product Availability

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

Specified by:

openWithNewLicense in interface IEnterpriseWorkspaceFactory

Parameters:

pConnectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

hWnd - The hWnd (A COM typedef) (in)

newLicensePath - The newLicensePath (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameters

public void setParameters(String server,
                          String instance,
                          String user,
                          String password,
                          String versName)
                   throws IOException,
                          AutomationException

Sets ArcSDE connection property parameters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setParameters in interface ISetDefaultConnectionInfo

Parameters:

server - The server (in)

instance - The instance (in)

user - The user (in)

password - The password (in)

versName - The versName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openFromString

public IWorkspace openFromString(String connectStr,
                                 int hWnd)
                          throws IOException,
                                 AutomationException

Opens the workspace specified by a connection string.

Remarks

The connect string is a collection of name value pairs separated by a semicolon (;).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

openFromString in interface IWorkspaceFactory2

Parameters:

connectStr - The connectStr (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearParameters

public void clearParameters(String server,
                            String instance)
                     throws IOException,
                            AutomationException

Clears ArcSDE connection property parameters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

clearParameters in interface ISetDefaultConnectionInfo2

Parameters:

server - The server (in)

instance - The instance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableSchemaCaching

public void enableSchemaCaching()
                         throws IOException,
                                AutomationException

All new workspaces handed out by the factory will have schema caching enabled.

Description

This method will enable chaching on any IWorkspace passed out by the workspace factory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

enableSchemaCaching in interface IWorkspaceFactorySchemaCache

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disableSchemaCaching

public void disableSchemaCaching()
                          throws IOException,
                                 AutomationException

All new workspaces handed out by the factory will not have schema caching enabled.

Description

This method disables schema caching on the workspace factory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

disableSchemaCaching in interface IWorkspaceFactorySchemaCache

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableSchemaCache

public void enableSchemaCache(IWorkspace workspace)
                       throws IOException,
                              AutomationException

Enable the schema cache for a specific workspace.

Description

The EnableSchemaCache method will enable the schema cache for one workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

enableSchemaCache in interface IWorkspaceFactorySchemaCache

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableAllSchemaCaches

public void enableAllSchemaCaches()
                           throws IOException,
                                  AutomationException

Enable the schema caches of all open workspaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

enableAllSchemaCaches in interface IWorkspaceFactorySchemaCache

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disableSchemaCache

public void disableSchemaCache(IWorkspace workspace)
                        throws IOException,
                               AutomationException

Disable the schema cache for a specific workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

disableSchemaCache in interface IWorkspaceFactorySchemaCache

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disableAllSchemaCaches

public void disableAllSchemaCaches()
                            throws IOException,
                                   AutomationException

Disable the schema caches of all open workspaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

disableAllSchemaCaches in interface IWorkspaceFactorySchemaCache

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSchemaCacheStale

public boolean isSchemaCacheStale(IWorkspace workspace)
                           throws IOException,
                                  AutomationException

Checks a specific schema cache for staleness.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSchemaCacheStale in interface IWorkspaceFactorySchemaCache

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Returns:

The isStale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAnySchemaCacheStale

public boolean isAnySchemaCacheStale()
                              throws IOException,
                                     AutomationException

Checks all current schema caches for staleness.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAnySchemaCacheStale in interface IWorkspaceFactorySchemaCache

Returns:

The isStale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshSchemaCache

public void refreshSchemaCache(IWorkspace workspace)
                        throws IOException,
                               AutomationException

Refreshes the schema cache for a specific workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

refreshSchemaCache in interface IWorkspaceFactorySchemaCache

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshAllSchemaCaches

public void refreshAllSchemaCaches()
                            throws IOException,
                                   AutomationException

Refreshes all current schema caches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

refreshAllSchemaCaches in interface IWorkspaceFactorySchemaCache

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceStatus

public IEnumWorkspaceStatus getWorkspaceStatus()
                                        throws IOException,
                                               AutomationException

Retrieve the workspace status information for all currently opened workspaces.

Product Availability

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

Specified by:

getWorkspaceStatus in interface IWorkspaceFactoryStatus

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumWorkspaceStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pingWorkspaceStatus

public IWorkspaceStatus pingWorkspaceStatus(IWorkspace workspace)
                                     throws IOException,
                                            AutomationException

Checks if the status of an esriWCSDown workspace has changed.

Product Availability

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

Specified by:

pingWorkspaceStatus in interface IWorkspaceFactoryStatus

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openAvailableWorkspace

public IWorkspace openAvailableWorkspace(IWorkspaceStatus wstatus)
                                  throws IOException,
                                         AutomationException

Makes an attempt to open a new instance of a workspace that is esriWCSDown but has since become esriWCSAvailable.

Product Availability

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

Specified by:

openAvailableWorkspace in interface IWorkspaceFactoryStatus

Parameters:

wstatus - A reference to a com.esri.arcgis.geodatabase.IWorkspaceStatus (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameters3

public void setParameters3(String server,
                           String instance,
                           String authenticationMode,
                           String userName,
                           String password,
                           String versionName,
                           Object historicalInfo)
                    throws IOException,
                           AutomationException

Sets ArcSDE connection property parameters.

Remarks

The SetParameters3 method extends the functionality present in SetParameters by allowing the Authentication Mode and Historical Info to be included as default connection properties.

Product Availability

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

Specified by:

setParameters3 in interface ISetDefaultConnectionInfo3

Parameters:

server - The server (in)

instance - The instance (in)

authenticationMode - The authenticationMode (in)

userName - The userName (in)

password - The password (in)

versionName - The versionName (in)

historicalInfo - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearParameters3

public void clearParameters3(String server,
                             String instance,
                             String authenticationMode)
                      throws IOException,
                             AutomationException

Clears ArcSDE connection property parameters.

Remarks

Clears parameters set by SetParameters3.

Product Availability

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

Specified by:

clearParameters3 in interface ISetDefaultConnectionInfo3

Parameters:

server - The server (in)

instance - The instance (in)

authenticationMode - The authenticationMode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.