/**
 * 
 */
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;

  /**
   * 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 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;
  }

}