directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pamarce...@apache.org
Subject svn commit: r570832 - in /directory/studio/trunk/studio-connection-core/src/main: java/org/apache/directory/studio/connection/core/io/ resources/org/apache/directory/studio/connection/core/
Date Wed, 29 Aug 2007 15:03:01 GMT
Author: pamarcelot
Date: Wed Aug 29 08:03:01 2007
New Revision: 570832

URL: http://svn.apache.org/viewvc?rev=570832&view=rev
Log:
Updated the way to load/save the connectionx.xml file using a Dom4J parser.

Added:
    directory/studio/trunk/studio-connection-core/src/main/java/org/apache/directory/studio/connection/core/io/ConnectionIO.java
    directory/studio/trunk/studio-connection-core/src/main/java/org/apache/directory/studio/connection/core/io/ConnectionIOException.java
    directory/studio/trunk/studio-connection-core/src/main/resources/org/apache/directory/studio/connection/core/XmlFileFormat.xslt

Added: directory/studio/trunk/studio-connection-core/src/main/java/org/apache/directory/studio/connection/core/io/ConnectionIO.java
URL: http://svn.apache.org/viewvc/directory/studio/trunk/studio-connection-core/src/main/java/org/apache/directory/studio/connection/core/io/ConnectionIO.java?rev=570832&view=auto
==============================================================================
--- directory/studio/trunk/studio-connection-core/src/main/java/org/apache/directory/studio/connection/core/io/ConnectionIO.java
(added)
+++ directory/studio/trunk/studio-connection-core/src/main/java/org/apache/directory/studio/connection/core/io/ConnectionIO.java
Wed Aug 29 08:03:01 2007
@@ -0,0 +1,362 @@
+/*
+ *  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.directory.studio.connection.core.io;
+
+
+import java.io.BufferedWriter;
+import java.io.FileReader;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+
+import javax.xml.transform.Transformer;
+import javax.xml.transform.TransformerConfigurationException;
+import javax.xml.transform.TransformerException;
+import javax.xml.transform.TransformerFactory;
+import javax.xml.transform.stream.StreamSource;
+
+import org.apache.directory.studio.connection.core.ConnectionCorePlugin;
+import org.apache.directory.studio.connection.core.ConnectionParameter;
+import org.apache.directory.studio.connection.core.ConnectionParameter.AuthenticationMethod;
+import org.apache.directory.studio.connection.core.ConnectionParameter.EncryptionMethod;
+import org.dom4j.Attribute;
+import org.dom4j.Document;
+import org.dom4j.DocumentException;
+import org.dom4j.DocumentHelper;
+import org.dom4j.Element;
+import org.dom4j.io.DocumentResult;
+import org.dom4j.io.DocumentSource;
+import org.dom4j.io.SAXReader;
+
+
+/**
+ * This class is used to read/write the 'connections.xml' file.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
+public class ConnectionIO
+{
+    // XML tags
+    private static final String CONNECTIONS_TAG = "connections";
+    private static final String CONNECTION_TAG = "connection";
+    private static final String ID_TAG = "id";
+    private static final String NAME_TAG = "name";
+    private static final String HOST_TAG = "host";
+    private static final String PORT_TAG = "port";
+    private static final String ENCRYPTION_METHOD_TAG = "encryptionMethod";
+    private static final String AUTH_METHOD_TAG = "authMethod";
+    private static final String BIND_PRINCIPAL_TAG = "bindPrincipal";
+    private static final String BIND_PASSWORD_TAG = "bindPassword";
+    private static final String EXTENDED_PROPERTIES_TAG = "extendedProperties";
+    private static final String EXTENDED_PROPERTY_TAG = "extendedProperty";
+    private static final String KEY_TAG = "key";
+    private static final String VALUE_TAG = "value";
+
+
+    /**
+     * Loads the connections using the reader
+     *
+     * @param reader
+     *      the reader
+     * @return
+     *      the connections
+     * @throws ConnectionIOException 
+     *      if an error occurs when converting the document
+     */
+    public static List<ConnectionParameter> load( FileReader reader ) throws ConnectionIOException
+    {
+        List<ConnectionParameter> connections = new ArrayList<ConnectionParameter>();
+
+        SAXReader saxReader = new SAXReader();
+        Document document = null;
+
+        try
+        {
+            document = saxReader.read( reader );
+        }
+        catch ( DocumentException e )
+        {
+            throw new ConnectionIOException( e.getMessage() );
+        }
+
+        Element rootElement = document.getRootElement();
+        if ( !rootElement.getName().equals( CONNECTIONS_TAG ) )
+        {
+            throw new ConnectionIOException( "The file does not seem to be a valid Connections
file." );
+        }
+
+        for ( Iterator<?> i = rootElement.elementIterator( CONNECTION_TAG ); i.hasNext();
)
+        {
+            Element connectionElement = ( Element ) i.next();
+            connections.add( readConnection( connectionElement ) );
+        }
+
+        return connections;
+    }
+
+
+    /**
+     * Reads a connection from the given Element.
+     *
+     * @param element
+     *      the element
+     * @return
+     *      the corresponding connection
+     * @throws ConnectionIOException
+     *      if an error occurs when converting values
+     */
+    private static ConnectionParameter readConnection( Element element ) throws ConnectionIOException
+    {
+        ConnectionParameter connection = new ConnectionParameter();
+
+        // ID
+        Attribute idAttribute = element.attribute( ID_TAG );
+        if ( idAttribute != null )
+        {
+            connection.setId( idAttribute.getValue() );
+        }
+
+        // Name
+        Attribute nameAttribute = element.attribute( NAME_TAG );
+        if ( nameAttribute != null )
+        {
+            connection.setName( nameAttribute.getValue() );
+        }
+
+        // Host        
+        Attribute hostAttribute = element.attribute( HOST_TAG );
+        if ( hostAttribute != null )
+        {
+            connection.setHost( hostAttribute.getValue() );
+        }
+
+        // Port
+        Attribute portAttribute = element.attribute( PORT_TAG );
+        if ( portAttribute != null )
+        {
+            try
+            {
+                connection.setPort( Integer.parseInt( portAttribute.getValue() ) );
+            }
+            catch ( NumberFormatException e )
+            {
+                throw new ConnectionIOException( "Unable to parse 'Port' of connection '"
+ connection.getName()
+                    + "' as int value. Port value :" + portAttribute.getValue() );
+            }
+        }
+
+        // Encryption Method
+        Attribute encryptionMethodAttribute = element.attribute( ENCRYPTION_METHOD_TAG );
+        if ( encryptionMethodAttribute != null )
+        {
+            try
+            {
+                connection.setEncryptionMethod( EncryptionMethod.valueOf( encryptionMethodAttribute.getValue()
) );
+            }
+            catch ( IllegalArgumentException e )
+            {
+                throw new ConnectionIOException( "Unable to parse 'Encryption Method' of
connection '"
+                    + connection.getName() + "' as int value. Encryption Method value :"
+                    + encryptionMethodAttribute.getValue() );
+            }
+        }
+
+        // Auth Method
+        Attribute authMethodAttribute = element.attribute( AUTH_METHOD_TAG );
+        if ( authMethodAttribute != null )
+        {
+            try
+            {
+                connection.setAuthMethod( AuthenticationMethod.valueOf( authMethodAttribute.getValue()
) );
+            }
+            catch ( IllegalArgumentException e )
+            {
+                throw new ConnectionIOException( "Unable to parse 'Authentication Method'
of connection '"
+                    + connection.getName() + "' as int value. Authentication Method value
:"
+                    + authMethodAttribute.getValue() );
+            }
+        }
+
+        // Bind Principal        
+        Attribute bindPrincipalAttribute = element.attribute( BIND_PRINCIPAL_TAG );
+        if ( bindPrincipalAttribute != null )
+        {
+            connection.setBindPrincipal( bindPrincipalAttribute.getValue() );
+        }
+
+        // Bind Password
+        Attribute bindPasswordAttribute = element.attribute( BIND_PASSWORD_TAG );
+        if ( bindPasswordAttribute != null )
+        {
+            connection.setBindPassword( bindPasswordAttribute.getValue() );
+        }
+
+        // Extended Properties
+        Element extendedPropertiesElement = element.element( EXTENDED_PROPERTIES_TAG );
+        if ( extendedPropertiesElement != null )
+        {
+            for ( Iterator<?> i = extendedPropertiesElement.elementIterator( EXTENDED_PROPERTY_TAG
); i.hasNext(); )
+            {
+                Element extendedPropertyElement = ( Element ) i.next();
+
+                Attribute keyAttribute = extendedPropertyElement.attribute( KEY_TAG );
+                Attribute valueAttribute = extendedPropertyElement.attribute( VALUE_TAG );
+
+                if ( keyAttribute != null )
+                {
+                    connection.setExtendedProperty( keyAttribute.getValue(), valueAttribute.getValue()
);
+                }
+            }
+        }
+
+        return connection;
+    }
+
+
+    /**
+     * Saves the connections using the writer.
+     *
+     * @param connections
+     *      the connections
+     * @param writer
+     *      the writer
+     * @throws IOException
+     *      if an I/O error occurs
+     */
+    public static void save( List<ConnectionParameter> connections, FileWriter writer
) throws IOException
+    {
+        // Creating the Document
+        Document document = DocumentHelper.createDocument();
+
+        // Creating the root element
+        Element root = document.addElement( CONNECTIONS_TAG );
+
+        if ( connections != null )
+        {
+            for ( ConnectionParameter connection : connections )
+            {
+                addConnection( root, connection );
+            }
+        }
+
+        // Writing the file to disk
+        BufferedWriter buffWriter = new BufferedWriter( writer );
+        buffWriter.write( styleDocument( document ).asXML() );
+        buffWriter.close();
+    }
+
+
+    /**
+     * Adds the given connection to the given parent Element.
+     *
+     * @param parent
+     *      the parent Element
+     * @param connection
+     *      the connection
+     */
+    private static void addConnection( Element parent, ConnectionParameter connection )
+    {
+        Element connectionElement = parent.addElement( CONNECTION_TAG );
+
+        // ID
+        connectionElement.addAttribute( ID_TAG, connection.getId() );
+
+        // Name
+        connectionElement.addAttribute( NAME_TAG, connection.getName() );
+
+        // Host
+        connectionElement.addAttribute( HOST_TAG, connection.getHost() );
+
+        // Port
+        connectionElement.addAttribute( PORT_TAG, "" + connection.getPort() );
+
+        // Encryption Method
+        connectionElement.addAttribute( ENCRYPTION_METHOD_TAG, connection.getEncryptionMethod().toString()
);
+
+        // Auth Method
+        connectionElement.addAttribute( AUTH_METHOD_TAG, connection.getAuthMethod().toString()
);
+
+        // Bind Principal
+        connectionElement.addAttribute( BIND_PRINCIPAL_TAG, connection.getBindPrincipal()
);
+
+        // Bind Password
+        connectionElement.addAttribute( BIND_PASSWORD_TAG, connection.getBindPassword() );
+
+        // Extended Properties
+        Element extendedPropertiesElement = connectionElement.addElement( EXTENDED_PROPERTIES_TAG
);
+        Map<String, String> extendedProperties = connection.getExtendedProperties();
+        if ( extendedProperties != null )
+        {
+            for ( Iterator<Entry<String, String>> iter = extendedProperties.entrySet().iterator();
iter.hasNext(); )
+            {
+                Map.Entry<String, String> element = ( Map.Entry<String, String>
) iter.next();
+
+                Element extendedPropertyElement = extendedPropertiesElement.addElement( EXTENDED_PROPERTY_TAG
);
+                extendedPropertyElement.addAttribute( KEY_TAG, element.getKey() );
+                extendedPropertyElement.addAttribute( VALUE_TAG, element.getValue() );
+            }
+        }
+    }
+
+
+    /**
+     * XML Pretty Printer XSLT Transformation
+     * 
+     * @param document
+     *      the Dom4j Document
+     * @return
+     */
+    private static Document styleDocument( Document document )
+    {
+        // load the transformer using JAXP
+        TransformerFactory factory = TransformerFactory.newInstance();
+        Transformer transformer = null;
+        try
+        {
+            transformer = factory.newTransformer( new StreamSource( ConnectionCorePlugin.class
+                .getResourceAsStream( "XmlFileFormat.xslt" ) ) );
+        }
+        catch ( TransformerConfigurationException e1 )
+        {
+            // Will never occur
+        }
+
+        // now lets style the given document
+        DocumentSource source = new DocumentSource( document );
+        DocumentResult result = new DocumentResult();
+        try
+        {
+            transformer.transform( source, result );
+        }
+        catch ( TransformerException e )
+        {
+            // Will never occur
+        }
+
+        // return the transformed document
+        Document transformedDoc = result.getDocument();
+        return transformedDoc;
+    }
+}

