/**
 * 
 */
package at.gv.egiz.pdfas.api.sign;

import java.security.cert.X509Certificate;
import java.util.Date;
import java.util.List;
import java.util.Map;

import at.gv.egiz.pdfas.api.analyze.NonTextObjectInfo;
import at.gv.egiz.pdfas.api.io.DataSource;
import at.gv.egiz.pdfas.api.sign.pos.SignaturePosition;

/**
 * A container for all relevant signature related data.
 * 
 * @author exthex
 */
public interface SignatureDetailInformation
{
  public DataSource getSignatureData();

  /**
   * Returns the position where the signature table was actually placed.
   * 
   * @return Returns the position where the signature table was actually placed.
   */
  public SignaturePosition getSignaturePosition();
  
  /**
   * Returns a list<{@link NonTextObjectInfo} of non textual objects in the pdf document.
   * Only available for textual signatures. Show this to the user who signed the textual content only! 
   * @return  List<{@link NonTextObjectInfo} or <tt>null</tt> of not available (binary signature)
   */
  public List getNonTextualObjects();
  
  /**
   * Returns the date of signature extracted from the signature.
   * @return
   */
  public Date getSignDate();
  
  /**
   * Get the name of the issuer. 
   * Short for {@link SignatureDetailInformation#getX509Certificate()#getIssuer()#getName()}
   * 
   * @return
   */
  public String getIssuer();

  /**
   * Short for {@link SignatureDetailInformation#getX509Certificate()#getIssuerDNMap()}
   * 
   * @return
   */
  public Map getIssuerDNMap();
  
  /**
   * Short for {@link SignatureDetailInformation#getX509Certificate()#getSubjectName()#toString()}
   * 
   * @return
   */
  public String getSubjectName();
  
  /**
   * Short for {@link SignatureDetailInformation#getX509Certificate()#getSerialNumber()#toString()}
   * 
   * @return
   */
  public String getSerialNumber();
  
  /**
   * Get the algorithm the signature was created with.
   * @return
   */
  public String getSigAlgorithm();
  
  /**
   * 
   * @return the signature id.
   */
  public String getSigID();
  
  /**
   * 
   * @return the signature method.
   */
  public String getSigKZ();
  
  /**
   * 
   * @return the signature value.
   */
  public String getSignatureValue();
  
  /**
   * 
   * @return the signature time stamp.
   */
  public String getSigTimeStamp();
  
  /**
   * Short for {@link SignatureDetailInformation#getX509Certificate()#getSubjectDNMap()}
   * 
   * @return
   */
  public Map getSubjectDNMap();

  /**
   * 
   * @return the certificate used for signature.
   */
  public X509Certificate getX509Certificate();
  
  /**
   * 
   * @return true if the signature is textual, false otherwise.
   */
  public boolean isTextual();
  
  /**
   * 
   * @return true if this signature is binary, false otherwise.
   */
  public boolean isBinary();
}