View Javadoc
1   package org.apache.maven.plugin.assembly;
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.archiver.MavenArchiveConfiguration;
23  import org.apache.maven.artifact.repository.ArtifactRepository;
24  import org.apache.maven.execution.MavenSession;
25  import org.apache.maven.project.MavenProject;
26  import org.apache.maven.shared.filtering.MavenFileFilter;
27  import org.apache.maven.shared.filtering.MavenReaderFilter;
28  
29  import java.io.File;
30  import java.util.List;
31  
32  /**
33   * @version $Id: AssemblerConfigurationSource.java 1633510 2014-10-22 04:01:59Z krosenvold $
34   */
35  public interface AssemblerConfigurationSource
36  {
37  
38      /**
39       * @return The descriptor.
40       */
41      String getDescriptor();
42  
43      /**
44       * @return The descriptor id.
45       */
46      String getDescriptorId();
47  
48      /**
49       * @return The descriptors.
50       */
51      String[] getDescriptors();
52  
53      /**
54       * @return The descriptor references.
55       */
56      String[] getDescriptorReferences();
57  
58      /**
59       * @return The descriptor source direcotoy.
60       */
61      File getDescriptorSourceDirectory();
62  
63      /**
64       * @return The base directory.
65       */
66      File getBasedir();
67  
68      /**
69       * @return The Maven Project.
70       */
71      MavenProject getProject();
72  
73      /**
74       * @return Site included.
75       */
76      boolean isSiteIncluded();
77  
78      /**
79       * @return The site directory.
80       */
81      File getSiteDirectory();
82  
83      /**
84       * @return The final name.
85       */
86      String getFinalName();
87  
88      /**
89       * @return append the assembly id.
90       */
91      boolean isAssemblyIdAppended();
92  
93      /**
94       * @return The classifier.
95       */
96      String getClassifier();
97  
98      /**
99       * @return Tar long file mode.
100      */
101     String getTarLongFileMode();
102 
103     /**
104      * @return The output directory.
105      */
106     File getOutputDirectory();
107 
108     /**
109      * @return The working direcotory.
110      */
111     File getWorkingDirectory();
112 
113     /**
114      * @return the jar archive configuration.
115      */
116     MavenArchiveConfiguration getJarArchiveConfiguration();
117 
118     /**
119      * @return The local repository.
120      */
121     ArtifactRepository getLocalRepository();
122 
123     /**
124      * @return The temporary root directory.
125      */
126     File getTemporaryRootDirectory();
127 
128     /**
129      * @return The archive base directory.
130      */
131     File getArchiveBaseDirectory();
132 
133     /**
134      * @return The filters.
135      */
136     List<String> getFilters();
137 
138     /**
139      * @return include the project build filters or not.
140      */
141     boolean isIncludeProjectBuildFilters();
142 
143     /**
144      * @return The list of reactor projects.
145      */
146     List<MavenProject> getReactorProjects();
147 
148     /**
149      * @return The remote repositories.
150      */
151     List<ArtifactRepository> getRemoteRepositories();
152 
153     /**
154      * @return Is this a test run.
155      */
156     boolean isDryRun();
157 
158     /**
159      * @return Ignore directory format extensions.
160      */
161     boolean isIgnoreDirFormatExtensions();
162 
163     /**
164      * @return Ignore missing descriptor.
165      */
166     boolean isIgnoreMissingDescriptor();
167 
168     /**
169      * @return The maven session.
170      */
171     MavenSession getMavenSession();
172 
173     /**
174      * @return The archiver configu.
175      */
176     String getArchiverConfig();
177 
178     /**
179      * @return The maven file filter.
180      */
181     MavenFileFilter getMavenFileFilter();
182 
183     /**
184      * Maven shared filtering utility.
185      */
186     MavenReaderFilter getMavenReaderFilter();
187 
188     /**
189      * @return Update only yes/no.
190      */
191     boolean isUpdateOnly();
192 
193     /**
194      * @return Use JVM chmod yes/no.
195      */
196     boolean isUseJvmChmod();
197 
198     /**
199      * @return Ignore permissions yes/no.
200      */
201     boolean isIgnorePermissions();
202 
203     /**
204      * @return The current encoding.
205      */
206     String getEncoding();
207 
208     /**
209      * @return The escape string.
210      */
211     String getEscapeString();
212 
213     /**
214      * @return The list of delimiters.
215      */
216     List<String> getDelimiters();
217 
218 }