com.esri.arcgis.datasourcesGDB
Interface IDataServerManagerAdmin

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
DataServerManager, IDataServerManagerAdminProxy

public interface IDataServerManagerAdmin
extends java.io.Serializable

COM Interface 'IDataServerManagerAdmin'. Generated 3/19/2015 1:20:54 PM from 'C:\ArcGIS\COM\esriDataSourcesGDB.olb'

Description: 'Provides access to administration functions of a Data Server.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDdd374473_eda4_4a24_80f5_0b8c708a453b
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void analyze(java.lang.String gdbName)
          Updates the statistics for a Geodatabase.
 void attachGeodatabase(java.lang.String dbName, java.lang.String dataFileName, java.lang.String logFileName)
          Attachs an existing database to a server.
 boolean backupGeodatabase(java.lang.String gdbName, java.lang.String backupFileName, java.lang.String backupName, java.lang.String description)
          Performs a full backup on the specified Geodatabase.
 void createGeodatabase(java.lang.String gdbName, java.lang.String gdbFileName, int gdbFileSize, java.lang.String logFileName, int logFileSize)
          Creates a new Geodatabase.
 void createLogin(java.lang.String loginName, boolean isAdministrator)
          Creates a new login.
 IWorkspaceName createWorkspaceName(java.lang.String gdbName, java.lang.String versionPropName, java.lang.Object versionSpecifier)
          Creates a Workspace Name object to the Geodatabase.
 void deleteGeodatabase(java.lang.String gdbName)
          Deletes a Geodatabase.
 void deleteLogin(java.lang.String loginName)
          Deletes a login.
 void detachGeodatabase(java.lang.String dbName)
          Detachs a database from a server.
 int getConnectedUsers(java.lang.String dbName)
          Gets active users.
 void getDBProperties(java.lang.String dbName, java.lang.String[] status, int[] dbSize, java.lang.String[] owner, java.lang.Object[] createDate, java.lang.Object[] dbBackup)
          Returns various properties on a Database.
 void getFileProperties(java.lang.String dbName, java.lang.String[] dataName, java.lang.String[] dataPhysicalName, int[] dataFileSize, java.lang.String[] logName, java.lang.String[] logPhysicalName, int[] logFileSize)
          Return various properties on a database file.
 java.lang.String getGeodatabaseName(java.lang.String dataFileName)
          Returns the Database name from the database file.
 IEnumBSTR getGeodatabaseNames()
          Returns a list of Geodatabse names.
 void getLogins(IEnumBSTR[] loginNames, IEnumBSTR[] dbNames, IEnumBSTR[] loginTypes, IEnumBSTR[] languages)
          Returns a list logins and associated information.
 void getServerAdministrators(IEnumBSTR[] userNames)
          Gets a list of server administrators.
 void getUsersByPermissionType(java.lang.String dbName, int permission, IEnumBSTR[] userNames)
          Get Users in by the Permission type.
 boolean isConnectedUserAdministrator()
          Indicates whether the connected user is an administrator or not.
 void isSimpleRecoveryModel(java.lang.String gdbName, boolean[] isSimpleRecoveryModel)
          Returns whether the Geodatabase is in simple recovery model or not.
 void modifyGeodatabaseSecurity(java.lang.String dbName, java.lang.String loginName, int permission)
          Modify a login's database security.
 void modifyLoginSecurity(java.lang.String loginName, boolean isAdministrator)
          Modify a login's server security.
 void rebuildIndices(java.lang.String gdbName)
          Rebuilds the indices on all tables in a Geodatabase.
 void restoreGeodatabase(java.lang.String gdbName, java.lang.String backupFileName, java.lang.String dbFilePath)
          Restores a backup for the specified Geodatabase.
 void setGeodatabaseToSimpleRecoveryModel(java.lang.String gdbName)
          Sets a Geodatabase to simple recovery model.
 void shrinkGeodatabase(java.lang.String gdbName)
          Shrinks the size of a Geodatabase and frees up unused space.
 void upgradeGeoDatabase(java.lang.String gdbName)
          Upgrades a Geodatabase.
 void upgradeSDESchema(java.lang.String gdbName)
          Upgrades the SDE schema.
 

Field Detail

IIDdd374473_eda4_4a24_80f5_0b8c708a453b

static final int IIDdd374473_eda4_4a24_80f5_0b8c708a453b
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

createGeodatabase

