org.mule.extension.file.common.api

Class AbstractExternalFileSystem

java.lang.Object

org.mule.extension.file.common.api.AbstractFileSystem

org.mule.extension.file.common.api.AbstractExternalFileSystem

All Implemented Interfaces:

ExternalFileSystem, FileSystem

public abstract class AbstractExternalFileSystem
extends AbstractFileSystem
implements ExternalFileSystem

Interface that allows to obtain a UriLock on a uri given as a URI.

Since:

1.3.0

Constructor Summary

Constructors

Constructor and Description
AbstractExternalFileSystem(String baseUri)

Method Summary

Modifier and Type	Method and Description
protected void	acquireLock(PathLock path) Attempts to lock the given lock and throws FileLockedException if already locked
protected void	acquireLock(UriLock lock) Attempts to lock the given lock and throws FileLockedException if already locked
protected PathLock	createLock(Path path)
protected abstract UriLock	createLock(URI uri)
protected boolean	isLocked(Path path) Try to acquire a lock on a file and release it immediately.
protected boolean	isLocked(URI uri) Try to acquire a lock on a file and release it immediately.
PathLock	lock(Path path) Acquires and returns lock over the given path.
UriLock	lock(URI uri) Acquires and returns lock over the given uri.
void	verifyNotLocked(Path path) Verify that the given path is not locked
void	verifyNotLocked(URI uri) Verify that the given uri is not locked

Methods inherited from class org.mule.extension.file.common.api.AbstractFileSystem

copy, createDirectory, createMuleLock, delete, getBasePath, getCopyCommand, getCreateDirectoryCommand, getDeleteCommand, getFileMessageMediaType, getListCommand, getMoveCommand, getReadCommand, getRenameCommand, getWriteCommand, list, list, move, read, read, rename, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.extension.file.common.api.FileSystem

changeToBaseDir, copy, createDirectory, createMuleLock, delete, getBasePath, getFileMessageMediaType, list, list, move, read, read, rename, write, write

Constructor Detail

AbstractExternalFileSystem

public AbstractExternalFileSystem(String baseUri)

Method Detail

lock

public final UriLock lock(URI uri)

Acquires and returns lock over the given uri.

Depending on the underlying filesystem, the extent of the lock will depend on the implementation. If a lock can not be acquired, then an IllegalStateException is thrown.

Whoever request the lock MUST release it as soon as possible.

Specified by:

lock in interface ExternalFileSystem

Parameters:

uri - the uri to the file you want to lock

Returns:

an acquired UriLock

Throws:

IllegalArgumentException - if a lock could not be acquired

acquireLock

protected void acquireLock(UriLock lock)

Attempts to lock the given lock and throws FileLockedException if already locked

Parameters:

lock - the UriLock to be acquired

Throws:

FileLockedException - if the lock is already acquired

isLocked

protected boolean isLocked(URI uri)

Try to acquire a lock on a file and release it immediately. Usually used as a quick check to see if another process is still holding onto the file, e.g. a large file (more than 100MB) is still being written to.

verifyNotLocked

public void verifyNotLocked(URI uri)

Verify that the given uri is not locked

Specified by:

verifyNotLocked in interface ExternalFileSystem

Parameters:

uri - the uri to test

Throws:

IllegalStateException - if the uri is indeed locked

createLock

protected abstract UriLock createLock(URI uri)

Parameters:

uri - of the file to lock.

Returns:

a UriLock on the given uri.

lock

public PathLock lock(Path path)

Description copied from class: AbstractFileSystem

Acquires and returns lock over the given path.

Depending on the underlying filesystem, the extent of the lock will depend on the implementation. If a lock can not be acquired, then an IllegalStateException is thrown.

Whoever request the lock MUST release it as soon as possible.

Specified by:

lock in interface FileSystem

Overrides:

lock in class AbstractFileSystem

Parameters:

path - the path to the file you want to lock

Returns:

an acquired PathLock

verifyNotLocked

public final void verifyNotLocked(Path path)

Description copied from class: AbstractFileSystem

Verify that the given path is not locked

Specified by:

verifyNotLocked in interface FileSystem

Overrides:

verifyNotLocked in class AbstractFileSystem

Parameters:

path - the path to test

isLocked

protected final boolean isLocked(Path path)

Description copied from class: AbstractFileSystem

Try to acquire a lock on a file and release it immediately. Usually used as a quick check to see if another process is still holding onto the file, e.g. a large file (more than 100MB) is still being written to.

Overrides:

isLocked in class AbstractFileSystem

acquireLock

protected final void acquireLock(PathLock path)

Description copied from class: AbstractFileSystem

Attempts to lock the given lock and throws FileLockedException if already locked

Overrides:

acquireLock in class AbstractFileSystem

Parameters:

path - the PathLock to be acquired

createLock

protected final PathLock createLock(Path path)

Specified by:

createLock in class AbstractFileSystem