Coverage Report

Coverage Report - org.apache.maven.plugin.ear.ApplicationXmlWriter

Classes in this File

Line Coverage

Branch Coverage

Complexity

ApplicationXmlWriter

0/84

0/34

2.545

 package org.apache.maven.plugin.ear;
 
 /*
  * 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.
  */
 
 import java.io.Writer;
 
 import org.apache.maven.plugin.ear.util.JavaEEVersion;
 import org.codehaus.plexus.util.xml.XMLWriter;
 
 /**
  * An <tt>XmlWriter</tt> based implementation used to generate an
  * <tt>application.xml</tt> file
  *
  * @author <a href="snicoll@apache.org">Stephane Nicoll</a>
  * @version $Id: ApplicationXmlWriter.java 1377219 2012-08-25 05:42:36Z snicoll $
  */
 final class ApplicationXmlWriter
     extends AbstractXmlWriter
 {
     public static final String DOCTYPE_1_3 =
         "application PUBLIC\n" + "\t\"-//Sun Microsystems, Inc.//DTD J2EE Application 1.3//EN\"\n"
             + "\t\"http://java.sun.com/dtd/application_1_3.dtd\"";
 
     private static final String APPLICATION_ELEMENT = "application";
 
 
     private final JavaEEVersion version;
 
     private final Boolean generateModuleId;
 
     ApplicationXmlWriter( JavaEEVersion version, String encoding, Boolean generateModuleId )
     {
         super( encoding );
         this.version = version;
         this.generateModuleId = generateModuleId;
     }
 
     public void write( ApplicationXmlWriterContext context )
         throws EarPluginException
     {
         Writer w = initializeWriter( context.getDestinationFile() );
 
         XMLWriter writer = null;
         if ( JavaEEVersion.OneDotThree.eq( version ) )
         {
             writer = initializeRootElementOneDotThree( w );
         }
         else if ( JavaEEVersion.OneDotFour.eq( version ) )
         {
             writer = initializeRootElementOneDotFour( w );
         }
         else if ( JavaEEVersion.Five.eq( version ) )
         {
             writer = initializeRootElementFive( w );
         }
         else if ( JavaEEVersion.Six.eq( version ) )
         {
             writer = initializeRootElementSix( w );
         }
 
         // As from JavaEE6
         if ( version.ge( JavaEEVersion.Six ) )
         {
             writeApplicationName( context.getApplicationName(), writer );
         }
 
         // IMPORTANT: the order of the description and display-name elements was
         // reversed between J2EE 1.3 and J2EE 1.4.
         if ( version.eq( JavaEEVersion.OneDotThree ) )
         {
             writeDisplayName( context.getDisplayName(), writer );
             writeDescription( context.getDescription(), writer );
         }
         else
         {
             writeDescription( context.getDescription(), writer );
             writeDisplayName( context.getDisplayName(), writer );
         }
 
         // As from JavaEE6
         if ( version.ge( JavaEEVersion.Six ) )
         {
             writeInitializeInOrder( context.getInitializeInOrder(), writer );
         }
 
         // Do not change this unless you really know what you're doing :)
         for ( EarModule module : context.getEarModules() )
         {
             module.appendModule( writer, version.getVersion(), generateModuleId );
         }
 
         for ( SecurityRole securityRole : context.getSecurityRoles() )
         {
             securityRole.appendSecurityRole( writer );
         }
 
         if ( version.ge( JavaEEVersion.Six ) )
         {
             for ( EnvEntry envEntry : context.getEnvEntries() )
             {
                 envEntry.appendEnvEntry( writer );
             }
         }
         
         if ( version.ge( JavaEEVersion.Five ) )
         {
             writeLibraryDirectory( context.getLibraryDirectory(), writer );
         }
 
         writer.endElement();
 
         close( w );
     }
 
     private void writeApplicationName( String applicationName, XMLWriter writer )
     {
         if ( applicationName != null )
         {
             writer.startElement( "application-name" );
             writer.writeText( applicationName );
             writer.endElement();
         }
     }
 
     private void writeDescription( String description, XMLWriter writer )
     {
         if ( description != null )
         {
             writer.startElement( "description" );
             writer.writeText( description );
             writer.endElement();
         }
     }
 
     private void writeDisplayName( String displayName, XMLWriter writer )
     {
         if ( displayName != null )
         {
             writer.startElement( "display-name" );
             writer.writeText( displayName );
             writer.endElement();
         }
     }
 
     private void writeInitializeInOrder( Boolean initializeInOrder, XMLWriter writer )
     {
         if ( initializeInOrder != null )
         {
             writer.startElement( "initialize-in-order" );
             writer.writeText( initializeInOrder.toString() );
             writer.endElement();
         }
     }
 
     private void writeLibraryDirectory( String libraryDirectory, XMLWriter writer )
     {
         if ( libraryDirectory != null )
         {
             writer.startElement( "library-directory" );
             writer.writeText( libraryDirectory );
             writer.endElement();
         }
     }
 
     private XMLWriter initializeRootElementOneDotThree( Writer w )
     {
         XMLWriter writer = initializeXmlWriter( w, DOCTYPE_1_3 );
         writer.startElement( APPLICATION_ELEMENT );
         return writer;
     }
 
     private XMLWriter initializeRootElementOneDotFour( Writer w )
     {
         XMLWriter writer = initializeXmlWriter( w, null );
         writer.startElement( APPLICATION_ELEMENT );
         writer.addAttribute( "xmlns", "http://java.sun.com/xml/ns/j2ee" );
         writer.addAttribute( "xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance" );
         writer.addAttribute( "xsi:schemaLocation",
                              "http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/application_1_4.xsd" );
         writer.addAttribute( "version", "1.4" );
         return writer;
     }
 
     private XMLWriter initializeRootElementFive( Writer w )
     {
         XMLWriter writer = initializeXmlWriter( w, null );
         writer.startElement( APPLICATION_ELEMENT );
         writer.addAttribute( "xmlns", "http://java.sun.com/xml/ns/javaee" );
         writer.addAttribute( "xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance" );
         writer.addAttribute( "xsi:schemaLocation",
                              "http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/application_5.xsd" );
         writer.addAttribute( "version", "5" );
         return writer;
     }
 
     private XMLWriter initializeRootElementSix( Writer w )
     {
         XMLWriter writer = initializeXmlWriter( w, null );
         writer.startElement( APPLICATION_ELEMENT );
         writer.addAttribute( "xmlns", "http://java.sun.com/xml/ns/javaee" );
         writer.addAttribute( "xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance" );
         writer.addAttribute( "xsi:schemaLocation",
                              "http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/application_6.xsd" );
         writer.addAttribute( "version", "6" );
         return writer;
     }
 
 }

