1 package org.apache.maven.shared.jarsigner;
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.shared.utils.cli.javatool.JavaToolRequest;
23
24 import java.io.File;
25
26 /**
27 * Specifies the common parameters used to control a JarSigner tool invocation.
28 *
29 * @author tchemit <chemit@codelutin.com>
30 * @version $Id: JarSignerRequest.java 1635394 2014-10-30 05:57:36Z hboutemy $
31 * @since 1.0
32 */
33 public interface JarSignerRequest
34 extends JavaToolRequest
35 {
36
37 /**
38 * Gets the value of the {@code verbose} field.
39 *
40 * @return the value of the {@code verbose} field.
41 */
42 boolean isVerbose();
43
44 /**
45 * Gets the value of the {@code keystore} field.
46 *
47 * @return the value of the {@code keystore} field.
48 */
49 String getKeystore();
50
51 /**
52 * Gets the value of the {@code storetype} field.
53 *
54 * @return the value of the {@code storetype} field.
55 */
56 String getStoretype();
57
58 /**
59 * Gets the value of the {@code storepass} field.
60 *
61 * @return the value of the {@code storepass} field.
62 */
63 String getStorepass();
64
65 /**
66 * Gets the value of the {@code providerName} field.
67 *
68 * @return the value of the {@code providerName} field.
69 */
70 String getProviderName();
71
72 /**
73 * Gets the value of the {@code providerClass} field.
74 *
75 * @return the value of the {@code providerClass} field.
76 */
77 String getProviderClass();
78
79 /**
80 * Gets the value of the {@code providerArg} field.
81 *
82 * @return the value of the {@code providerArg} field.
83 */
84 String getProviderArg();
85
86 /**
87 * Gets the value of the {@code alias} field.
88 *
89 * @return the value of the {@code alias} field.
90 */
91 String getAlias();
92
93 /**
94 * Gets the value of the {@code maxMemory} field.
95 *
96 * @return the value of the {@code maxMemory} field.
97 */
98 String getMaxMemory();
99
100 /**
101 * Gets the value of the {@code maxMemory} field.
102 *
103 * @return the value of the {@code maxMemory} field.
104 */
105 String[] getArguments();
106
107 /**
108 * Gets the value of the {@code workingDirectory} field.
109 *
110 * @return the value of the {@code workingDirectory} field.
111 */
112 File getWorkingDirectory();
113
114 /**
115 * Gets the value of the {@code archive} field.
116 * <p/>
117 * The archive field is in fact the file on which the jarsigner request will be executed.
118 *
119 * @return the value of the {@code archive} field.
120 */
121 File getArchive();
122
123 /**
124 * Gets the value of the command line tool parameter <pre>protected</pre>
125 *
126 * @return true iff the password must be given via a protected
127 * authentication path such as a dedicated PIN reader
128 */
129 boolean isProtectedAuthenticationPath();
130
131 /**
132 * Sets the new given value to the field {@code verbose} of the request.
133 *
134 * @param verbose the new value of the field {@code verbose}.
135 */
136 void setVerbose( boolean verbose );
137
138 /**
139 * Sets the new given value to the field {@code keystore} of the request.
140 *
141 * @param keystore the new value of the field {@code keystore}.
142 */
143 void setKeystore( String keystore );
144
145 /**
146 * Sets the new given value to the field {@code storetype} of the request.
147 *
148 * @param storetype the new value of the field {@code storetype}.
149 */
150 void setStoretype( String storetype );
151
152 /**
153 * Sets the new given value to the field {@code storepass} of the request.
154 *
155 * @param storepass the new value of the field {@code storepass}.
156 */
157 void setStorepass( String storepass );
158
159 /**
160 * Sets the new given value to the field {@code alias} of the request.
161 *
162 * @param alias the new value of the field {@code alias}.
163 */
164 void setAlias( String alias );
165
166 /**
167 * Sets the new given value to the field {@code providerName} of the request.
168 *
169 * @param providerName the new value of the field {@code providerName}.
170 */
171 void setProviderName( String providerName );
172
173 /**
174 * Sets the new given value to the field {@code providerClass} of the request.
175 *
176 * @param providerClass the new value of the field {@code providerClass}.
177 */
178 void setProviderClass( String providerClass );
179
180 /**
181 * Sets the new given value to the field {@code providerArg} of the request.
182 *
183 * @param providerArg the new value of the field {@code providerArg}.
184 */
185 void setProviderArg( String providerArg );
186
187 /**
188 * Sets the new given value to the field {@code maxMemory} of the request.
189 *
190 * @param maxMemory the new value of the field {@code maxMemory}.
191 */
192 void setMaxMemory( String maxMemory );
193
194 /**
195 * Sets the new given value to the field {@code arguments} of the request.
196 *
197 * @param arguments the new value of the field {@code arguments}.
198 */
199 void setArguments( String... arguments );
200
201 /**
202 * Sets the new given value to the field {@code workingDirectory} of the request.
203 *
204 * @param workingDirectory the new value of the field {@code workingDirectory}.
205 */
206 void setWorkingDirectory( File workingDirectory );
207
208 /**
209 * Sets the new given value to the field {@code archive} of the request.
210 *
211 * @param archive the new value of the field {@code archive}.
212 */
213 void setArchive( File archive );
214
215 /**
216 * Sets the value of the command line tool parameter <pre>protected</pre>
217 *
218 * @param protectedAuthenticationPath iff the password must be given via a protected
219 * authentication path such as a dedicated PIN reader
220 */
221 void setProtectedAuthenticationPath( boolean protectedAuthenticationPath );
222
223 }