ILogExporter


1   /*************************************************************************
2    *                                                                       *
3    *  EJBCA: The OpenSource Certificate Authority                          *
4    *                                                                       *
5    *  This software is free software; you can redistribute it and/or       *
6    *  modify it under the terms of the GNU Lesser General Public           *
7    *  License as published by the Free Software Foundation; either         *
8    *  version 2.1 of the License, or any later version.                    *
9    *                                                                       *
10   *  See terms of license at gnu.org.                                     *
11   *                                                                       *
12   *************************************************************************/
13  
14  package org.ejbca.core.model.log;
15  
16  import java.util.Collection  ;
17  
18  /** This interface is used for exporting a number of log entries to 
19   * any format defined by the implementing class.
20   * 
21   * @author tomas
22   * @version $Id: ILogExporter.java,v 1.2 2006/12/29 11:21:14 anatom Exp $
23   */
24  public interface ILogExporter {
25  
26      /** Sets the entries to be exported. Entries can also be set in the contructor if it is more suitable for 
27       * the implementing class.  
28       * 
29       * @param logentries a Collection of LogEntry
30       */
31      public void setEntries(Collection   logentries);
32      
33      /** Returns the number of log intries that are about to be exported
34       * 
35       * @return positive integer or 0
36       */
37      public int getNoOfEntries();
38  
39      /** Gets a CA used to create a signed CMS message of the log export, can be null for plain export
40       * 
41       * @return signCA CA (caid in string format, 12345) used to create a signed CMS message of the log export, or null for plain export
42       */
43      public String   getSigningCA();
44      
45      /** Returns the exported data, determined by the exporting class. Can be binary or text data.
46       * 
47       * @return byte data or null if no of exported entries are 0.
48       */
49      public byte[] export();
50  
51  }
52  
53
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags