org.mule.extension.file.common.api

Interface ExternalFileSystem

All Superinterfaces:

FileSystem

All Known Implementing Classes:

AbstractExternalFileSystem

public interface ExternalFileSystem
extends FileSystem

Represents an external file system and the operations which can be performed on it.

This interface acts as a facade which allows performing common file operations for files outside a local disk, like in a an FTP server, a cloud storage service, etc, and uses URI to identify files.

Since:

1.3.0

Method Summary

Modifier and Type	Method and Description
UriLock	lock(URI uri) Acquires and returns lock over the given uri.
void	verifyNotLocked(URI uri) Verify that the given uri is not locked

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

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

Method Detail

lock

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.

Parameters:

uri - the uri to the file you want to lock

Returns:

an acquired UriLock

Throws:

IllegalArgumentException - if a lock could not be acquired

verifyNotLocked

void verifyNotLocked(URI uri)

Verify that the given uri is not locked

Parameters:

uri - the uri to test

Throws:

IllegalStateException - if the uri is indeed locked