org.apache.maven.shared.jarsigner.JarSignerRequest Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.shared.jarsigner;
import java.io.File;
import org.apache.maven.shared.utils.cli.javatool.JavaToolRequest;
/**
* Specifies the common parameters used to control a JarSigner tool invocation.
*
* @author Tony Chemit
* @since 1.0
*/
public interface JarSignerRequest extends JavaToolRequest {
/**
* Gets the value of the {@code verbose} field.
*
* @return the value of the {@code verbose} field.
*/
boolean isVerbose();
/**
* Gets the value of the {@code keystore} field.
*
* @return the value of the {@code keystore} field.
*/
String getKeystore();
/**
* Gets the value of the {@code storetype} field.
*
* @return the value of the {@code storetype} field.
*/
String getStoretype();
/**
* Gets the value of the {@code storepass} field.
*
* @return the value of the {@code storepass} field.
*/
String getStorepass();
/**
* Gets the value of the {@code providerName} field.
*
* @return the value of the {@code providerName} field.
*/
String getProviderName();
/**
* Gets the value of the {@code providerClass} field.
*
* @return the value of the {@code providerClass} field.
*/
String getProviderClass();
/**
* Gets the value of the {@code providerArg} field.
*
* @return the value of the {@code providerArg} field.
*/
String getProviderArg();
/**
* Gets the value of the {@code alias} field.
*
* @return the value of the {@code alias} field.
*/
String getAlias();
/**
* Gets the value of the {@code maxMemory} field.
*
* @return the value of the {@code maxMemory} field.
*/
String getMaxMemory();
/**
* Gets the value of the {@code maxMemory} field.
*
* @return the value of the {@code maxMemory} field.
*/
String[] getArguments();
/**
* Gets the value of the {@code workingDirectory} field.
*
* @return the value of the {@code workingDirectory} field.
*/
File getWorkingDirectory();
/**
* Gets the value of the {@code archive} field.
*
* The archive field is in fact the file on which the jarsigner request will be executed.
*
*
* @return the value of the {@code archive} field.
*/
File getArchive();
/**
* Gets the value of the command line tool parameter protected
*
* @return true iff the password must be given via a protected
* authentication path such as a dedicated PIN reader
*/
boolean isProtectedAuthenticationPath();
/**
* Sets the new given value to the field {@code verbose} of the request.
*
* @param verbose the new value of the field {@code verbose}.
*/
void setVerbose(boolean verbose);
/**
* Sets the new given value to the field {@code keystore} of the request.
*
* @param keystore the new value of the field {@code keystore}.
*/
void setKeystore(String keystore);
/**
* Sets the new given value to the field {@code storetype} of the request.
*
* @param storetype the new value of the field {@code storetype}.
*/
void setStoretype(String storetype);
/**
* Sets the new given value to the field {@code storepass} of the request.
*
* @param storepass the new value of the field {@code storepass}.
*/
void setStorepass(String storepass);
/**
* Sets the new given value to the field {@code alias} of the request.
*
* @param alias the new value of the field {@code alias}.
*/
void setAlias(String alias);
/**
* Sets the new given value to the field {@code providerName} of the request.
*
* @param providerName the new value of the field {@code providerName}.
*/
void setProviderName(String providerName);
/**
* Sets the new given value to the field {@code providerClass} of the request.
*
* @param providerClass the new value of the field {@code providerClass}.
*/
void setProviderClass(String providerClass);
/**
* Sets the new given value to the field {@code providerArg} of the request.
*
* @param providerArg the new value of the field {@code providerArg}.
*/
void setProviderArg(String providerArg);
/**
* Sets the new given value to the field {@code maxMemory} of the request.
*
* @param maxMemory the new value of the field {@code maxMemory}.
*/
void setMaxMemory(String maxMemory);
/**
* Sets the new given value to the field {@code arguments} of the request.
*
* @param arguments the new value of the field {@code arguments}.
*/
void setArguments(String... arguments);
/**
* Sets the new given value to the field {@code workingDirectory} of the request.
*
* @param workingDirectory the new value of the field {@code workingDirectory}.
*/
void setWorkingDirectory(File workingDirectory);
/**
* Sets the new given value to the field {@code archive} of the request.
*
* @param archive the new value of the field {@code archive}.
*/
void setArchive(File archive);
/**
* Sets the value of the command line tool parameter protected
*
* @param protectedAuthenticationPath iff the password must be given via a protected
* authentication path such as a dedicated PIN reader
*/
void setProtectedAuthenticationPath(boolean protectedAuthenticationPath);
}