/**
 * <copyright> Copyright 2006 by Know-Center, Graz, Austria </copyright>
 * PDF-AS has been contracted by the E-Government Innovation Center EGIZ, a
 * joint initiative of the Federal Chancellery Austria and Graz University of
 * Technology.
 *
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * http://www.osor.eu/eupl/
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text
 * file for details on the various modules and licenses.
 * The "NOTICE" text file is part of the distribution. Any derivative works
 * that you distribute must include a readable copy of the "NOTICE" text file.
 */
package at.knowcenter.wag.egov.egiz.sig.connectors;

import java.util.Properties;

import at.gv.egiz.pdfas.api.xmldsig.XMLDsigData;
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
{
//23.11.2010 changed by exthex - added XMLDsigData parameter to prepareVerifyRequest to allow reuse
  
  /**
   * 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.
   * @param dsigData
   *          The previously recreated xmldsig block of the signature
   * @return Returns the verify request xml to be sent.
   * @throws ConnectorException
   *           f.e.
   */
  public String prepareVerifyRequest(SignatureData data, SignSignatureObject so, XMLDsigData dsigData) 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;

}