SK.gnome.dwarf.mail.store
Interface ACLStore

All Known Implementing Classes:
FileACLStore

public interface ACLStore

This class provides interface for Access Control List store.

The ACL store serves for storing user rights and permissions for manipulating mail folders and messages.


Method Summary
 void addPermission(java.lang.String user, MailPermission permission)
          Grants the mail permission to the given user.
 MailPermission[] getPermissions(java.lang.String user)
          Returns all mail permissions granted to the given user.
 java.lang.String[] listUsers()
          Returns a list of all users with any granted permission.
 void removePermission(java.lang.String user, MailPermission permission)
          Revokes the mail permission from the given user.
 void removePermissions(java.lang.String user, java.lang.String mailbox)
          Revokes all mail permission from the given user and mailbox.
 void setPermission(java.lang.String user, MailPermission permission)
          Replaces the mail permission of the given user.
 

Method Detail

addPermission

public void addPermission(java.lang.String user,
                          MailPermission permission)
                   throws MailException
Grants the mail permission to the given user.

Parameters:
user - the user identification
permission - the mail permission
Throws:
MailException - if an error occured

setPermission

public void setPermission(java.lang.String user,
                          MailPermission permission)
                   throws MailException
Replaces the mail permission of the given user.

Parameters:
user - the user identification
permission - the mail permission
Throws:
MailException - if an error occured

removePermission

public void removePermission(java.lang.String user,
                             MailPermission permission)
                      throws MailException
Revokes the mail permission from the given user.

Parameters:
user - the user identification
permission - the mail permission
Throws:
MailException - if an error occured

removePermissions

public void removePermissions(java.lang.String user,
                              java.lang.String mailbox)
                       throws MailException
Revokes all mail permission from the given user and mailbox.

Parameters:
user - the user identification
mailbox - the full mailbox name
Throws:
MailException - if an error occured

getPermissions

public MailPermission[] getPermissions(java.lang.String user)
                                throws MailException
Returns all mail permissions granted to the given user.

Parameters:
user - the user identification
Returns:
the granted mail permissions
Throws:
MailException - if an error occured

listUsers

public java.lang.String[] listUsers()
                             throws MailException
Returns a list of all users with any granted permission.

Returns:
the array of user identifications
Throws:
MailException - if an error occured


Copyright (c) 2004-2005, Gnome Ltd. All rights reserved.