1 package org.apache.maven.plugin.ear;
2
3 import java.io.File;
4 import java.util.List;
5
6 /*
7 * Licensed to the Apache Software Foundation (ASF) under one
8 * or more contributor license agreements. See the NOTICE file
9 * distributed with this work for additional information
10 * regarding copyright ownership. The ASF licenses this file
11 * to you under the Apache License, Version 2.0 (the
12 * "License"); you may not use this file except in compliance
13 * with the License. You may obtain a copy of the License at
14 *
15 * http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing,
18 * software distributed under the License is distributed on an
19 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20 * KIND, either express or implied. See the License for the
21 * specific language governing permissions and limitations
22 * under the License.
23 */
24
25 /**
26 * A context for the {@link ApplicationXmlWriter}.
27 *
28 * @author <a href="snicoll@apache.org">Stephane Nicoll</a>
29 * @version $Id: ApplicationXmlWriter.java 728546 2008-12-21 22:56:51Z bentmann $
30 */
31 class ApplicationXmlWriterContext {
32
33 private final File destinationFile;
34 private final List earModules;
35 private final List securityRoles;
36 private final String displayName;
37 private final String description;
38 private final String libraryDirectory;
39
40 public ApplicationXmlWriterContext(File destinationFile, List earModules, List securityRoles,
41 String displayName, String description, String libraryDirectory) {
42 this.destinationFile = destinationFile;
43 this.earModules = earModules;
44 this.securityRoles = securityRoles;
45 this.displayName = displayName;
46 this.description = description;
47 this.libraryDirectory = libraryDirectory;
48 }
49
50 /**
51 * Returns the name of the file to use to write application.xml to.
52 *
53 * @return the output file
54 */
55 public File getDestinationFile() {
56 return destinationFile;
57 }
58
59 /**
60 * Returns the list of {@link EarModule} instances.
61 *
62 * @return the ear modules
63 */
64 public List getEarModules() {
65 return earModules;
66 }
67
68 /**
69 * Returns the list of {?link SecurityRole} instances.
70 *
71 * @return the security roles
72 */
73 public List getSecurityRoles() {
74 return securityRoles;
75 }
76
77 /**
78 * Returns the display name.
79 *
80 * @return the display name
81 */
82 public String getDisplayName() {
83 return displayName;
84 }
85
86 /**
87 * Returns the description.
88 *
89 * @return the description
90 */
91 public String getDescription() {
92 return description;
93 }
94
95 /**
96 * Returns the library directory (as per JavaEE 5).
97 *
98 * @return the library directory
99 */
100 public String getLibraryDirectory() {
101 return libraryDirectory;
102 }
103 }