| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package com.sun.jarsigner; |
| 27 | |
| 28 | import java.io.IOException; |
| 29 | import java.security.NoSuchAlgorithmException; |
| 30 | import java.security.cert.CertificateException; |
| 31 | |
| 32 | /** |
| 33 | * This class defines a content signing service. |
| 34 | * Implementations must be instantiable using a zero-argument constructor. |
| 35 | * |
| 36 | * @since 1.5 |
| 37 | * @author Vincent Ryan |
| 38 | */ |
| 39 | |
| 40 | public abstract class ContentSigner { |
| 41 | |
| 42 | /** |
| 43 | * Generates a PKCS #7 signed data message. |
| 44 | * This method is used when the signature has already been generated. |
| 45 | * The signature, the signer's details, and optionally a signature |
| 46 | * timestamp and the content that was signed, are all packaged into a |
| 47 | * signed data message. |
| 48 | * |
| 49 | * @param parameters The non-null input parameters. |
| 50 | * @param omitContent true if the content should be omitted from the |
| 51 | * signed data message. Otherwise the content is included. |
| 52 | * @param applyTimestamp true if the signature should be timestamped. |
| 53 | * Otherwise timestamping is not performed. |
| 54 | * @return A PKCS #7 signed data message. |
| 55 | * @throws NoSuchAlgorithmException The exception is thrown if the signature |
| 56 | * algorithm is unrecognised. |
| 57 | * @throws CertificateException The exception is thrown if an error occurs |
| 58 | * while processing the signer's certificate or the TSA's |
| 59 | * certificate. |
| 60 | * @throws IOException The exception is thrown if an error occurs while |
| 61 | * generating the signature timestamp or while generating the signed |
| 62 | * data message. |
| 63 | * @throws NullPointerException The exception is thrown if parameters is |
| 64 | * null. |
| 65 | */ |
| 66 | public abstract byte[] generateSignedData( |
| 67 | ContentSignerParameters parameters, boolean omitContent, |
| 68 | boolean applyTimestamp) |
| 69 | throws NoSuchAlgorithmException, CertificateException, IOException; |
| 70 | } |