net.sf.jasperreports.export.pdf.classic.PatchedPdfLibraryUnavailableException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Free Java Reporting Library
The newest version!
/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2023 Cloud Software Group, Inc. All rights reserved.
 * http://www.jaspersoft.com
 *
 * Unless you have purchased a commercial license agreement from Jaspersoft,
 * the following license terms apply:
 *
 * This program is part of JasperReports.
 *
 * JasperReports 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 3 of the License, or
 * (at your option) any later version.
 *
 * JasperReports 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 JasperReports. If not, see .
 */
package net.sf.jasperreports.export.pdf.classic;

import net.sf.jasperreports.engine.JRConstants;
import net.sf.jasperreports.engine.JRRuntimeException;

//TODO delete?

/**
 * No longer used, OpenPDF 1.3.32 supports disabling glyph substitution.
 * 
 * 
 * Exception raised when Apache FOP based glyph substitution is disabled, but
 * the patched version OpenPDF library has not been detected.
 * 
 * 
 * 
 * The OpenPDF library (used by the JasperReports PDF exporter) performs glyph 
 * substitution when Apache FOP is available on the classpath.
 * Glyph substitution is required for complex scripts, but for simple scripts
 * such as Latin can have undesired consequences, for instance copying and 
 * searching text might not work properly.
 * 
 * 
 * 
 * JasperReports uses as default dependency a patched version of OpenPDF that
 * makes FOP based glyph substitution optional.
 * The patched version of OpenPDF (1.3.30.jaspersoft.x) is available in a
 * Maven repository located at
 * https://jaspersoft.jfrog.io/jaspersoft/third-party-ce-artifacts/com/github/librepdf/openpdf/
 * 
 * 
 * 
 * Glyph substitution is configured via the {@link ClassicPdfProducer#PROPERTY_FOP_GLYPH_SUBSTITUTION_ENABLED net.sf.jasperreports.export.pdf.classic.fop.glyph.substitution.enabled}
 * property, set to false by default.
 * 
 * 
 * 
 * With the property set to fase and Apache FOP is present on the classpath, 
 * the patched OpenPDF is required in order to disable glyph substitution.
 * If the patched OpenPDF is not detected, this exception will be raised.
 * 
 * 
 * 
 * To avoid the exception being raised, one can either use the patched OpenPDF 
 * version or explicitly set the {@link ClassicPdfProducer#PROPERTY_FOP_GLYPH_SUBSTITUTION_ENABLED net.sf.jasperreports.export.pdf.classic.fop.glyph.substitution.enabled}
 * to true.
 * If choosing the latter option, the {@link ClassicPdfProducer#PROPERTY_DOCUMENT_LANGUAGE net.sf.jasperreports.export.pdf.classic.document.language}
 * property can be set to specify the language used for glyph substitutions.
 * 
 * 
 * 
 * Note that JasperReports features an alternative solution for complex languages 
 * based on Java AWT.
 * 
 * 
 * @author Lucian Chirita ([email protected])
 */
public class PatchedPdfLibraryUnavailableException extends JRRuntimeException
{

	private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
	
	private static final String EXCEPTION_MESSAGE = "export.pdf.patched.library.unavailable";

	public PatchedPdfLibraryUnavailableException()
	{
		super(EXCEPTION_MESSAGE, new Object[0]);
	}

}