KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > pdf > interfaces > PdfEncryptionSettings


1 /*
2  * $Id: PdfEncryptionSettings.java 2730 2007-04-28 12:52:49Z blowagie $
3  *
4  * Copyright 2006 Bruno Lowagie
5  *
6  * The contents of this file are subject to the Mozilla Public License Version 1.1
7  * (the "License"); you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
9  *
10  * Software distributed under the License is distributed on an "AS IS" basis,
11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12  * for the specific language governing rights and limitations under the License.
13  *
14  * The Original Code is 'iText, a free JAVA-PDF library'.
15  *
16  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
17  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
18  * All Rights Reserved.
19  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
20  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
21  *
22  * Contributor(s): all the names of the contributors are added in the source code
23  * where applicable.
24  *
25  * Alternatively, the contents of this file may be used under the terms of the
26  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
27  * provisions of LGPL are applicable instead of those above. If you wish to
28  * allow use of your version of this file only under the terms of the LGPL
29  * License and not to allow others to use your version of this file under
30  * the MPL, indicate your decision by deleting the provisions above and
31  * replace them with the notice and other provisions required by the LGPL.
32  * If you do not delete the provisions above, a recipient may use your version
33  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
34  *
35  * This library is free software; you can redistribute it and/or modify it
36  * under the terms of the MPL as stated above or under the terms of the GNU
37  * Library General Public License as published by the Free Software Foundation;
38  * either version 2 of the License, or any later version.
39  *
40  * This library is distributed in the hope that it will be useful, but WITHOUT
41  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
42  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
43  * details.
44  *
45  * If you didn't download this code from the following link, you should check if
46  * you aren't using an obsolete version:
47  * http://www.lowagie.com/iText/
48  */
49
50 package com.lowagie.text.pdf.interfaces;
51
52 import java.security.cert.Certificate JavaDoc;
53
54 import com.lowagie.text.DocumentException;
55
56 /**
57  * Encryption settings are described in section 3.5 (more specifically
58  * section 3.5.2) of the PDF Reference 1.7.
59  * They are explained in section 3.3.3 of the book 'iText in Action'.
60  * The values of the different preferences were originally stored
61  * in class PdfWriter, but they have been moved to this separate interface
62  * for reasons of convenience.
63  */
64
65 public interface PdfEncryptionSettings {
66
67     
68     /**
69      * Sets the encryption options for this document. The userPassword and the
70      * ownerPassword can be null or have zero length. In this case the ownerPassword
71      * is replaced by a random string. The open permissions for the document can be
72      * AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations,
73      * AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting.
74      * The permissions can be combined by ORing them.
75      * @param userPassword the user password. Can be null or empty
76      * @param ownerPassword the owner password. Can be null or empty
77      * @param permissions the user permissions
78      * @param encryptionType the type of encryption. It can be one of STANDARD_ENCRYPTION_40, STANDARD_ENCRYPTION_128 or ENCRYPTION_AES128.
79      * Optionally DO_NOT_ENCRYPT_METADATA can be ored to output the metadata in cleartext
80      * @throws DocumentException if the document is already open
81      */
82     public void setEncryption(byte userPassword[], byte ownerPassword[], int permissions, int encryptionType) throws DocumentException;
83
84     /**
85      * Sets the certificate encryption options for this document. An array of one or more public certificates
86      * must be provided together with an array of the same size for the permissions for each certificate.
87      * The open permissions for the document can be
88      * AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations,
89      * AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting.
90      * The permissions can be combined by ORing them.
91      * Optionally DO_NOT_ENCRYPT_METADATA can be ored to output the metadata in cleartext
92      * @param certs the public certificates to be used for the encryption
93      * @param permissions the user permissions for each of the certicates
94      * @param encryptionType the type of encryption. It can be one of STANDARD_ENCRYPTION_40, STANDARD_ENCRYPTION_128 or ENCRYPTION_AES128.
95      * @throws DocumentException if the document is already open
96      */
97     public void setEncryption(Certificate JavaDoc[] certs, int[] permissions, int encryptionType) throws DocumentException;
98 }
Popular Tags