/**
 * <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.gv.egiz.pdfas.framework;

import java.util.Date;

/**
 * Parameters passed to the constructor of the Connector.
 * 
 * <p>
 * Each Connector must have a constructor accepting this parameter class as an
 * argument.
 * </p>
 * 
 * @author wprinz
 */
public class ConnectorParameters {
   /**
    * The profile Id to get the connector parameters from.
    * 
    * <p>
    * The there are no explicit parameters for the connector in the profile, the
    * default parameters are used.
    * </p>
    */
   protected String profileId = null;

   /**
    * The signature key identifier to be used or null if it should be read from
    * the profile.
    * 
    * <p>
    * Currently this is only used by MOA connectors and identifies the MOA key
    * group to be used when signing. If null, the MOA connector reads the key
    * from the profile.
    * </p>
    */
   protected String signatureKeyIdentifier = null;

   /**
    * Tells, if the connector should ask the device to return the hash input
    * data.
    * 
    * <p>
    * Note that not all connectors support to return the hash input data - so
    * there is no guarantee that the hash value will actually be returned.
    * </p>
    */
   protected boolean returnHashInputData = false;

   /**
    * Allows to specify an explicit time of verification.
    * 
    * <p>
    * If null, the device's default behaviour determines the time of
    * verification, which is usually the current time.
    * </p>
    * <p>
    * The time of verification usually influences the certificate check. E.g.
    * the certificate may not be valid at the time of verification.
    * </p>
    */
   protected Date verificationTime = null;

   public String getProfileId() {
      return this.profileId;
   }

   public void setProfileId(String profileId) {
      this.profileId = profileId;
   }

   public String getSignatureKeyIdentifier() {
      return this.signatureKeyIdentifier;
   }

   public void setSignatureKeyIdentifier(String signatureKeyIdentifier) {
      this.signatureKeyIdentifier = signatureKeyIdentifier;
   }

   public boolean isReturnHashInputData() {
      return this.returnHashInputData;
   }

   public void setReturnHashInputData(boolean returnHashInputData) {
      this.returnHashInputData = returnHashInputData;
   }

   public Date getVerificationTime() {
      return this.verificationTime;
   }

   public void setVerificationTime(Date verificationTime) {
      this.verificationTime = verificationTime;
   }

}