void createGeodatabase(java.lang.String gdbName,
                       java.lang.String gdbFileName,
                       int gdbFileSize,
                       java.lang.String logFileName,
                       int logFileSize)
                       throws java.io.IOException,
                              AutomationException
Creates a new Geodatabase.

Parameters:
gdbName - The gdbName (in)
gdbFileName - The gdbFileName (in)
gdbFileSize - The gdbFileSize (in)
logFileName - The logFileName (in)
logFileSize - The logFileSize (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteGeodatabase

void deleteGeodatabase(java.lang.String gdbName)
                       throws java.io.IOException,
                              AutomationException
Deletes a Geodatabase.

Parameters:
gdbName - The gdbName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createLogin

void createLogin(java.lang.String loginName,
                 boolean isAdministrator)
                 throws java.io.IOException,
                        AutomationException
Creates a new login.

Parameters:
loginName - The loginName (in)
isAdministrator - The isAdministrator (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

modifyLoginSecurity

void modifyLoginSecurity(java.lang.String loginName,
                         boolean isAdministrator)
                         throws java.io.IOException,
                                AutomationException
Modify a login's server security.

Parameters:
loginName - The loginName (in)
isAdministrator - The isAdministrator (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

modifyGeodatabaseSecurity

void modifyGeodatabaseSecurity(java.lang.String dbName,
                               java.lang.String loginName,
                               int permission)
                               throws java.io.IOException,
                                      AutomationException
Modify a login's database security.

Parameters:
dbName - The dbName (in)
loginName - The loginName (in)
permission - A com.esri.arcgis.datasourcesGDB.esriGeodatabasePermissionsType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteLogin

void deleteLogin(java.lang.String loginName)
                 throws java.io.IOException,
                        AutomationException
Deletes a login.

Parameters:
loginName - The loginName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeodatabaseNames

IEnumBSTR getGeodatabaseNames()
                              throws java.io.IOException,
                                     AutomationException
Returns a list of Geodatabse names.

Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLogins

void getLogins(IEnumBSTR[] loginNames,
               IEnumBSTR[] dbNames,
               IEnumBSTR[] loginTypes,
               IEnumBSTR[] languages)
               throws java.io.IOException,
                      AutomationException
Returns a list logins and associated information.

Parameters:
loginNames - A reference to a com.esri.arcgis.system.IEnumBSTR (out: use single element array)
dbNames - A reference to a com.esri.arcgis.system.IEnumBSTR (out: use single element array)
loginTypes - A reference to a com.esri.arcgis.system.IEnumBSTR (out: use single element array)
languages - A reference to a com.esri.arcgis.system.IEnumBSTR (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

detachGeodatabase

void detachGeodatabase(java.lang.String dbName)
                       throws java.io.IOException,
                              AutomationException
Detachs a database from a server.

Parameters:
dbName - The dbName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

attachGeodatabase

void attachGeodatabase(java.lang.String dbName,
                       java.lang.String dataFileName,
                       java.lang.String logFileName)
                       throws java.io.IOException,
                              AutomationException
Attachs an existing database to a server.

Parameters:
dbName - The dbName (in)
dataFileName - The dataFileName (in)
logFileName - The logFileName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

upgradeGeoDatabase

void upgradeGeoDatabase(java.lang.String gdbName)
                        throws java.io.IOException,
                               AutomationException
Upgrades a Geodatabase.

Parameters:
gdbName - The gdbName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

upgradeSDESchema

void upgradeSDESchema(java.lang.String gdbName)
                      throws java.io.IOException,
                             AutomationException
Upgrades the SDE schema.

Parameters:
gdbName - The gdbName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeodatabaseName

java.lang.String getGeodatabaseName(java.lang.String dataFileName)
                                    throws java.io.IOException,
                                           AutomationException
Returns the Database name from the database file.

Parameters:
dataFileName - The dataFileName (in)
Returns:
The dbName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

backupGeodatabase

boolean backupGeodatabase(java.lang.String gdbName,
                          java.lang.String backupFileName,
                          java.lang.String backupName,
                          java.lang.String description)
                          throws java.io.IOException,
                                 AutomationException
Performs a full backup on the specified Geodatabase.

Parameters:
gdbName - The gdbName (in)
backupFileName - The backupFileName (in)
backupName - The backupName (in)
description - The description (in)
Returns:
The isSimpleRecoveryModel
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

restoreGeodatabase

void restoreGeodatabase(java.lang.String gdbName,
                        java.lang.String backupFileName,
                        java.lang.String dbFilePath)
                        throws java.io.IOException,
                               AutomationException
Restores a backup for the specified Geodatabase.

Parameters:
gdbName - The gdbName (in)
backupFileName - The backupFileName (in)
dbFilePath - The dbFilePath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSimpleRecoveryModel

void isSimpleRecoveryModel(java.lang.String gdbName,
                           boolean[] isSimpleRecoveryModel)
                           throws java.io.IOException,
                                  AutomationException
Returns whether the Geodatabase is in simple recovery model or not.

Parameters:
gdbName - The gdbName (in)
isSimpleRecoveryModel - The isSimpleRecoveryModel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeodatabaseToSimpleRecoveryModel

void setGeodatabaseToSimpleRecoveryModel(java.lang.String gdbName)
                                         throws java.io.IOException,
                                                AutomationException
Sets a Geodatabase to simple recovery model.

Parameters:
gdbName - The gdbName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isConnectedUserAdministrator

boolean isConnectedUserAdministrator()
                                     throws java.io.IOException,
                                            AutomationException
Indicates whether the connected user is an administrator or not.

Returns:
The isAdministrator
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createWorkspaceName

IWorkspaceName createWorkspaceName(java.lang.String gdbName,
                                   java.lang.String versionPropName,
                                   java.lang.Object versionSpecifier)
                                   throws java.io.IOException,
                                          AutomationException
Creates a Workspace Name object to the Geodatabase.

Parameters:
gdbName - The gdbName (in)
versionPropName - The versionPropName (in)
versionSpecifier - A Variant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspaceName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDBProperties

void getDBProperties(java.lang.String dbName,
                     java.lang.String[] status,
                     int[] dbSize,
                     java.lang.String[] owner,
                     java.lang.Object[] createDate,
                     java.lang.Object[] dbBackup)
                     throws java.io.IOException,
                            AutomationException
Returns various properties on a Database.

Parameters:
dbName - The dbName (in)
status - The status (out: use single element array)
dbSize - The dbSize (out: use single element array)
owner - The owner (out: use single element array)
createDate - A Variant (out: use single element array)
dbBackup - A Variant (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFileProperties

void getFileProperties(java.lang.String dbName,
                       java.lang.String[] dataName,
                       java.lang.String[] dataPhysicalName,
                       int[] dataFileSize,
                       java.lang.String[] logName,
                       java.lang.String[] logPhysicalName,
                       int[] logFileSize)
                       throws java.io.IOException,
                              AutomationException
Return various properties on a database file.

Parameters:
dbName - The dbName (in)
dataName - The dataName (out: use single element array)
dataPhysicalName - The dataPhysicalName (out: use single element array)
dataFileSize - The dataFileSize (out: use single element array)
logName - The logName (out: use single element array)
logPhysicalName - The logPhysicalName (out: use single element array)
logFileSize - The logFileSize (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

analyze

void analyze(java.lang.String gdbName)
             throws java.io.IOException,
                    AutomationException
Updates the statistics for a Geodatabase.

Parameters:
gdbName - The gdbName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rebuildIndices

void rebuildIndices(java.lang.String gdbName)
                    throws java.io.IOException,
                           AutomationException
Rebuilds the indices on all tables in a Geodatabase.

Parameters:
gdbName - The gdbName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

shrinkGeodatabase

void shrinkGeodatabase(java.lang.String gdbName)
                       throws java.io.IOException,
                              AutomationException
Shrinks the size of a Geodatabase and frees up unused space.

Parameters:
gdbName - The gdbName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConnectedUsers

int getConnectedUsers(java.lang.String dbName)
                      throws java.io.IOException,
                             AutomationException
Gets active users.

Parameters:
dbName - The dbName (in)
Returns:
The nUsers
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerAdministrators

void getServerAdministrators(IEnumBSTR[] userNames)
                             throws java.io.IOException,
                                    AutomationException
Gets a list of server administrators.

Parameters:
userNames - A reference to a com.esri.arcgis.system.IEnumBSTR (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUsersByPermissionType

void getUsersByPermissionType(java.lang.String dbName,
                              int permission,
                              IEnumBSTR[] userNames)
                              throws java.io.IOException,
                                     AutomationException
Get Users in by the Permission type.

Parameters:
dbName - The dbName (in)
permission - A com.esri.arcgis.datasourcesGDB.esriGeodatabasePermissionsType constant (in)
userNames - A reference to a com.esri.arcgis.system.IEnumBSTR (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.