org.apache.james.filesystem.api

Class SieveFileRepository

java.lang.Object

org.apache.james.filesystem.api.SieveFileRepository

All Implemented Interfaces:

org.apache.james.managesieve.api.SieveRepository

public class SieveFileRepository
extends Object
implements org.apache.james.managesieve.api.SieveRepository

SieveFileRepository manages sieve scripts stored on the file system.

The sieve root directory is a sub-directory of the application base directory named "sieve". Scripts are stored in sub-directories of the sieve root directory, each with the name of the associated user.

Constructor Summary

Constructors

Constructor and Description
SieveFileRepository() Creates a new instance of SieveFileRepository.
SieveFileRepository(FileSystem fileSystem) Creates a new instance of SieveFileRepository.

Method Summary

Methods

Modifier and Type	Method and Description
void	addUser(String user)
void	deleteScript(String user, String name)
String	getActive(String user)
protected File	getActiveFile(String user)
long	getQuota()
long	getQuota(String user)
protected File	getQuotaFile()
protected File	getQuotaFile(String user)
String	getScript(String user, String name)
protected File	getScriptFile(String user, String name)
protected File	getSieveRootDirectory()
protected File	getUserDirectory(String user)
protected File	getUserDirectoryFile(String user)
boolean	hasQuota()
boolean	hasQuota(String user)
boolean	hasUser(String user)
void	haveSpace(String user, String name, long size) The default quota, if any, is stored in file '.quota' in the sieve root directory.
protected boolean	isActiveFile(String user, File file)
List<org.apache.james.managesieve.api.ScriptSummary>	listScripts(String user)
void	putScript(String user, String name, String content)
void	removeQuota()
void	removeQuota(String user)
void	removeUser(String user)
void	renameScript(String user, String oldName, String newName)
void	setActive(String user, String name)
protected void	setActiveFile(File activeFile, boolean isActive)
void	setFileSystem(FileSystem fileSystem)
void	setQuota(long quota)
void	setQuota(String user, long quota)
protected static void	toFile(File file, String content)
protected static String	toString(File file, String encoding) Read a file with the specified encoding into a String

Methods inherited from class java.lang.Object

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

Constructor Detail

SieveFileRepository

public SieveFileRepository()

Creates a new instance of SieveFileRepository.

SieveFileRepository

public SieveFileRepository(FileSystem fileSystem)

Creates a new instance of SieveFileRepository.

Parameters:

fileSystem -

Method Detail

toString

protected static String toString(File file,
              String encoding)
                          throws FileNotFoundException

Read a file with the specified encoding into a String

Parameters:

file -

encoding -

Returns:

Throws:

FileNotFoundException

toFile

protected static void toFile(File file,
          String content)
                      throws org.apache.james.managesieve.api.StorageException

Throws:

org.apache.james.managesieve.api.StorageException

setFileSystem

public void setFileSystem(FileSystem fileSystem)

deleteScript

public void deleteScript(String user,
                String name)
                  throws org.apache.james.managesieve.api.UserNotFoundException,
                         org.apache.james.managesieve.api.ScriptNotFoundException,
                         org.apache.james.managesieve.api.IsActiveException,
                         org.apache.james.managesieve.api.StorageException

Specified by:

deleteScript in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.StorageException

org.apache.james.managesieve.api.UserNotFoundException

org.apache.james.managesieve.api.ScriptNotFoundException

org.apache.james.managesieve.api.IsActiveException

See Also:

SieveRepository.deleteScript(java.lang.String, java.lang.String)

getScript

public String getScript(String user,
               String name)
                 throws org.apache.james.managesieve.api.UserNotFoundException,
                        org.apache.james.managesieve.api.ScriptNotFoundException

Specified by:

getScript in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.UserNotFoundException

org.apache.james.managesieve.api.ScriptNotFoundException

See Also:

SieveRepository.getScript(java.lang.String, java.lang.String)

haveSpace

