Initial import of release 2.2.REL-2.2@923

git-svn-id: https://joinup.ec.europa.eu/svn/pdf-as/trunk@4 7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c

1 files changed, 117 insertions, 0 deletions

diff --git a/src/main/java/at/knowcenter/wag/egov/egiz/sig/LocalConnector.java b/src/main/java/at/knowcenter/wag/egov/egiz/sig/LocalConnector.java
new file mode 100644
index 0000000..13e0b65
--- /dev/null
+++ b/src/main/java/at/knowcenter/wag/egov/egiz/sig/LocalConnector.java
@@ -0,0 +1,117 @@
+/**

+ * <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: LocalConnector.java,v 1.2 2006/08/25 17:09:41 wprinz Exp $

+ */

+package at.knowcenter.wag.egov.egiz.sig;

+

+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>

+ * 

+ * @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 response_string

+   *          The response string from the local service.

+   * @param signature_type

+   *          The type of the signature.

+   * @return Returns the SignatureObject of the sign request.

+   * @throws SignatureException

+   *           F.e.

+   */

+  public SignatureObject analyzeSignResponse(String response_string,

+      String signature_type) throws SignatureException;

+

+  /**

+   * Analyzes the verify response string.

+   * 

+   * @param response_string

+   *          The response string from the local service.

+   * @return Returns the SignatureResponse of the verify request.

+   * @throws SignatureException

+   *           F.e.

+   */

+  public SignatureResponse analyzeVerifyResponse(String response_string) 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);

+

+}