PDFEncryption


1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  /* $Id: PDFEncryption.java 426576 2006-07-28 15:44:37Z jeremias $ */
19   
20  package org.apache.fop.pdf;
21  
22  /**
23   * This interface defines the contract for classes implementing PDF encryption.
24   */
25  public interface PDFEncryption {
26  
27      /**
28       * Returns the encryption parameters.
29       * @return the encryption parameters
30       */
31      PDFEncryptionParams getParams();
32  
33      /**
34       * Sets the encryption parameters.
35       * @param params The parameterss to set
36       */
37      void setParams(PDFEncryptionParams params);
38  
39      /**
40       * Adds a PDFFilter to the PDFStream object
41       * @param stream the stream to add an encryption filter to
42       */    
43      void applyFilter(AbstractPDFStream stream);
44   
45      /**
46       * Encrypt an array of bytes using a reference PDFObject for calculating
47       * the encryption key.
48       * @param data data to encrypt
49       * @param refObj reference PDFObject
50       * @return byte[] the encrypted data
51       */
52      byte[] encrypt(byte[] data, PDFObject refObj);
53   
54      /**
55       * Returns the trailer entry for encryption.
56       * @return the trailer entry
57       */
58      String   getTrailerEntry();
59  }
60
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags