KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > james > imapserver > ACLMailbox


1 /***********************************************************************
2  * Copyright (c) 2000-2004 The Apache Software Foundation. *
3  * All rights reserved. *
4  * ------------------------------------------------------------------- *
5  * Licensed under the Apache License, Version 2.0 (the "License"); you *
6  * may not use this file except in compliance with the License. You *
7  * may obtain a copy of the License at: *
8  * *
9  * http://www.apache.org/licenses/LICENSE-2.0 *
10  * *
11  * Unless required by applicable law or agreed to in writing, software *
12  * distributed under the License is distributed on an "AS IS" BASIS, *
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or *
14  * implied. See the License for the specific language governing *
15  * permissions and limitations under the License. *
16  ***********************************************************************/
17
18 package org.apache.james.imapserver;
19
20 import org.apache.avalon.framework.activity.Disposable;
21 import org.apache.avalon.framework.activity.Initializable;
22 import org.apache.avalon.framework.component.Component;
23 import org.apache.avalon.framework.context.Contextualizable;
24
25 /**
26  * Interface for objects representing an IMAP4rev1 mailbox (folder) with
27  * embedded Access Control List.
28  *
29  * Reference: RFC 2060
30  * @version 0.1 on 14 Dec 2000
31  * @see Mailbox
32  * @see ACL
33  */
34 public interface ACLMailbox
35     extends ACL, Mailbox, Component, Contextualizable, Initializable, Disposable {
36
37     /**
38      * Set the details particular to this Mailbox. Should only be called once,
39      * at creation, and not when restored from storage.
40      *
41      * @param user String email local part of owner of a personal mailbox.
42      * @param abName String absolute, ie user-independent, name of mailbox.
43      * @param initialAdminUser String email local-part of a user who will be assigned admin rights on this mailbox
44      */
45     void prepareMailbox( String JavaDoc user, String JavaDoc absName, String JavaDoc initialAdminUser, int uidValidity );
46
47     /**
48      * Re-initialises mailbox when restored from storage. Must be called after
49      * setConfiguration, setContext, setComponentManager, if they are called,
50      * but before any opertional methods are called.
51      */
52     void reinitialize()
53         throws Exception JavaDoc;
54
55     /**
56      * Permanently deletes the mailbox.
57      */
58     void removeMailbox();
59 }
60
61
62
Popular Tags