james-server-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From e...@apache.org
Subject svn commit: r1228114 - in /james/server/trunk/protocols-library/src/main/java/org/apache/james/protocols/lib/handler: ./ HandlersPackage.java ProtocolHandlerLoader.java
Date Fri, 06 Jan 2012 11:32:58 GMT
Author: eric
Date: Fri Jan  6 11:32:57 2012
New Revision: 1228114

URL: http://svn.apache.org/viewvc?rev=1228114&view=rev
Log:
Readdthe HandlersPackage and ProtocolHandlerLoader now in james-server-protocols-lib (JAMES-1360)

Added:
    james/server/trunk/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/
    james/server/trunk/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/HandlersPackage.java
    james/server/trunk/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/ProtocolHandlerLoader.java

Added: james/server/trunk/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/HandlersPackage.java
URL: http://svn.apache.org/viewvc/james/server/trunk/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/HandlersPackage.java?rev=1228114&view=auto
==============================================================================
--- james/server/trunk/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/HandlersPackage.java
(added)
+++ james/server/trunk/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/HandlersPackage.java
Fri Jan  6 11:32:57 2012
@@ -0,0 +1,42 @@
+/****************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one   *
+ * or more contributor license agreements.  See the NOTICE file *
+ * distributed with this work for additional information        *
+ * regarding copyright ownership.  The ASF licenses this file   *
+ * to you under the Apache License, Version 2.0 (the            *
+ * "License"); you may not use this file except in compliance   *
+ * with the License.  You may obtain a copy of the License at   *
+ *                                                              *
+ *   http://www.apache.org/licenses/LICENSE-2.0                 *
+ *                                                              *
+ * Unless required by applicable law or agreed to in writing,   *
+ * software distributed under the License is distributed on an  *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
+ * KIND, either express or implied.  See the License for the    *
+ * specific language governing permissions and limitations      *
+ * under the License.                                           *
+ ****************************************************************/
+
+
+
+package org.apache.james.protocols.lib.handler;
+
+import java.util.List;
+
+import org.apache.james.protocols.api.handler.ProtocolHandler;
+
+/**
+ * Provides a mean to bundle a set of handlers (defined by their classnames) within
+ * a single object.
+ * This is used for the default set of CoreCommands.
+ */
+public interface HandlersPackage extends ProtocolHandler{
+    
+    /**
+     * Return a List which contains a set of CommandHandlers
+     * 
+     * @return Map
+     */
+    List<String> getHandlers();
+
+}

Added: james/server/trunk/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/ProtocolHandlerLoader.java
URL: http://svn.apache.org/viewvc/james/server/trunk/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/ProtocolHandlerLoader.java?rev=1228114&view=auto
==============================================================================
--- james/server/trunk/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/ProtocolHandlerLoader.java
(added)
+++ james/server/trunk/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/ProtocolHandlerLoader.java
Fri Jan  6 11:32:57 2012
@@ -0,0 +1,65 @@
+/****************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one   *
+ * or more contributor license agreements.  See the NOTICE file *
+ * distributed with this work for additional information        *
+ * regarding copyright ownership.  The ASF licenses this file   *
+ * to you under the Apache License, Version 2.0 (the            *
+ * "License"); you may not use this file except in compliance   *
+ * with the License.  You may obtain a copy of the License at   *
+ *                                                              *
+ *   http://www.apache.org/licenses/LICENSE-2.0                 *
+ *                                                              *
+ * Unless required by applicable law or agreed to in writing,   *
+ * software distributed under the License is distributed on an  *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
+ * KIND, either express or implied.  See the License for the    *
+ * specific language governing permissions and limitations      *
+ * under the License.                                           *
+ ****************************************************************/
+package org.apache.james.protocols.lib.handler;
+
+import org.apache.commons.configuration.Configuration;
+import org.apache.james.protocols.api.handler.ProtocolHandler;
+
+/**
+ * Implementations of this interface are responsible for loading instances
+ * of {@link ProtocolHandler}. This includes to inject all needed resources and 
+ * execute any lifecycle methods
+ * 
+ *
+ */
+public interface ProtocolHandlerLoader {
+
+    /**
+     * Load the {@link ProtocolHandler} and make sure all lifecycle methods are called and
all
+     * needed services injected.
+     * 
+     * 
+     * @param name
+     * @param config
+     * @return handler
+     * @throws LoadingException
+     */
+    public ProtocolHandler load(String name, Configuration config) throws LoadingException;
+    
+    
+    /**
+     * Exception which will get thrown if the loading of a {@link ProtocolHandler} failed

+     * 
+     *
+     */
+    public class LoadingException extends Exception {
+        /**
+         * 
+         */
+        private static final long serialVersionUID = 1710169767810301710L;
+
+        public LoadingException(String msg, Throwable t) {
+            super(msg, t);
+        }
+        
+        public LoadingException(String msg) {
+            super(msg);
+        }
+    }
+}



---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Mime
View raw message