View Javadoc

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 org.apache.maven.artifact.Artifact;
23  import org.apache.maven.plugin.ear.util.ArtifactTypeMappingService;
24  import org.apache.maven.plugin.ear.util.JavaEEVersion;
25  
26  import java.util.ArrayList;
27  import java.util.Collections;
28  import java.util.List;
29  
30  /**
31   * Builds an {@link EarModule} based on an <tt>Artifact</tt>.
32   * 
33   * @author <a href="snicoll@apache.org">Stephane Nicoll</a>
34   * @version $Id: EarModuleFactory.java 1542508 2013-11-16 13:21:35Z rfscholte $
35   */
36  public final class EarModuleFactory
37  {
38      public static final List<String> standardArtifactTypes;
39  
40      static
41      {
42          List<String> temp = new ArrayList<String>();
43          temp.add( "jar" );
44          temp.add( "ejb" );
45          temp.add( "ejb3" );
46          temp.add( "par" );
47          temp.add( "ejb-client" );
48          temp.add( "app-client" );
49          temp.add( "rar" );
50          temp.add( "war" );
51          temp.add( "sar" );
52          temp.add( "wsr" );
53          temp.add( "har" );
54          standardArtifactTypes = Collections.unmodifiableList( temp );
55      }
56  
57      /**
58       * Creates a new {@link EarModule} based on the specified {@link Artifact} and the specified execution
59       * configuration.
60       * 
61       * @param artifact the artifact
62       * @param javaEEVersion the javaEE version to use
63       * @param defaultLibBundleDir the default bundle dir for {@link org.apache.maven.plugin.ear.JarModule}
64       * @param includeInApplicationXml should {@link org.apache.maven.plugin.ear.JarModule} be included in application
65       *            Xml
66       * @param typeMappingService The artifact type mapping service
67       * @return an ear module for this artifact
68       * @throws UnknownArtifactTypeException if the artifact is not handled
69       */
70      @SuppressWarnings( "deprecation" )
71      public static EarModule newEarModule( Artifact artifact, JavaEEVersion javaEEVersion, String defaultLibBundleDir,
72                                            Boolean includeInApplicationXml, ArtifactTypeMappingService typeMappingService )
73          throws UnknownArtifactTypeException
74      {
75          // Get the standard artifact type based on default config and user-defined mapping(s)
76          final String artifactType;
77          try
78          {
79              artifactType = typeMappingService.getStandardType( artifact.getType() );
80          }
81          catch ( UnknownArtifactTypeException e )
82          {
83              throw new UnknownArtifactTypeException( e.getMessage() + " for " + artifact.getArtifactId() );
84          }
85  
86          if ( "jar".equals( artifactType ) )
87          {
88              return new JarModule( artifact, defaultLibBundleDir, includeInApplicationXml );
89          }
90          else if ( "ejb".equals( artifactType ) )
91          {
92              return new EjbModule( artifact );
93          }
94          else if ( "ejb3".equals( artifactType ) )
95          {
96              return new Ejb3Module( artifact );
97          }
98          else if ( "par".equals( artifactType ) )
99          {
100             return new ParModule( artifact );
101         }
102         else if ( "ejb-client".equals( artifactType ) )
103         {
104             // Somewhat weird way to tackle the problem described in MEAR-85
105             if ( javaEEVersion.le( JavaEEVersion.OneDotFour ) )
106             {
107                 return new EjbClientModule( artifact, null );
108             }
109             else
110             {
111                 return new EjbClientModule( artifact, defaultLibBundleDir );
112             }
113         }
114         else if ( "app-client".equals( artifactType ) )
115         {
116             return new AppClientModule( artifact );
117         }
118         else if ( "rar".equals( artifactType ) )
119         {
120             return new RarModule( artifact );
121         }
122         else if ( "war".equals( artifactType ) )
123         {
124             return new WebModule( artifact );
125         }
126         else if ( "sar".equals( artifactType ) )
127         {
128             return new SarModule( artifact );
129         }
130         else if ( "wsr".equals( artifactType ) )
131         {
132             return new WsrModule( artifact );
133         }
134         else if ( "har".equals( artifactType ) )
135         {
136             return new HarModule( artifact );
137         }
138         else
139         {
140             throw new IllegalStateException( "Could not handle artifact type[" + artifactType + "]" );
141         }
142     }
143 
144     /**
145      * Returns a list of standard artifact types.
146      * 
147      * @return the standard artifact types
148      */
149     public static List<String> getStandardArtifactTypes()
150     {
151         return standardArtifactTypes;
152     }
153 
154     /**
155      * Specify whether the specified type is standard artifact type.
156      * 
157      * @param type the type to check
158      * @return true if the specified type is a standard artifact type
159      */
160     public static boolean isStandardArtifactType( final String type )
161     {
162         return standardArtifactTypes.contains( type );
163     }
164 
165 }