View Javadoc

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.CommandLineException;
23  import org.apache.maven.shared.utils.cli.Commandline;
24  
25  /**
26   * Describes the result of a JarSigner invocation.
27   *
28   * @author tchemit <chemit@codelutin.com>
29   * @version $Id: JarSignerResult.html 885985 2013-11-09 08:11:31Z tchemit $
30   * @since 1.0
31   */
32  public interface JarSignerResult
33  {
34  
35      /**
36       * Gets the command line used.
37       *
38       * @return The command line used
39       */
40      Commandline getCommandline();
41  
42      /**
43       * Gets the exception that possibly occurred during the execution of the command line.
44       *
45       * @return The exception that prevented to invoke Jarsigner or <code>null</code> if the command line was successfully
46       *         processed by the operating system.
47       */
48      CommandLineException getExecutionException();
49  
50      /**
51       * Gets the exit code from the JarSigner invocation. A non-zero value indicates a build failure. <strong>Note:</strong>
52       * This value is undefined if {@link #getExecutionException()} reports an exception.
53       *
54       * @return The exit code from the Jarsigner invocation.
55       */
56      int getExitCode();
57  }