/**
 * <copyright> Copyright (c) 2006 by Know-Center, Graz, Austria </copyright>
 * 
 * This software is the confidential and proprietary information of Know-Center,
 * Graz, Austria. You shall not disclose such Confidential Information and shall
 * use it only in accordance with the terms of the license agreement you entered
 * into with Know-Center.
 * 
 * KNOW-CENTER MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF
 * THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
 * NON-INFRINGEMENT. KNOW-CENTER SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY
 * LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
 * DERIVATIVES.
 * 
 * $Id: Signator.java,v 1.1 2006/08/25 17:07:21 wprinz Exp $
 */
package at.gv.egiz.pdfas.framework.signator;

import at.gv.egiz.pdfas.exceptions.framework.SignatorException;
import at.gv.egiz.pdfas.framework.input.PdfDataSource;
import at.gv.egiz.pdfas.framework.output.DataSink;
import at.knowcenter.wag.egov.egiz.PdfASID;
import at.knowcenter.wag.egov.egiz.framework.SignResult;
import at.knowcenter.wag.egov.egiz.pdf.TablePos;

/**
 * The basic interface for signator algorithms.
 * 
 * @author wprinz
 */
public interface Signator
{
  /**
   * Returns the PdfASID of this Connector.
   * 
   * <p>
   * This should always return the MY_ID static field of the connector. Dont't
   * forget to override this.
   * </p>
   * <p>
   * Within connector code always use this method so that code reuse through
   * derivation can take place correctly.
   * </p>
   * 
   * @return Returns the PdfASID of this Connector.
   */
  public PdfASID getMyId();


  public SignatorInformation prepareSign(PdfDataSource pdfDataSource,
      String profile, TablePos pos, boolean has_SIG_ID) throws SignatorException;


  public void finishSign(SignatorInformation signatorInformation, DataSink dataSink) throws SignatorException;
}