org.apache.james.filesystem.api

Interface FileSystem

All Known Implementing Classes:

FileSystemImpl, ResourceLoaderFileSystem

public interface FileSystem

This service is used by components that wants to lookup a File resource from the application folder.

Since:

James 2.4

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASSPATH_PROTOCOL Prefix for loading of the classpath
static String	FILE_PROTOCOL Prefix for loading of a filesystem based on the current directory
static String	FILE_PROTOCOL_ABSOLUTE Prefix for loading of a filesystem using the absolute path
static String	FILE_PROTOCOL_AND_CONF Prefix for loading of the config directory
static String	FILE_PROTOCOL_AND_VAR Prefix for loading of the var directory

Method Summary

Methods

Modifier and Type	Method and Description
File	getBasedir() Return the base folder used by the application
File	getFile(String fileURL) Used to retrieve a specific file in the application context
InputStream	getResource(String url) to retrieve a resource.

Field Detail

FILE_PROTOCOL

static final String FILE_PROTOCOL

Prefix for loading of a filesystem based on the current directory

See Also:

Constant Field Values

FILE_PROTOCOL_ABSOLUTE

static final String FILE_PROTOCOL_ABSOLUTE

Prefix for loading of a filesystem using the absolute path

See Also:

Constant Field Values

FILE_PROTOCOL_AND_CONF

static final String FILE_PROTOCOL_AND_CONF

Prefix for loading of the config directory

See Also:

Constant Field Values

FILE_PROTOCOL_AND_VAR

static final String FILE_PROTOCOL_AND_VAR

Prefix for loading of the var directory

See Also:

Constant Field Values

CLASSPATH_PROTOCOL

static final String CLASSPATH_PROTOCOL

Prefix for loading of the classpath

See Also:

Constant Field Values

Method Detail

getResource

InputStream getResource(String url)
                        throws IOException

to retrieve a resource. this is typically a file resource, but depending on the implementation, this could also be from classpath or from another source.

Parameters:

url - the url of the resource

Returns:

the resource as an input stream

Throws:

IOException - if the resource could not be accessed

getFile

File getFile(String fileURL)
             throws FileNotFoundException

Used to retrieve a specific file in the application context

Parameters:

fileURL - file

Returns:

the File found

Throws:

FileNotFoundException - if the file cannot be found/read

getBasedir

File getBasedir()
                throws FileNotFoundException

Return the base folder used by the application

Throws:

FileNotFoundException