View Javadoc
1   package org.apache.maven.plugins.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.codehaus.plexus.util.xml.XMLWriter;
24  
25  /**
26   * The {@link EarModule} implementation for a JBoss Hibernate archive.
27   * 
28   * @author <a href="snicoll@apache.org">Stephane Nicoll</a>
29   */
30  public class HarModule
31      extends AbstractEarModule
32      implements JbossEarModule
33  {
34      /**
35       * Default type of the artifact of a JBoss Hibernate archive.
36       */
37      public static final String DEFAULT_ARTIFACT_TYPE = "har";
38  
39      private static final String DEFAULT_LIB_DIRECTORY = "lib";
40  
41      /**
42       * Create an instance.
43       */
44      public HarModule()
45      {
46          this.type = DEFAULT_ARTIFACT_TYPE;
47          this.libDirectory = DEFAULT_LIB_DIRECTORY;
48      }
49  
50      /**
51       * @param a {@link Artifact}
52       */
53      public HarModule( Artifact a )
54      {
55          super( a );
56          this.libDirectory = DEFAULT_LIB_DIRECTORY;
57      }
58  
59      /**
60       * {@inheritDoc}
61       */
62      public void appendModule( XMLWriter writer, String version, Boolean generateId )
63      {
64          // No entry is generated by this artifact ; it should be
65          // defined in the jboss-app.xml.
66          // See http://docs.jboss.org/jbossas/getting_started/v4/html/hibernate.html
67      }
68  
69      /**
70       * {@inheritDoc}
71       */
72      public void appendJbossModule( XMLWriter writer, String version )
73      {
74          writer.startElement( MODULE_ELEMENT );
75          writer.startElement( "har" );
76          writer.writeText( getUri() );
77          writer.endElement();
78          writer.endElement();
79      }
80  }