Added: directory/studio/trunk/studio-connection-core/src/main/java/org/apache/directory/studio/connection/core/io/ConnectionIOException.java
URL: http://svn.apache.org/viewvc/directory/studio/trunk/studio-connection-core/src/main/java/org/apache/directory/studio/connection/core/io/ConnectionIOException.java?rev=570832&view=auto
==============================================================================
--- directory/studio/trunk/studio-connection-core/src/main/java/org/apache/directory/studio/connection/core/io/ConnectionIOException.java
(added)
+++ directory/studio/trunk/studio-connection-core/src/main/java/org/apache/directory/studio/connection/core/io/ConnectionIOException.java
Wed Aug 29 08:03:01 2007
@@ -0,0 +1,44 @@
+/*
+ *  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.directory.studio.connection.core.io;
+
+
+/**
+ * This exception can be raised when loading the Connections file.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
+public class ConnectionIOException extends Exception
+{
+    private static final long serialVersionUID = 1L;
+
+
+    /**
+     * Creates a new instance of ConnectionIOException.
+     *
+     * @param message
+     *      the message
+     */
+    public ConnectionIOException( String message )
+    {
+        super( message );
+    }
+}
\ No newline at end of file

Added: directory/studio/trunk/studio-connection-core/src/main/resources/org/apache/directory/studio/connection/core/XmlFileFormat.xslt
URL: http://svn.apache.org/viewvc/directory/studio/trunk/studio-connection-core/src/main/resources/org/apache/directory/studio/connection/core/XmlFileFormat.xslt?rev=570832&view=auto
==============================================================================
--- directory/studio/trunk/studio-connection-core/src/main/resources/org/apache/directory/studio/connection/core/XmlFileFormat.xslt
(added)
+++ directory/studio/trunk/studio-connection-core/src/main/resources/org/apache/directory/studio/connection/core/XmlFileFormat.xslt
Wed Aug 29 08:03:01 2007
@@ -0,0 +1,48 @@
+<!--
+  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.
+-->
+<xsl:stylesheet version="1.0" 
+                xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+
+<xsl:output method="xml"/>
+   <xsl:param name="indent-increment" select="'   '" />
+
+   <xsl:template match="*">
+      <xsl:param name="indent" select="'&#xA;'"/>
+
+      <xsl:value-of select="$indent"/>
+      <xsl:copy>
+        <xsl:copy-of select="@*" />
+        <xsl:apply-templates>
+          <xsl:with-param name="indent"
+               select="concat($indent, $indent-increment)"/>
+        </xsl:apply-templates>
+        <xsl:if test="*">
+          <xsl:value-of select="$indent"/>
+        </xsl:if>
+      </xsl:copy>
+   </xsl:template>
+
+   <xsl:template match="comment()|processing-instruction()">
+      <xsl:copy />
+   </xsl:template>
+
+   <!-- WARNING: this is dangerous. Handle with care -->
+   <!-- <xsl:template match="text()[normalize-space(.)='']"/> -->
+
+</xsl:stylesheet>



Mime
View raw message