com.esri.arcgis.system
Class AppLockMgr

java.lang.Object
  com.esri.arcgis.system.AppLockMgr

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IAppLockMgr, Serializable

public class AppLockMgr
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAppLockMgr

ESRI application lock manager.

Remarks

The AppLockMgr coclass is used to control locks on shapefiles and coverages, so no two users can make changes to the same dataset. It is pretty much the same idea as with relational database’s lock to prevent multiple users from making conflicting modifications to a set of data. Lock types are specified by esriLockMgrType enumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

AppLockMgr()
Constructs a AppLockMgr using ArcGIS Engine.

AppLockMgr(Object obj)
Construct a AppLockMgr using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	add(IAfLockMgr pAfLockMgr, int pID, int[] cookie) Adds an application reference to the lock manager.
void	checkLock(int cookie, String fileName, int lockMgrType) Checks for a lock within the lock manager.
void	clearLock(int cookie, String fileName, int lockMgrType) Clears a lock from within the lock manager.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getCount() The current count of locks within the lock manager.
int	hashCode() the hashcode for this object
void	isGlobalAlive(boolean[] pbGlobalAlive) Indicates if the global lock manager is active.
void	remove(int cookie) Removes a lock reference from the lock manager.
void	setLock(int cookie, String fileName, int lockMgrType) Places a lock within the lock manager.

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

AppLockMgr

public AppLockMgr()
           throws IOException,
                  UnknownHostException

Constructs a AppLockMgr using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AppLockMgr

public AppLockMgr(Object obj)
           throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems AppLockMgr theAppLockMgr = (AppLockMgr) obj;

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

add

public void add(IAfLockMgr pAfLockMgr,
                int pID,
                int[] cookie)
         throws IOException,
                AutomationException

Adds an application reference to the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IAppLockMgr

Parameters:

pAfLockMgr - A reference to a com.esri.arcgis.system.IAfLockMgr (in)

pID - The pID (in)

cookie - The cookie (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int cookie)
            throws IOException,
                   AutomationException

Removes a lock reference from the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IAppLockMgr

Parameters:

cookie - The cookie (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

The current count of locks within the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IAppLockMgr

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGlobalAlive

public void isGlobalAlive(boolean[] pbGlobalAlive)
                   throws IOException,
                          AutomationException

Indicates if the global lock manager is active.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isGlobalAlive in interface IAppLockMgr

Parameters:

pbGlobalAlive - The pbGlobalAlive (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLock

public void setLock(int cookie,
                    String fileName,
                    int lockMgrType)
             throws IOException,
                    AutomationException

Places a lock within the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLock in interface IAppLockMgr

Parameters:

cookie - The cookie (in)

fileName - The fileName (in)

lockMgrType - A com.esri.arcgis.system.esriLockMgrType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkLock

public void checkLock(int cookie,
                      String fileName,
                      int lockMgrType)
               throws IOException,
                      AutomationException

Checks for a lock within the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

checkLock in interface IAppLockMgr

Parameters:

cookie - The cookie (in)

fileName - The fileName (in)

lockMgrType - A com.esri.arcgis.system.esriLockMgrType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearLock

public void clearLock(int cookie,
                      String fileName,
                      int lockMgrType)
               throws IOException,
                      AutomationException

Clears a lock from within the lock manager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

clearLock in interface IAppLockMgr

Parameters:

cookie - The cookie (in)

fileName - The fileName (in)

lockMgrType - A com.esri.arcgis.system.esriLockMgrType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.