1		package org.apache.maven.plugin.ear;
2
3		/*
4		* Licensed to the Apache Software Foundation (ASF) under one
5		* or more contributor license agreements. See the NOTICE file
6		* distributed with this work for additional information
7		* regarding copyright ownership. The ASF licenses this file
8		* to you under the Apache License, Version 2.0 (the
9		* "License"); you may not use this file except in compliance
10		* with the License. You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing,
15		* software distributed under the License is distributed on an
16		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17		* KIND, either express or implied. See the License for the
18		* specific language governing permissions and limitations
19		* under the License.
20		*/
21
22		import java.io.Writer;
23
24		import org.apache.maven.plugin.ear.util.JavaEEVersion;
25		import org.codehaus.plexus.util.xml.XMLWriter;
26
27		/**
28		* An <tt>XmlWriter</tt> based implementation used to generate an
29		* <tt>application.xml</tt> file
30		*
31		* @author <a href="snicoll@apache.org">Stephane Nicoll</a>
32		* @version $Id: ApplicationXmlWriter.java 1377219 2012-08-25 05:42:36Z snicoll $
33		*/
34		final class ApplicationXmlWriter
35		extends AbstractXmlWriter
36		{
37		public static final String DOCTYPE_1_3 =
38		"application PUBLIC\n" + "\t\"-//Sun Microsystems, Inc.//DTD J2EE Application 1.3//EN\"\n"
39		+ "\t\"http://java.sun.com/dtd/application_1_3.dtd\"";
40
41		private static final String APPLICATION_ELEMENT = "application";
42
43
44		private final JavaEEVersion version;
45
46		private final Boolean generateModuleId;
47
48		ApplicationXmlWriter( JavaEEVersion version, String encoding, Boolean generateModuleId )
49		{
50	0	super( encoding );
51	0	this.version = version;
52	0	this.generateModuleId = generateModuleId;
53	0	}
54
55		public void write( ApplicationXmlWriterContext context )
56		throws EarPluginException
57		{
58	0	Writer w = initializeWriter( context.getDestinationFile() );
59
60	0	XMLWriter writer = null;
61	0	if ( JavaEEVersion.OneDotThree.eq( version ) )
62		{
63	0	writer = initializeRootElementOneDotThree( w );
64		}
65	0	else if ( JavaEEVersion.OneDotFour.eq( version ) )
66		{
67	0	writer = initializeRootElementOneDotFour( w );
68		}
69	0	else if ( JavaEEVersion.Five.eq( version ) )
70		{
71	0	writer = initializeRootElementFive( w );
72		}
73	0	else if ( JavaEEVersion.Six.eq( version ) )
74		{
75	0	writer = initializeRootElementSix( w );
76		}
77
78		// As from JavaEE6
79	0	if ( version.ge( JavaEEVersion.Six ) )
80		{
81	0	writeApplicationName( context.getApplicationName(), writer );
82		}
83
84		// IMPORTANT: the order of the description and display-name elements was
85		// reversed between J2EE 1.3 and J2EE 1.4.
86	0	if ( version.eq( JavaEEVersion.OneDotThree ) )
87		{
88	0	writeDisplayName( context.getDisplayName(), writer );
89	0	writeDescription( context.getDescription(), writer );
90		}
91		else
92		{
93	0	writeDescription( context.getDescription(), writer );
94	0	writeDisplayName( context.getDisplayName(), writer );
95		}
96
97		// As from JavaEE6
98	0	if ( version.ge( JavaEEVersion.Six ) )
99		{
100	0	writeInitializeInOrder( context.getInitializeInOrder(), writer );
101		}
102
103		// Do not change this unless you really know what you're doing :)
104	0	for ( EarModule module : context.getEarModules() )
105		{
106	0	module.appendModule( writer, version.getVersion(), generateModuleId );
107		}
108
109	0	for ( SecurityRole securityRole : context.getSecurityRoles() )
110		{
111	0	securityRole.appendSecurityRole( writer );
112		}
113
114	0	if ( version.ge( JavaEEVersion.Six ) )
115		{
116	0	for ( EnvEntry envEntry : context.getEnvEntries() )
117		{
118	0	envEntry.appendEnvEntry( writer );
119		}
120		}
121
122	0	if ( version.ge( JavaEEVersion.Five ) )
123		{
124	0	writeLibraryDirectory( context.getLibraryDirectory(), writer );
125		}
126
127	0	writer.endElement();
128
129	0	close( w );
130	0	}
131
132		private void writeApplicationName( String applicationName, XMLWriter writer )
133		{
134	0	if ( applicationName != null )
135		{
136	0	writer.startElement( "application-name" );
137	0	writer.writeText( applicationName );
138	0	writer.endElement();
139		}
140	0	}
141
142		private void writeDescription( String description, XMLWriter writer )
143		{
144	0	if ( description != null )
145		{
146	0	writer.startElement( "description" );
147	0	writer.writeText( description );
148	0	writer.endElement();
149		}
150	0	}
151
152		private void writeDisplayName( String displayName, XMLWriter writer )
153		{
154	0	if ( displayName != null )
155		{
156	0	writer.startElement( "display-name" );
157	0	writer.writeText( displayName );
158	0	writer.endElement();
159		}
160	0	}
161
162		private void writeInitializeInOrder( Boolean initializeInOrder, XMLWriter writer )
163		{
164	0	if ( initializeInOrder != null )
165		{
166	0	writer.startElement( "initialize-in-order" );
167	0	writer.writeText( initializeInOrder.toString() );
168	0	writer.endElement();
169		}
170	0	}
171
172		private void writeLibraryDirectory( String libraryDirectory, XMLWriter writer )
173		{
174	0	if ( libraryDirectory != null )
175		{
176	0	writer.startElement( "library-directory" );
177	0	writer.writeText( libraryDirectory );
178	0	writer.endElement();
179		}
180	0	}
181
182		private XMLWriter initializeRootElementOneDotThree( Writer w )
183		{
184	0	XMLWriter writer = initializeXmlWriter( w, DOCTYPE_1_3 );
185	0	writer.startElement( APPLICATION_ELEMENT );
186	0	return writer;
187		}
188
189		private XMLWriter initializeRootElementOneDotFour( Writer w )
190		{
191	0	XMLWriter writer = initializeXmlWriter( w, null );
192	0	writer.startElement( APPLICATION_ELEMENT );
193	0	writer.addAttribute( "xmlns", "http://java.sun.com/xml/ns/j2ee" );
194	0	writer.addAttribute( "xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance" );
195	0	writer.addAttribute( "xsi:schemaLocation",
196		"http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/application_1_4.xsd" );
197	0	writer.addAttribute( "version", "1.4" );
198	0	return writer;
199		}
200
201		private XMLWriter initializeRootElementFive( Writer w )
202		{
203	0	XMLWriter writer = initializeXmlWriter( w, null );
204	0	writer.startElement( APPLICATION_ELEMENT );
205	0	writer.addAttribute( "xmlns", "http://java.sun.com/xml/ns/javaee" );
206	0	writer.addAttribute( "xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance" );
207	0	writer.addAttribute( "xsi:schemaLocation",
208		"http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/application_5.xsd" );
209	0	writer.addAttribute( "version", "5" );
210	0	return writer;
211		}
212
213		private XMLWriter initializeRootElementSix( Writer w )
214		{
215	0	XMLWriter writer = initializeXmlWriter( w, null );
216	0	writer.startElement( APPLICATION_ELEMENT );
217	0	writer.addAttribute( "xmlns", "http://java.sun.com/xml/ns/javaee" );
218	0	writer.addAttribute( "xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance" );
219	0	writer.addAttribute( "xsi:schemaLocation",
220		"http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/application_6.xsd" );
221	0	writer.addAttribute( "version", "6" );
222	0	return writer;
223		}
224
225		}