/**
 * 
 */
package at.knowcenter.wag.egov.egiz.sig.connectors;

import java.util.Properties;

import at.knowcenter.wag.egov.egiz.exceptions.ConnectorException;
import at.knowcenter.wag.egov.egiz.sig.SignatureData;
import at.knowcenter.wag.egov.egiz.sig.SignatureResponse;
import at.knowcenter.wag.egov.egiz.sig.connectors.bku.SignSignatureObject;

/**
 * @author wprinz
 */
public interface LocalConnector
{
  /**
   * Prepares the sign request xml to be sent using the sign request template.
   * 
   * @param data
   *          The SignatureData.
   * @return Returns the sign request xml to be sent.
   * @throws ConnectorException
   *           f.e.
   */
  public String prepareSignRequest(SignatureData data) throws ConnectorException;

  /**
   * Analyzes the sign response xml and extracts the signature data.
   * 
   * @param response_properties
   *          The response properties containing the response String and
   *          transport related information.
   * @return Returns the extracted data encapsulated in a SignatureObject.
   * @throws ConnectorException
   *           f.e.
   */
  public SignSignatureObject analyzeSignResponse(Properties response_properties) throws ConnectorException;

  /**
   * Prepares the verify request xml to be sent using the verify request
   * template.
   * 
   * @param data
   *          The SignatureData.
   * @param so
   *          The signature information object.
   * @return Returns the verify request xml to be sent.
   * @throws ConnectorException
   *           f.e.
   */
  public String prepareVerifyRequest(SignatureData data, SignSignatureObject so) throws ConnectorException;

  /**
   * Analyzes the verify response string.
   * 
   * @param response_properties
   *          The response properties containing the response XML.
   * @return Returns the SignatureResponse containing the verification result.
   * @throws ConnectorException
   *           f.e.
   */
  public SignatureResponse analyzeVerifyResponse(Properties response_properties) throws ConnectorException;

}