/**
 * <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.
 *
 * $Id: LocalConnector.java,v 1.2 2006/08/25 17:09:41 wprinz Exp $
 */
package at.knowcenter.wag.egov.egiz.sig;

import java.util.Properties;

import at.knowcenter.wag.egov.egiz.exceptions.SignatureException;

/**
 * A local connector is a refinement of a "normal" Connector that allows to
 * explicitely do the request on a local client.
 * 
 * <p>
 * Basically the sign and verify procedures of this connector are split into
 * three groups:
 * </p>
 * <ol>
 * <li>Prepare the request to the local service.</li>
 * <li>Carry out the request on the local client.</li>
 * <li>Analyze the response from the local client.</li>
 * </ol>
 * <p>
 * Usually the preparation and the analyzation are carried out on the server,
 * whereas the connection to the local service is made from the local client.
 * </p>
 * 
 * @deprecated use the new connectory instead
 * 
 * @author wprinz
 */
public interface LocalConnector extends Connector
{
  /**
   * Prepares the sign request string.
   * 
   * @param user_name
   *          The user name.
   * @param sign_text
   *          The text to be signed.
   * @param signature_type
   *          The type of the signature.
   * @return Returns the request string to be sent to the local service.
   * @throws SignatureException
   *           F.e.
   */
  public String prepareSignRequest(String user_name, String sign_text,
      String signature_type) throws SignatureException;

  /**
   * Prepares the verify request string.
   * 
   * @param signed_text
   *          The signed text to be verified.
   * @param signature_object
   *          The SignatureObject.
   * @return Returns the request string.
   * @throws SignatureException
   *           F.e.
   */
  public String prepareVerifyRequest(String signed_text,
      SignatureObject signature_object) throws SignatureException;

  /**
   * Analyzes the sign response string.
   * 
   * @param signature_type
   *          The type of the signature.
   * @return Returns the SignatureObject of the sign request.
   * @throws SignatureException
   *           F.e.
   */
  // TODO hotfix - already deprecated
  public SignatureObject analyzeSignResponse(Properties response_properties,
      String signature_type) throws SignatureException;

  /**
   * Analyzes the verify response string.
   * 
   * @return Returns the SignatureResponse of the verify request.
   * @throws SignatureException
   *           F.e.
   */
  // TODO hotfix - already deprecated
  public SignatureResponse analyzeVerifyResponse(Properties response_properties) throws SignatureException;

  /**
   * Returns the sign URL of the local service.
   * 
   * @param profile
   *          The signature type the URL should be retrieved from.
   * @return Returns the sign URL of the local service.
   */
  public String getSignURL(String profile);

  /**
   * Returns the verify URL of the local service.
   * 
   * @param profile
   *          The signature type the URL should be retrieved from.
   * @return Returns the verify URL of the local service.
   */
  public String getVerifyURL(String profile);

}