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 Spring Archive.
26 *
27 * @goal spring
28 * @phase package
29 * @requiresDependencyResolution runtime
30 * @threadSafe
31 */
32 public class SpringMojo
33 extends AbstractPackagingMojo
34 {
35
36 /**
37 * The location of the jboss deployment descriptor file (jboss-spring.xml). If it is present in
38 * src/main/resources/META-INF with that name then it will automatically be included. Otherwise this parameter must
39 * be set.
40 *
41 * @parameter default-value="${project.build.outputDirectory}/META-INF/jboss-spring.xml"
42 * expression="${deploymentDescriptorFile}"
43 */
44 private File deploymentDescriptorFile;
45
46 /**
47 * The artifact type.
48 */
49 private static final String ARTIFACT_TYPE = "jboss-spring";
50
51 /**
52 * Return the name of the jboss-spring deployment descriptor (jboss-spring.xml).
53 *
54 * @return Filename of the jboss spring deployment descriptor
55 */
56 public File getDeploymentDescriptor()
57 {
58 return deploymentDescriptorFile;
59 }
60
61 /**
62 * Get the type of the artifact.
63 *
64 * @return The type of the generated artifact.
65 */
66 public String getArtifactType()
67 {
68 return ARTIFACT_TYPE;
69 }
70
71 }