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 java.io.File;
23 import java.util.List;
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
34 private final File destinationFile;
35
36 private final List<EarModule> earModules;
37
38 private final List<SecurityRole> securityRoles;
39
40 private final List<EnvEntry> envEntries;
41
42 private final String displayName;
43
44 private final String description;
45
46 private final String libraryDirectory;
47
48 private final String applicationName;
49
50 private final Boolean initializeInOrder;
51
52 public ApplicationXmlWriterContext( File destinationFile, List<EarModule> earModules, List<SecurityRole> securityRoles,
53 List<EnvEntry> envEntries, String displayName,
54 String description, String libraryDirectory, String applicationName,
55 Boolean initializeInOrder )
56 {
57 this.destinationFile = destinationFile;
58 this.earModules = earModules;
59 this.securityRoles = securityRoles;
60 this.envEntries = envEntries;
61 this.displayName = displayName;
62 this.description = description;
63 this.libraryDirectory = libraryDirectory;
64 this.applicationName = applicationName;
65 this.initializeInOrder = initializeInOrder;
66 }
67
68 /**
69 * Returns the name of the file to use to write application.xml to.
70 *
71 * @return the output file
72 */
73 public File getDestinationFile()
74 {
75 return destinationFile;
76 }
77
78 /**
79 * Returns the list of {@link EarModule} instances.
80 *
81 * @return the ear modules
82 */
83 public List<EarModule> getEarModules()
84 {
85 return earModules;
86 }
87
88 /**
89 * Returns the list of {@link SecurityRole} instances.
90 *
91 * @return the security roles
92 */
93 public List<SecurityRole> getSecurityRoles()
94 {
95 return securityRoles;
96 }
97
98 /**
99 * Returns the list of {@link EnvEntry} instances (as per JavaEE 6).
100 *
101 * @return the env-entry elements
102 */
103 public List<EnvEntry> getEnvEntries()
104 {
105 return envEntries;
106 }
107
108 /**
109 * Returns the display name.
110 *
111 * @return the display name
112 */
113 public String getDisplayName()
114 {
115 return displayName;
116 }
117
118 /**
119 * Returns the description.
120 *
121 * @return the description
122 */
123 public String getDescription()
124 {
125 return description;
126 }
127
128 /**
129 * Returns the library directory (as per JavaEE 5).
130 *
131 * @return the library directory
132 */
133 public String getLibraryDirectory()
134 {
135 return libraryDirectory;
136 }
137
138 /**
139 * Returns the application name (as per JavaEE 6).
140 *
141 * @return the application name
142 */
143 public String getApplicationName()
144 {
145 return applicationName;
146 }
147
148 /**
149 * Returns the value of the initialize in order
150 * parameter (as per JavaEE 6).
151 *
152 * @return the initialize in order value
153 */
154 public Boolean getInitializeInOrder()
155 {
156 return initializeInOrder;
157 }
158 }