com.eviware.soapui.plugins.vcs

Interface LockHandler

public interface LockHandler

Defines a facade for VCS locking operations.

Method Summary

Modifier and Type	Method and Description
String	getLockedBy(File file) Retrieve the name of the user holding the lock of a particular file.
LockStatus	getLockStatusFor(File file) Get the locking status of a particular file.
LockStatus	lock(File fileToLock) Locks a file so that it can changed exclusively by the lock holder.
LockStatus	unlock(File fileToUnlock) Releases the lock of a file so that others can modify it.

Method Detail

lock

LockStatus lock(File fileToLock)

Locks a file so that it can changed exclusively by the lock holder.

Parameters:

fileToLock - the file to lock

Returns:

the status after the operation

Throws:

VcsIntegrationException - if there is a communication failure with the remote repository

unlock

LockStatus unlock(File fileToUnlock)

Releases the lock of a file so that others can modify it.

Parameters:

fileToUnlock - the file to unlock

Returns:

the status after the operation

Throws:

VcsIntegrationException - if the file cannot be unlocked or there is a communication failure with the remote repository

getLockStatusFor

LockStatus getLockStatusFor(File file)

Get the locking status of a particular file.

Parameters:

file - the file for which to check the lock status

Returns:

a status object describing the locking status of the file

Throws:

VcsIntegrationException - if there is a communication failure with the remote repository

getLockedBy

String getLockedBy(File file)

Retrieve the name of the user holding the lock of a particular file.

Parameters:

file - the file to check status for

Returns:

a string representing the user who has the lock for this file or null if the file is not locked

Throws:

VcsIntegrationException - if there is a communication failure with the remote repository