public void haveSpace(String user,
             String name,
             long size)
               throws org.apache.james.managesieve.api.UserNotFoundException,
                      org.apache.james.managesieve.api.QuotaExceededException

The default quota, if any, is stored in file '.quota' in the sieve root directory. Quotas for specific users are stored in file '.quota' in the user's directory.

The '.quota' file contains a single positive integer value representing the quota in octets.

Specified by:

haveSpace in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.UserNotFoundException

org.apache.james.managesieve.api.QuotaExceededException

See Also:

SieveRepository.haveSpace(java.lang.String, java.lang.String, long)

listScripts

public List<org.apache.james.managesieve.api.ScriptSummary> listScripts(String user)
                                                                 throws org.apache.james.managesieve.api.UserNotFoundException

Specified by:

listScripts in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.UserNotFoundException

See Also:

SieveRepository.listScripts(java.lang.String)

putScript

public void putScript(String user,
             String name,
             String content)
               throws org.apache.james.managesieve.api.UserNotFoundException,
                      org.apache.james.managesieve.api.StorageException,
                      org.apache.james.managesieve.api.QuotaExceededException

Specified by:

putScript in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.UserNotFoundException

org.apache.james.managesieve.api.StorageException

org.apache.james.managesieve.api.QuotaExceededException

See Also:

SieveRepository.putScript(java.lang.String, java.lang.String, java.lang.String)

renameScript

public void renameScript(String user,
                String oldName,
                String newName)
                  throws org.apache.james.managesieve.api.UserNotFoundException,
                         org.apache.james.managesieve.api.ScriptNotFoundException,
                         org.apache.james.managesieve.api.DuplicateException,
                         org.apache.james.managesieve.api.StorageException

Specified by:

renameScript in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.StorageException

org.apache.james.managesieve.api.UserNotFoundException

org.apache.james.managesieve.api.ScriptNotFoundException

org.apache.james.managesieve.api.DuplicateException

See Also:

SieveRepository.renameScript(java.lang.String, java.lang.String, java.lang.String)

getActive

public String getActive(String user)
                 throws org.apache.james.managesieve.api.UserNotFoundException,
                        org.apache.james.managesieve.api.ScriptNotFoundException

Specified by:

getActive in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.UserNotFoundException

org.apache.james.managesieve.api.ScriptNotFoundException

See Also:

SieveRepository.getActive(java.lang.String)

setActive

public void setActive(String user,
             String name)
               throws org.apache.james.managesieve.api.UserNotFoundException,
                      org.apache.james.managesieve.api.ScriptNotFoundException,
                      org.apache.james.managesieve.api.StorageException

Specified by:

setActive in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.StorageException

org.apache.james.managesieve.api.UserNotFoundException

org.apache.james.managesieve.api.ScriptNotFoundException

See Also:

SieveRepository.setActive(java.lang.String, java.lang.String)

getSieveRootDirectory

protected File getSieveRootDirectory()

getUserDirectory

protected File getUserDirectory(String user)
                         throws org.apache.james.managesieve.api.UserNotFoundException

Throws:

org.apache.james.managesieve.api.UserNotFoundException

getUserDirectoryFile

protected File getUserDirectoryFile(String user)

getActiveFile

protected File getActiveFile(String user)
                      throws org.apache.james.managesieve.api.UserNotFoundException,
                             org.apache.james.managesieve.api.ScriptNotFoundException

Throws:

org.apache.james.managesieve.api.UserNotFoundException

org.apache.james.managesieve.api.ScriptNotFoundException

isActiveFile

protected boolean isActiveFile(String user,
                   File file)
                        throws org.apache.james.managesieve.api.UserNotFoundException

Throws:

org.apache.james.managesieve.api.UserNotFoundException

setActiveFile

protected void setActiveFile(File activeFile,
                 boolean isActive)
                      throws org.apache.james.managesieve.api.StorageException

Throws:

org.apache.james.managesieve.api.StorageException

getScriptFile

protected File getScriptFile(String user,
                 String name)
                      throws org.apache.james.managesieve.api.UserNotFoundException,
                             org.apache.james.managesieve.api.ScriptNotFoundException

Throws:

org.apache.james.managesieve.api.UserNotFoundException

org.apache.james.managesieve.api.ScriptNotFoundException

hasUser

public boolean hasUser(String user)

Specified by:

hasUser in interface org.apache.james.managesieve.api.SieveRepository

See Also:

org.apache.james.managesieve.api.SieveRepository#hasUser()

addUser

public void addUser(String user)
             throws org.apache.james.managesieve.api.DuplicateUserException,
                    org.apache.james.managesieve.api.StorageException

Specified by:

addUser in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.StorageException

org.apache.james.managesieve.api.DuplicateUserException

See Also:

SieveRepository.addUser(java.lang.String)

removeUser

public void removeUser(String user)
                throws org.apache.james.managesieve.api.UserNotFoundException,
                       org.apache.james.managesieve.api.StorageException

Specified by:

removeUser in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.StorageException

org.apache.james.managesieve.api.UserNotFoundException

See Also:

SieveRepository.removeUser(java.lang.String)

getQuotaFile

protected File getQuotaFile()

hasQuota

public boolean hasQuota()

Specified by:

hasQuota in interface org.apache.james.managesieve.api.SieveRepository

See Also:

SieveRepository.hasQuota()

getQuota

public long getQuota()
              throws org.apache.james.managesieve.api.QuotaNotFoundException

Specified by:

getQuota in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.QuotaNotFoundException

See Also:

SieveRepository.getQuota()

removeQuota

public void removeQuota()
                 throws org.apache.james.managesieve.api.QuotaNotFoundException,
                        org.apache.james.managesieve.api.StorageException

Specified by:

removeQuota in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.QuotaNotFoundException

org.apache.james.managesieve.api.StorageException

See Also:

SieveRepository.removeQuota()

setQuota

public void setQuota(long quota)
              throws org.apache.james.managesieve.api.StorageException

Specified by:

setQuota in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.StorageException

See Also:

SieveRepository.setQuota(long)

getQuotaFile

protected File getQuotaFile(String user)
                     throws org.apache.james.managesieve.api.UserNotFoundException

Throws:

org.apache.james.managesieve.api.UserNotFoundException

hasQuota

public boolean hasQuota(String user)
                 throws org.apache.james.managesieve.api.UserNotFoundException

Specified by:

hasQuota in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.UserNotFoundException

See Also:

SieveRepository.hasQuota(java.lang.String)

getQuota

public long getQuota(String user)
              throws org.apache.james.managesieve.api.UserNotFoundException,
                     org.apache.james.managesieve.api.QuotaNotFoundException

Specified by:

getQuota in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.QuotaNotFoundException

org.apache.james.managesieve.api.UserNotFoundException

See Also:

SieveRepository.getQuota(java.lang.String)

removeQuota

public void removeQuota(String user)
                 throws org.apache.james.managesieve.api.UserNotFoundException,
                        org.apache.james.managesieve.api.QuotaNotFoundException,
                        org.apache.james.managesieve.api.StorageException

Specified by:

removeQuota in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.QuotaNotFoundException

org.apache.james.managesieve.api.StorageException

org.apache.james.managesieve.api.UserNotFoundException

See Also:

SieveRepository.removeQuota(java.lang.String)

setQuota

public void setQuota(String user,
            long quota)
              throws org.apache.james.managesieve.api.UserNotFoundException,
                     org.apache.james.managesieve.api.StorageException

Specified by:

setQuota in interface org.apache.james.managesieve.api.SieveRepository

Throws:

org.apache.james.managesieve.api.StorageException

org.apache.james.managesieve.api.UserNotFoundException

See Also:

SieveRepository.setQuota(java.lang.String, long)