View Javadoc

1   package org.codehaus.mojo.jboss.packaging;
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.File;
23  
24  /**
25   * Builds a deployable JBoss AOP Archive.
26   * 
27   * @goal aop
28   * @phase package
29   * @requiresDependencyResolution runtime
30   * @threadSafe
31   * @since 2.2
32   */
33  public class AopMojo
34      extends AbstractPackagingMojo
35  {
36      /**
37       * The artifact type.
38       */
39      private static final String ARTIFACT_TYPE = "jboss-aop";
40  
41      /**
42       * The location of the JBoss AOP descriptor file (jboss-aop.xml). If it is present in src/main/resources/META-INF
43       * then it will automatically be included. Otherwise this parameter must be set.
44       * 
45       * @parameter default-value="${project.build.outputDirectory}/META-INF/jboss-aop.xml"
46       *            expression="${deploymentDescriptorFile}"
47       */
48      private File deploymentDescriptorFile;
49  
50      /**
51       * Get the type of the artifact.
52       * 
53       * @return The type of the generated artifact.
54       */
55      public String getArtifactType()
56      {
57          return ARTIFACT_TYPE;
58      }
59  
60      public File getDeploymentDescriptor()
61      {
62          return deploymentDescriptorFile;
63      }
64  
65  }