/**
 * <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.web.session;

import java.io.Serializable;

import javax.servlet.http.HttpSessionBindingEvent;
import javax.servlet.http.HttpSessionBindingListener;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import at.gv.egiz.pdfas.api.internal.LocalBKUParams;
import at.gv.egiz.pdfas.api.io.DataSink;
import at.gv.egiz.pdfas.api.io.DataSource;
import at.gv.egiz.pdfas.api.sign.SignParameters;
import at.gv.egiz.pdfas.api.sign.SignResult;
import at.gv.egiz.pdfas.api.sign.SignatureDetailInformation;
import at.gv.egiz.pdfas.api.sign.pos.SignaturePositioning;
import at.gv.egiz.pdfas.web.ExternAppInformation;
import at.gv.egiz.pdfas.web.LocalRequest;

/**
 * @author wprinz
 *
 */
public class SignSessionInformation implements HttpSessionBindingListener, Serializable
{
  /**
   * SVUID.
   */
  private static final long serialVersionUID = 2739944460007369626L;

  /**
   * The log.
   */
  private static Log log = LogFactory.getLog(SignSessionInformation.class);

  /**
   * The connector.
   */
  public String connector = null;

  /**
   * For local requests, tells the application (sign, verify).
   */
  public String application = null;

  /**
   * Tells the operation mode (binary, textual).
   */
  public String mode = null;

  /**
   * The original, uploaded pdf.
   */
  public DataSource pdfDataSource = null;

  /**
   * The type/profile of the signature.
   */
  public String type = null;

  /**
   * The suggested filename.
   */
  public String filename;

  /**
   * Tells, if the file download should be done inline or as attachment.
   */
  public boolean download_inline;

  /**
   * Object containing information about the calling webapplication.
   *
   * @author: Thomas Zefferer
   */
  public ExternAppInformation exappinf;

  /**
   * Information about the signature position
   *
   * @author exthex
   */
  public SignaturePositioning pos;

  /**
   * <code>true</code> if pdf/a is enabled
   *
   * @author tknall
   */
  public boolean pdfa;

  /**
   * <code>true</code> if note is enabled
   *
   * @author rpiazzi
   */
  public boolean note;

  /**
   * The SignatureDetailInformation.
   */
  public SignatureDetailInformation sdi = null;

  /**
   * The DataSink to write the output data to.
   */
  public DataSink output = null;

  /**
   * The local request to be sent to the device.
   */
  public LocalRequest localRequest = null;

  /**
   * Tells if the sign request has been processed and the signed document is
   * available in the DataSink.
   */
  public boolean outputAvailable = false;

  /**
   * The SignParameters
   */
  public SignParameters signParameters;

  /**
   * The Result of the sign process
   */
  public SignResult signResult;

  /**
   * The signed pdf data.
   */
  public byte[] signedPdf;

  /**
   * The xml response of the local BKU/Mocca
   */
  public String xmlResponse;

  /**
   * Local BKU/Mocca parameters used to identify the BKU
   */
  public LocalBKUParams localBKUParams;

  /**
   * Start time of session (afitzek)
   */
  public long startTime;

  /**
   * @see javax.servlet.http.HttpSessionBindingListener#valueBound(javax.servlet.http.HttpSessionBindingEvent)
   */
  public void valueBound(HttpSessionBindingEvent event)
  {
     log.debug("Bound SignSessionInformation to session (ID=" + event.getSession().getId() + ").");
  }

  /**
   * @see javax.servlet.http.HttpSessionBindingListener#valueUnbound(javax.servlet.http.HttpSessionBindingEvent)
   */
  public void valueUnbound(HttpSessionBindingEvent event)
  {
    log.debug("Unbound SignSessionInformation from session (ID=" + event.getSession().getId() + ").");

  }
  
  public String plainPDFDigest;
}