org.apache.poi.hssf.usermodel.HSSFWorkbookFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi Show documentation
Apache POI - Java API To Access Microsoft Format Files
There is a newer version: 5.2.5
/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */

package org.apache.poi.hssf.usermodel;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;

import org.apache.poi.hssf.record.crypto.Biff8EncryptionKey;
import org.apache.poi.poifs.filesystem.DirectoryNode;
import org.apache.poi.poifs.filesystem.FileMagic;
import org.apache.poi.poifs.filesystem.POIFSFileSystem;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.usermodel.WorkbookFactory;
import org.apache.poi.ss.usermodel.WorkbookProvider;
import org.apache.poi.util.Internal;

/**
 * Helper class which is instantiated by reflection from
 * {@link WorkbookFactory#create(java.io.File)} and similar
 */
@SuppressWarnings("unused")
@Internal
public class HSSFWorkbookFactory implements WorkbookProvider {

    @Override
    public boolean accepts(FileMagic fm) {
        return FileMagic.OLE2 == fm;
    }

    /**
     * Create a new empty Workbook
     *
     * @return The created workbook
     */
    public HSSFWorkbook create() {
        return new HSSFWorkbook();
    }

    /**
     * Creates a HSSFWorkbook from the given {@link POIFSFileSystem}
     * Note that in order to properly release resources the
     * Workbook should be closed after use.
     */
    public static HSSFWorkbook createWorkbook(final POIFSFileSystem fs) throws IOException {
        return new HSSFWorkbook(fs);
    }

    /**
     * Creates a HSSFWorkbook from the given DirectoryNode
     * Note that in order to properly release resources the
     * Workbook should be closed after use.
     */
    public HSSFWorkbook create(final DirectoryNode root, String password) throws IOException {
        boolean passwordSet = false;
        if (password != null) {
            Biff8EncryptionKey.setCurrentUserPassword(password);
            passwordSet = true;
        }
        try {
            return new HSSFWorkbook(root, true);
        } finally {
            if (passwordSet) {
                Biff8EncryptionKey.setCurrentUserPassword(null);
            }
        }
    }

    @Override
    public Workbook create(InputStream inp) throws IOException {
        return create(inp, null);
    }

    @Override
    public Workbook create(InputStream inp, String password) throws IOException {
        POIFSFileSystem fs = new POIFSFileSystem(inp);
        return create(fs.getRoot(), password);
    }

    @Override
    public Workbook create(File file, String password, boolean readOnly) throws IOException {
        boolean passwordSet = false;
        if (password != null) {
            Biff8EncryptionKey.setCurrentUserPassword(password);
            passwordSet = true;
        }
        try {
            POIFSFileSystem fs = new POIFSFileSystem(file, readOnly);
            try {
                return new HSSFWorkbook(fs, true);
            } catch (RuntimeException e) {
                // we need to close the filesystem
                // if we encounter an exception to
                // not leak file handles
                fs.close();

                throw e;
            }
        } finally {
            if (passwordSet) {
                Biff8EncryptionKey.setCurrentUserPassword(null);
            }
        }
    }
}