com.esri.arcgis.datasourcesGDB
Class IDataServerManagerProxy

java.lang.Object
  extended bycom.esri.arcgis.interop.Dispatch
      extended bycom.esri.arcgis.datasourcesGDB.IDataServerManagerProxy
All Implemented Interfaces:
java.io.Externalizable, IDataServerManager, java.io.Serializable

public class IDataServerManagerProxy
extends Dispatch
implements IDataServerManager, java.io.Serializable

Initializes DataServerManager object.

Product Availability

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

See Also:
Serialized Form

Field Summary
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF
 
Constructor Summary
  IDataServerManagerProxy()
          For internal use only
  IDataServerManagerProxy(java.lang.Object obj)
           
protected IDataServerManagerProxy(java.lang.Object obj, java.lang.String iid)
           
  IDataServerManagerProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
           
protected IDataServerManagerProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Adds a Java object to be a listener for a specific kind of event generated by the COM object.
 void connect()
          Connects to an initialized Data Server.
 java.lang.String createConnectionFile(java.lang.String pathName, java.lang.String serverName)
          Create a Data Server connection file
 void disconnect()
          Disconnects from the Data Server.
 int getAvailableMemory()
          Returns the total available memory (MB).
 int getDataServerClass()
          Returns the server class.
 int getDataServerType()
          Returns the type of data server.
 java.lang.String getProductName()
          Returns the product name.
 java.lang.String getProductVersion()
          Returns the product version.
 java.lang.String getServerName()
          Sets the data server name.
 void initFromFile(java.lang.String gdsFileName)
          Initializes a saved connection to the GIS Data Server.
 boolean isConnected()
          Gets whether the server is connected or not
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Removes a Java object as a listener to events generated by a COM object.
 void setServerName(java.lang.String serverName)
          Sets the data server name.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass
Constructor Detail

IDataServerManagerProxy

public IDataServerManagerProxy(java.lang.String CLSID,
                               java.lang.String host,
                               AuthInfo authInfo)
                        throws java.net.UnknownHostException,
                               java.io.IOException

IDataServerManagerProxy

public IDataServerManagerProxy()
For internal use only


IDataServerManagerProxy

public IDataServerManagerProxy(java.lang.Object obj)
                        throws java.io.IOException

IDataServerManagerProxy

protected IDataServerManagerProxy(java.lang.Object obj,
                                  java.lang.String iid)
                           throws java.io.IOException

IDataServerManagerProxy

protected IDataServerManagerProxy(java.lang.String CLSID,
                                  java.lang.String iid,
                                  java.lang.String host,
                                  AuthInfo authInfo)
                           throws java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Description copied from class: Dispatch
Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
addListener in class Dispatch
Parameters:
iidStr - the ID of the outgoing interface, implemented by the listener
theListener - the object to be informed of the events
theSource - the proxy class that represents the COM class that is the source of the events
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Description copied from class: Dispatch
Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
removeListener in class Dispatch
Parameters:
iidStr - the ID of the outgoing interface, implemented by the listener
theListener - the object that no longer wishes to be informed of the events
Throws:
java.io.IOException

connect

public void connect()
             throws java.io.IOException,
                    AutomationException
Description copied from interface: IDataServerManager
Connects to an initialized Data Server.

Description

This function connects to a Database Server.

Remarks

The DataServerManager must be initialized by using put_ServerName or InitFromFile.  You must already be a user on the server, with the appropriate permissions, in order to connect to it.

Specified by:
connect in interface IDataServerManager
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

disconnect

public void disconnect()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IDataServerManager
Disconnects from the Data Server.

Description

This function disconnects from a Database Server.

Specified by:
disconnect in interface IDataServerManager
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setServerName

public void setServerName(java.lang.String serverName)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IDataServerManager
Sets the data server name.

Specified by:
setServerName in interface IDataServerManager
Parameters:
serverName - The serverName (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getServerName

public java.lang.String getServerName()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IDataServerManager
Sets the data server name.

Remarks

The ServerName property is used to return or set the name of the server of the Data Server Manager, for example; “myserver/sqlexpress”.  The ServerName value is used with the CreateConnectionFile method.  Setting the ServerName property is one method for initializing the DataServerManager before connecting to the Database Server.

Specified by:
getServerName in interface IDataServerManager
Returns:
The serverName
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

initFromFile

public void initFromFile(java.lang.String gdsFileName)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IDataServerManager
Initializes a saved connection to the GIS Data Server.

Description

This method initializes a Data Server from a Database Server connection file (.gds).

Remarks

The .gds file is created using the Add Database Server option in ArcCatalog, or the CreateConnectionFile method.

Specified by:
initFromFile in interface IDataServerManager
Parameters:
gdsFileName - The gdsFileName (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

createConnectionFile

public java.lang.String createConnectionFile(java.lang.String pathName,
                                             java.lang.String serverName)
                                      throws java.io.IOException,
                                             AutomationException
Description copied from interface: IDataServerManager
Create a Data Server connection file

Remarks

Creates a Database Server connection file (.gds).

Specified by:
createConnectionFile in interface IDataServerManager
Parameters:
pathName - The pathName (in)
serverName - The serverName (in)
Returns:
The connFileName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isConnected

public boolean isConnected()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IDataServerManager
Gets whether the server is connected or not

Specified by:
isConnected in interface IDataServerManager
Returns:
The isConnected
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getDataServerType

public int getDataServerType()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IDataServerManager
Returns the type of data server.

Description

This method returns the type of the database server (DataServerType).

Specified by:
getDataServerType in interface IDataServerManager
Returns:
A com.esri.arcgis.datasourcesGDB.esriDataServerType constant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getProductName

public java.lang.String getProductName()
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IDataServerManager
Returns the product name.

Remarks

This method returns the product name for the underlying database server.  For example; “Microsoft SQL Server Express Edition”.

Specified by:
getProductName in interface IDataServerManager
Returns:
The name
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getProductVersion

public java.lang.String getProductVersion()
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: IDataServerManager
Returns the product version.

Remarks

This return returns the version of the underlying database server.  For example; “9.00.1399.06”.

Specified by:
getProductVersion in interface IDataServerManager
Returns:
The version
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getAvailableMemory

public int getAvailableMemory()
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IDataServerManager
Returns the total available memory (MB).

Remarks

This function returns the available physical RAM on the database server.  This is the total memory that is available to the database server, including memory that may already be in use, either by the database server or other applications.

Specified by:
getAvailableMemory in interface IDataServerManager
Returns:
The memory
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataServerClass

public int getDataServerClass()
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IDataServerManager
Returns the server class.

Specified by:
getDataServerClass in interface IDataServerManager
Returns:
A com.esri.arcgis.geodatabase.esriGeodatabaseServerClassType constant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.