Package com.luciad.ogc.wfs

Class TLcdWFSLockManager

java.lang.Object

com.luciad.ogc.wfs.TLcdWFSLockManager

public class TLcdWFSLockManager
extends Object

A manager which enables management of locks.

This lock manager uses ILcdWFSLockFactory to create locks. Custom lock factory implementations can be inserted through the factory method ALcdOGCWFSCommandDispatcherFactory.createLockFactory(ILcdWFSFilteredModelFactory).

Since:

10.0

See Also:

• ALcdOGCWFSCommandDispatcherFactory
• ILcdWFSLockFactory

Method Summary

Modifier and Type	Method	Description
boolean	canCreateLock(TLcdWFSRequestContext aContext)	If a valid ALcdWFSLock can be created for the request associated with aContext.
ALcdWFSLock	createLock(long aExpiry)	Creates a new lock with the given expiry time.
ALcdWFSLock	getLock(String aLockId)	Returns the lock with the given id or null in case null is supplied.
void	releaseLock(ALcdWFSLock aLock)	Releases the given lock and unlocks all features which it currently locks.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

canCreateLock

public boolean canCreateLock(TLcdWFSRequestContext aContext)

If a valid ALcdWFSLock can be created for the request associated with aContext. This can depend on if locking is enabled or not for a service. The default implementation always returns true.

Parameters:

aContext - A context object containing information about the request for which the handler should be created.

Returns:

If a valid ALcdWFSLock that can be created for the request associated with aContext.

Since:

2024.1

createLock

public ALcdWFSLock createLock(long aExpiry)

Creates a new lock with the given expiry time. This method also performs a review of existing locks managed by this lock manager. All locks that are no longer valid are released.

Parameters:

aExpiry - an expiry time in seconds.

Returns:

a new lock.

releaseLock

public void releaseLock(ALcdWFSLock aLock)

Releases the given lock and unlocks all features which it currently locks. The given lock can no longer be used after this method has been called.

Parameters:

aLock - the lock to release.

getLock

public ALcdWFSLock getLock(String aLockId)
                    throws TLcdWFSServiceException

Returns the lock with the given id or null in case null is supplied. If the given id is not null but it does not exist in this lock manager, a TLcdWFSServiceException is thrown. In all cases, a review of existing locks managed by this lock manager is done. All locks that are no longer valid are released.

Parameters:

aLockId - a valid lock id or null

Returns:

the ALcdWFSLock that corresponds to the given lock id or null if the given lock id is null

Throws:

TLcdWFSServiceException - if no lock could be found for the given lock id.