org.jmrtd.lds.AbstractLDSFile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmrtd Show documentation
Java Machine Readable Travel Documents API.
There is a newer version: 0.7.42
/*
 * JMRTD - A Java API for accessing machine readable travel documents.
 *
 * Copyright (C) 2006 - 2017  The JMRTD team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * $Id: AbstractLDSFile.java 1701 2017-09-04 18:17:07Z martijno $
 */

package org.jmrtd.lds;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Base class for all files (EF_COM, EF_SOD, and data groups) in the LDS.
 *
 * @author The JMRTD team ([email protected])
 *
 * @version $Revision: 1701 $
 */
abstract class AbstractLDSFile implements LDSFile {

  private static final Logger LOGGER = Logger.getLogger("org.jmrtd");

  private static final long serialVersionUID = -4908935713109830409L;

  /**
   * Constructor only visible to the other
   * classes in this package.
   */
  AbstractLDSFile() {
  }

  /**
   * Gets the contents of this file as byte array,
   * includes the ICAO tag and length.
   *
   * @return a byte array containing the file
   */
  public byte[] getEncoded() {
    try {
      ByteArrayOutputStream out = new ByteArrayOutputStream();
      writeObject(out);
      out.flush();
      out.close();
      return out.toByteArray();
    } catch (IOException ioe) {
      LOGGER.log(Level.WARNING, "Exception", ioe);
      return null;
    }
  }

  /**
   * Reads the file from an input stream.
   *
   * @param inputStream the input stream to read from
   *
   * @throws IOException if reading fails
   */
  protected abstract void readObject(InputStream inputStream) throws IOException;

  /**
   * Writes the file to an output stream.
   *
   * @param outputStream the output stream to write to
   *
   * @throws IOException if writing fails
   */
  protected abstract void writeObject(OutputStream outputStream) throws IOException;
}