com.inductiveautomation.ignition.client.gateway_interface

Interface ResourceLockManager

All Known Subinterfaces:

DesignerContext, DesignerProjectContext

All Known Implementing Classes:

DesignerContextImpl, DesignerContextImpl.DesignerProjectHolderImpl, DesignerContextProxy

public interface ResourceLockManager

The ResourceLockManager, as its name suggests, manages the locking of resources for editing. This prevents multiple entities from modifying the resource at the same time, which can have unpredictable results from the user's point of view. The ResourceLockManager is generally obtained through the ResourceLockManagerFactory.

Method Summary

Modifier and Type	Method and Description
boolean	hasLock(long resourceId) Checks to see if the given lock is currently held, which means either: it has been obtained but not released (it is open) It has been obtained, modified, and then released, but a save operation has not occurred.
boolean	isLockModified(long resourceId) Returns true if the lock has been obtained and updated
boolean	isLockOpen(long resourceId) Returns true if the lock has been obtained and not released
long	newResourceId() Creates and obtains the lock for a new resource id
void	releaseLock(long resourceId) Designer elements should call this function when they are done with the resource that they obtained a lock for.
boolean	requestLock(long resourceId) Requests the lock for the given resource.
boolean	requestLockQuietly(long resourceId) Just like requestLock, except that if the lock isn't obtained, no error message is displayed.
void	synchLocks() Attempts to re-obtain all locks that this resource lock manager currently has.
boolean	updateLock(long resourceId) Designer elements should call this function when they have actually updated the resource with the given ID.

Method Detail

requestLock

boolean requestLock(long resourceId)

Requests the lock for the given resource. If the lock is obtained, true is returned. If the lock isn't able to be obtained, false is returned.

Parameters:

resourceId -

Returns:

requestLockQuietly

boolean requestLockQuietly(long resourceId)

Just like requestLock, except that if the lock isn't obtained, no error message is displayed.

updateLock

boolean updateLock(long resourceId)

Designer elements should call this function when they have actually updated the resource with the given ID. Note that you MUST have the lock before updating the resource!

Parameters:

resourceId -

Returns:

True if we still have the lock.

releaseLock

void releaseLock(long resourceId)

Designer elements should call this function when they are done with the resource that they obtained a lock for. Note that you must have the lock for the resource before releasing it!

Parameters:

resourceId -

hasLock

boolean hasLock(long resourceId)

Checks to see if the given lock is currently held, which means either:

1. it has been obtained but not released (it is open)
2. It has been obtained, modified, and then released, but a save operation has not occurred.

isLockModified

boolean isLockModified(long resourceId)

Returns true if the lock has been obtained and updated

isLockOpen

boolean isLockOpen(long resourceId)

Returns true if the lock has been obtained and not released

synchLocks

void synchLocks()

Attempts to re-obtain all locks that this resource lock manager currently has. Used in situations where the gateway has lost our lock set. (re-connections)

newResourceId

long newResourceId()
            throws java.lang.Exception

Creates and obtains the lock for a new resource id

Throws:

java.lang.Exception