You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@synapse.apache.org by ru...@apache.org on 2008/05/05 08:28:40 UTC

svn commit: r653305 - in /synapse/trunk/java/modules/core/src/main/java/org/apache/synapse: config/xml/MediatorFactoryFinder.java config/xml/MediatorSerializerFinder.java core/axis2/AnonymousServiceFactory.java core/axis2/MediatorDeployer.java

Author: ruwan
Date: Sun May  4 23:28:39 2008
New Revision: 653305

URL: http://svn.apache.org/viewvc?rev=653305&view=rev
Log:
Generics and documentation improvements

Modified:
    synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/MediatorFactoryFinder.java
    synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/MediatorSerializerFinder.java
    synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/AnonymousServiceFactory.java
    synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/MediatorDeployer.java

Modified: synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/MediatorFactoryFinder.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/MediatorFactoryFinder.java?rev=653305&r1=653304&r2=653305&view=diff
==============================================================================
--- synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/MediatorFactoryFinder.java (original)
+++ synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/MediatorFactoryFinder.java Sun May  4 23:28:39 2008
@@ -78,7 +78,7 @@
     /**
      * A map of mediator QNames to implementation class
      */
-    private static Map factoryMap = new HashMap();
+    private static Map<QName, Class> factoryMap = new HashMap<QName, Class>();
 
     public static synchronized MediatorFactoryFinder getInstance() {
         if (instance == null) {
@@ -97,31 +97,20 @@
 
     private MediatorFactoryFinder() {
 
-        factoryMap = new HashMap();
+        factoryMap = new HashMap<QName, Class>();
 
-        for (int i = 0; i < mediatorFactories.length; i++) {
-			Class c = mediatorFactories[i];
-			try {
+        for (Class c : mediatorFactories) {
+            try {
                 MediatorFactory fac = (MediatorFactory) c.newInstance();
                 factoryMap.put(fac.getTagQName(), c);
             } catch (Exception e) {
-				throw new SynapseException("Error instantiating " + c.getName(), e);
-			}
-		}
+                throw new SynapseException("Error instantiating " + c.getName(), e);
+            }
+        }
         // now iterate through the available pluggable mediator factories
         registerExtensions();
     }
 
-    private void handleException(String msg, Exception e) {
-        log.error(msg, e);
-        throw new SynapseException(msg, e);
-    }
-
-    private void handleException(String msg) {
-        log.error(msg);
-        throw new SynapseException(msg);
-    }
-
     /**
      * Register pluggable mediator factories from the classpath
      *
@@ -130,8 +119,6 @@
      */
     private void registerExtensions() {
 
-        //log.debug("Registering mediator extensions found in the classpath : " + System.getResource("java.class.path"));
-
         // register MediatorFactory extensions
         Iterator it = Service.providers(MediatorFactory.class);
         while (it.hasNext()) {
@@ -149,13 +136,13 @@
 	 * recursively by the elements which contain processor elements themselves
 	 * (e.g. rules)
 	 * 
-	 * @param element
+	 * @param element XML representation of a mediator
      * @return Processor
 	 */
 	public Mediator getMediator(OMElement element) {
 
         String localName = element.getLocalName();
-        QName qName = null;
+        QName qName;
         if (element.getNamespace() != null) {
             qName = new QName(element.getNamespace().getNamespaceURI(), localName);
         } else {
@@ -164,7 +151,7 @@
         if (log.isDebugEnabled()) {
             log.debug("getMediator(" + qName + ")");
         }
-        Class cls = (Class) factoryMap.get(qName);
+        Class cls = factoryMap.get(qName);
 
         if (cls == null && localName.indexOf('.') > -1) {
             String newLocalName = localName.substring(0, localName.indexOf('.'));
@@ -172,7 +159,7 @@
             if (log.isDebugEnabled()) {
                 log.debug("getMediator.2(" + qName + ")");
             }
-            cls = (Class) factoryMap.get(qName);
+            cls = factoryMap.get(qName);
         }
 
         if (cls == null) {
@@ -196,18 +183,20 @@
             throw new SynapseException(msg, e);
 		}
 	}
-    /*
-    This method exposes all the MediatorFactories and its Extensions 
-    */
-    public Map getFactoryMap() {
+    
+    /**
+     * This method exposes all the MediatorFactories and its Extensions
+     * @return factoryMap
+     */
+    public Map<QName, Class> getFactoryMap() {
         return factoryMap;
     }
 
     /**
      * Allow the mediator factory finder to act as an XMLToObjectMapper for Mediators
      * (i.e. Sequence Mediator) loaded dynamically from a Registry 
-     * @param om
-     * @return
+     * @param om node from which the object is expected
+     * @return Object buit from the om node
      */
     public Object getObjectFromOMNode(OMNode om) {
         if (om instanceof OMElement) {
@@ -217,4 +206,10 @@
         }
         return null;
     }
+
+    private void handleException(String msg) {
+        log.error(msg);
+        throw new SynapseException(msg);
+    }
+
 }

Modified: synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/MediatorSerializerFinder.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/MediatorSerializerFinder.java?rev=653305&r1=653304&r2=653305&view=diff
==============================================================================
--- synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/MediatorSerializerFinder.java (original)
+++ synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/MediatorSerializerFinder.java Sun May  4 23:28:39 2008
@@ -65,7 +65,8 @@
     /**
      * A map of mediator QNames to implementation class
      */
-    private static Map serializerMap = new HashMap();
+    private static Map<String, MediatorSerializer> serializerMap
+            = new HashMap<String, MediatorSerializer>();
 
     public static synchronized MediatorSerializerFinder getInstance() {
         if (instance == null) {
@@ -75,15 +76,14 @@
     }
 
     public MediatorSerializer getSerializer(Mediator mediator) {
-        return (MediatorSerializer) serializerMap.get(mediator.getClass().getName());
+        return serializerMap.get(mediator.getClass().getName());
     }
 
     private MediatorSerializerFinder() {
 
-        serializerMap = new HashMap();
+        serializerMap = new HashMap<String, MediatorSerializer>();
 
-        for (int i = 0; i < mediatorSerializers.length; i++) {
-            Class c = mediatorSerializers[i];
+        for (Class c : mediatorSerializers) {
             try {
                 MediatorSerializer ser = (MediatorSerializer) c.newInstance();
                 serializerMap.put(ser.getMediatorClassName(), ser);
@@ -128,7 +128,7 @@
      * 
      * @return Map of serilaizers already registered with the Finder
      */
-    public Map getSerializerMap() {
+    public Map<String, MediatorSerializer> getSerializerMap() {
         return serializerMap;
     }
 

Modified: synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/AnonymousServiceFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/AnonymousServiceFactory.java?rev=653305&r1=653304&r2=653305&view=diff
==============================================================================
--- synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/AnonymousServiceFactory.java (original)
+++ synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/AnonymousServiceFactory.java Sun May  4 23:28:39 2008
@@ -55,17 +55,18 @@
     /**
      * Creates an AxisService for the requested QoS for sending out messages
      * Callers must guarantee that if wsRMon or wsSecOn is required, that wsAddrOn is also set
+     * @param synCfg Synapse configuration
      * @param axisCfg Axis2 configuration
-     * @param wsAddrOn
-     * @param wsRMOn
-     * @param wsSecOn
+     * @param wsAddrOn whether addressing is on or not
+     * @param wsRMOn whether RM is on ot not
+     * @param wsSecOn whether security is on or not
      * @return An Axis service for the requested QoS
      */
     public static AxisService getAnonymousService(SynapseConfiguration synCfg,
                                                   AxisConfiguration axisCfg, boolean wsAddrOn,
                                                   boolean wsRMOn, boolean wsSecOn) {
 
-        String servicekey = null;
+        String servicekey;
         if (!wsAddrOn) {
             servicekey = NONE;
         } else {
@@ -123,7 +124,9 @@
 
     /**
      * Create a new Anonymous Axis service for OUT-IN as default MEP
+     * @param synCfg the Synapse Configuration
      * @param axisCfg the Axis2 configuration
+     * @param serviceKey key for the service
      * @return an anonymous service named with the given QoS key
      */
     private static AxisService createAnonymousService(SynapseConfiguration synCfg,

Modified: synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/MediatorDeployer.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/MediatorDeployer.java?rev=653305&r1=653304&r2=653305&view=diff
==============================================================================
--- synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/MediatorDeployer.java (original)
+++ synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/core/axis2/MediatorDeployer.java Sun May  4 23:28:39 2008
@@ -96,10 +96,10 @@
                     facSB.append((char) c);
                 }
 
-                String[] facClassName = facSB.toString().split("\n");
-                for (int i=0; i<facClassName.length; i++) {
-                    log.info("Registering the Mediator factory: " + facClassName[i]);
-                    Class facClass = urlCl.loadClass(facClassName[i]);
+                String[] facClassNames = facSB.toString().split("\n");
+                for (String facClassName : facClassNames) {
+                    log.info("Registering the Mediator factory: " + facClassName);
+                    Class facClass = urlCl.loadClass(facClassName);
                     MediatorFactory facInst = (MediatorFactory) facClass.newInstance();
                     MediatorFactoryFinder.getInstance()
                             .getFactoryMap().put(facInst.getTagQName(), facClass);
@@ -124,10 +124,10 @@
                     serSB.append((char) c);
                 }
 
-                String[] serClassName = serSB.toString().split("\n");
-                for (int i=0; i<serClassName.length; i++) {
-                    log.info("Registering the Mediator serializer: " + serClassName[i]);
-                    Class serClass = urlCl.loadClass(serClassName[i]);
+                String[] serClassNames = serSB.toString().split("\n");
+                for (String serClassName : serClassNames) {
+                    log.info("Registering the Mediator serializer: " + serClassName);
+                    Class serClass = urlCl.loadClass(serClassName);
                     MediatorSerializer serInst = (MediatorSerializer) serClass.newInstance();
                     MediatorSerializerFinder.getInstance()
                             .getSerializerMap().put(serInst.getMediatorClassName(), serInst);