Source Code Cross Referenced for ICommandListservManager.java in  » Net » james-2.3.1 » org » apache » james » transport » mailets » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Net » james 2.3.1 » org.apache.james.transport.mailets 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


001:        /****************************************************************
002:         * Licensed to the Apache Software Foundation (ASF) under one   *
003:         * or more contributor license agreements.  See the NOTICE file *
004:         * distributed with this work for additional information        *
005:         * regarding copyright ownership.  The ASF licenses this file   *
006:         * to you under the Apache License, Version 2.0 (the            *
007:         * "License"); you may not use this file except in compliance   *
008:         * with the License.  You may obtain a copy of the License at   *
009:         *                                                              *
010:         *   http://www.apache.org/licenses/LICENSE-2.0                 *
011:         *                                                              *
012:         * Unless required by applicable law or agreed to in writing,   *
013:         * software distributed under the License is distributed on an  *
014:         * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
015:         * KIND, either express or implied.  See the License for the    *
016:         * specific language governing permissions and limitations      *
017:         * under the License.                                           *
018:         ****************************************************************/package org.apache.james.transport.mailets;
019:
020:        import org.apache.james.transport.mailets.listservcommands.IListServCommand;
021:        import org.apache.james.services.UsersRepository;
022:        import org.apache.james.util.XMLResources;
023:        import org.apache.mailet.Mailet;
024:        import org.apache.mailet.Mail;
025:        import org.apache.mailet.MailAddress;
026:        import org.apache.avalon.framework.configuration.ConfigurationException;
027:
028:        import javax.mail.MessagingException;
029:        import java.util.Map;
030:        import java.util.Properties;
031:
032:        /**
033:         * ICommandListservManager is the interface that describes the functionality of any
034:         * command based list serv managers.
035:         *
036:         * In order to obtain a reference to one, you can call:
037:         * <pre>
038:         * ICommandListservManager mgr = (ICommandListservManager)mailetContext.getAttribute(ICommandListservManager.ID + listName);
039:         * </pre>
040:         *
041:         * @version CVS $Revision: 494012 $ $Date: 2007-01-08 11:23:58 +0100 (Mo, 08 Jan 2007) $
042:         * @since 2.2.0
043:         */
044:        public interface ICommandListservManager extends Mailet {
045:
046:            public static final String ID = ICommandListservManager.class
047:                    .getName();
048:
049:            /**
050:             * Get the name of this list
051:             * @param displayFormat is whether you want a display version of this or not
052:             * @return the official display name of this list
053:             */
054:            public String getListName(boolean displayFormat);
055:
056:            /**
057:             * Gets the owner of this list
058:             * @return this is an address like listOwner@localhost
059:             */
060:            public String getListOwner();
061:
062:            /**
063:             * Get the domain of the list
064:             * @return a string like localhost
065:             */
066:            public String getListDomain();
067:
068:            /**
069:             * Get a specific command
070:             * @param name case in-sensitive
071:             * @return a {@link IListServCommand} if found, null otherwise
072:             */
073:            public IListServCommand getCommand(String name);
074:
075:            /**
076:             * Get all the available commands
077:             * @return a map of {@link IListServCommand}s
078:             */
079:            public Map getCommands();
080:
081:            /**
082:             * Based on the to address get a valid or command or null
083:             * @param mailAddress
084:             * @return IListServCommand or null
085:             */
086:            public IListServCommand getCommandTarget(MailAddress mailAddress);
087:
088:            /**
089:             * Get the current user repository for this list serv
090:             * @return an instance of {@link UsersRepository} that is used for the member list of the list serv
091:             */
092:            public UsersRepository getUsersRepository();
093:
094:            /**
095:             * An error occurred, send some sort of message to the sender
096:             * @param subject the subject of the message to send
097:             * @param mail
098:             * @param errorMessage
099:             */
100:            public void onError(Mail mail, String subject, String errorMessage)
101:                    throws MessagingException;
102:
103:            /**
104:             * @return the configuration file for the xml resources
105:             */
106:            public String getResourcesFile();
107:
108:            /**
109:             * Use this to get standard properties for future calls to {@link org.apache.james.util.XMLResources}
110:             * @return properties with the "LIST_NAME" and the "DOMAIN_NAME" properties
111:             */
112:            public Properties getStandardProperties();
113:
114:            /**
115:             * Initializes an array of resources
116:             * @param names such as 'header, footer' etc...
117:             * @return an initialized array of XMLResources
118:             * @throws org.apache.avalon.framework.configuration.ConfigurationException
119:             */
120:            public XMLResources[] initXMLResources(String[] names)
121:                    throws ConfigurationException;
122:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.