com.esri.arcgis.geodatabase
Interface IDatabaseConnectionInfo3

All Superinterfaces:

IDatabaseConnectionInfo, IDatabaseConnectionInfo2, Serializable

All Known Subinterfaces:

IDatabaseConnectionInfo4

public interface IDatabaseConnectionInfo3
extends IDatabaseConnectionInfo2, Serializable

Provides access to members that provide information about the Workspace's connected database.

Product Availability

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

Method Summary

void	disconnectUser(int sessionID) Disconnect a user connection to the database.
String	getConnectedDatabaseEx() The name of the connected database.
IEnumUserInfo	getConnectedUsers() The current connections to the database.
boolean	isAcceptingConnections() Is the database accepting connections.
void	setIsAcceptingConnections(boolean acceptingConnections) Is the database accepting connections.

Methods inherited from interface com.esri.arcgis.geodatabase.IDatabaseConnectionInfo2

getConnectionCurrentDateTime, getConnectionDBMS, getConnectionServer, getGeodatabaseServerClass

Methods inherited from interface com.esri.arcgis.geodatabase.IDatabaseConnectionInfo

getConnectedDatabase, getConnectedUser

Method Detail

getConnectedUsers

IEnumUserInfo getConnectedUsers()
                                throws IOException,
                                       AutomationException

The current connections to the database.

Description

The get_ConnectedUsers method will return an enumeration of IUserInfo objects corresponding to the currently connected users in the Enterprise Geodatabase. You must be the Geodatabase Administrator to call this method.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnectUser

void disconnectUser(int sessionID)
                    throws IOException,
                           AutomationException

Disconnect a user connection to the database.

Description

The DisconnectUser method will disconnect a user from the Enterprise Geodatabase based on Session ID. The Session ID can be retrieved from a IUserInfo object returned from the call to get_ConnectedUsers or from an IDatabaseLockInfo object returned from IDatabaseLocksInfo. You must be the Geodatabase Administrator to call this method.

Product Availability

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

Parameters:

sessionID - The sessionID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsAcceptingConnections

void setIsAcceptingConnections(boolean acceptingConnections)
                               throws IOException,
                                      AutomationException

Is the database accepting connections.

Description

This property controls if the Enterprise Geodatabase is accepting new connections. If set to False the Enterprise Geodatabase will block any new connections from users who are not the Geodatabase Administrator. You must be the Geodatabase Administrator to alter this property.

Product Availability

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

Parameters:

acceptingConnections - The acceptingConnections (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAcceptingConnections

boolean isAcceptingConnections()
                               throws IOException,
                                      AutomationException

Is the database accepting connections.

Description

This property controls if the Enterprise Geodatabase is accepting new connections. If set to False the Enterprise Geodatabase will block any new connections from users who are not the Geodatabase Administrator. You must be the Geodatabase Administrator to alter this property.

Product Availability

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

Returns:

The acceptingConnections

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectedDatabaseEx

String getConnectedDatabaseEx()
                              throws IOException,
                                     AutomationException

The name of the connected database. It may be different from the DATABASE property in the workspace's connection properties. Works on Oracle.

Description

Returns the name of the connected database for all supported databases. IDatabaseConnectionInfo3.ConnectedDatabaseEx should be used to determine the connected database name when performing administration tasks.

IDatabaseConnectionInfo2.ConnectedDatabase should be used if manually preparing table name qualifications. ConnectedDatabase will not return the database for Oracle databases; tables would not be found if the table name is prefixed with the database when using Oracle, see ISQLSyntax.QualifyTableName

Product Availability

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

Returns:

The connectedDatabase

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.