charlesb 01/05/11 04:03:30 Added: src/java/org/apache/james/imapserver IMAPSystem.java Log: Moving from src/org to src/java/org Revision Changes Path 1.1 jakarta-james/src/java/org/apache/james/imapserver/IMAPSystem.java Index: IMAPSystem.java =================================================================== /* * Copyright (C) The Apache Software Foundation. All rights reserved. * * This software is published under the terms of the Apache Software License * version 1.1, a copy of which has been included with this distribution in * the LICENSE file. */ package org.apache.james.imapserver; import java.util.Iterator; import org.apache.avalon.framework.component.ComponentManager; import org.apache.avalon.framework.component.Composable; import org.apache.avalon.framework.configuration.Configurable; import org.apache.avalon.framework.context.Context; import org.apache.avalon.framework.context.Contextualizable; import org.apache.james.AuthenticationException; /** * An IMAP4rev1 messaging system, possible containing multiple Hosts. There * should be one instance of this class per instance of James. * <p> An IMAP messaging system may span more than one server. * * References: rfc 2060, rfc 2193, rfc 2221 * @author <a href="mailto:[EMAIL PROTECTED]";>Charles Benett</a> * @version 0.1 on 14 Dec 2000 * @see Host */ public interface IMAPSystem extends Configurable, Contextualizable, Composable { String IMAP_SYSTEM = "IMAP_SYSTEM"; String PRIVATE = "Private"; String OTHER_USERS = "OtherUsers"; String SHARED = "Shared"; /** * Returns the token indicating a namespace. Implementation dependent but * by convention, '#'. * Example: #news.org.apache vs #mail.org.apache */ String getNamespaceToken(); /** * Returns the home server (server with user's INBOX) for specified user. * Enables Login Referrals per RFC2221. (Ie user attempts to login to a * server which is not their Home Server.) The returned string must comply * with RFC2192, IMAP URL Scheme. * * @param username String representation of a user * @returns String holding an IMAP URL for the user's home server * @throws AuthenticationException if this System does not recognise * the user. */ String getHomeServer( String username ) throws AuthenticationException; /** * Returns the character used as a mail hierarchy seperator in a given * namespace. A namespace must use the same seperator at all levels of * hierarchy. * <p>Recommendations (from rfc 2683) are period (US)/ full stop (Brit), * forward slash or backslash. * * @param namespace String identifying a namespace * @returns char, usually '.', '/', or '\' */ String getHierarchySeperator( String namespace ); /** * Provides the set of namesapces a given user can access. Implementations * should but are not required to reveal all namespaces that a user can * access. Different namespaces may be handled by different * <code>IMAPHosts</code> * * @param username String identifying a user of this System * @returns String whose contents should be a space seperated triple * <personal namespaces(s)> space <other users' namespace(s)> space * <shared namespace(s)>, per RFC2342 */ String getNamespaces( String username ); /** * Returns an iterator over the collection of servers on which this user * has access. The collection should be unmodifiable. * Enable Mailbox Referrals - RFC 2193. * * @param username String identifying a user * @return iterator over a collection of strings */ Iterator getAccessibleServers( String username ); } --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
