Setting Up PDFTextStream
PDFTextStream requires one of:
- Version 1.5 or higher Java Runtime Environment
- Version 2.0 or higher of the .NET or Mono CLR
PDFTextStream’s core functionality does not require any external libraries.
If PDFTextStream’s Lucene integration features are used, the libraries required by Lucene 1.2 or higher are required.
PDFTextStream includes a variant of the Apache commons-logging library,
which enables it to dynamically recognize which logging framework you are
using in your application (one of log4j,
none — in which case, log data will be directed to
you are using a different (possibly custom, in-house?) logging library, you
can readily integrate PDFTextStream into it. See Logging
for more information on PDFTextStream's logging configuration options.
Classpath (Java only)
An application's classpath must be changed in order for PDFTextStream's classes to be available from the application's code. For example, if an application's current classpath is:
and the PDFTextStream jar is in the lib directory, then you should modify the application's classpath to be:
These classpath examples are suitable for a Unix/Linux/BSD system. The
appropriate classpath for a Windows system would be the same as above,
except using semicolons (
;) instead of colons, and using
\) instead of forward slashes.
If you have purchased PDFTextStream, you should have received a license file
pdftextstream.license. Deploying this file along with
PDFTextSTream will remove all evaluation limitations:
- Approximately half of all digits (0-9) in text extracts will be randomized.
- Approximately one in ten vowels (aeiou) in text extracts will be randomized.
titlefield of half of all
com.snowtide.pdf.Bookmarkobjects will be slightly modified.
contentsfield of half of all
com.snowtide.pdf.annot.Annotationobjects will be slightly modified
richContentfield of half of all
com.snowtide.pdf.annot.FreeTextAnnotationobjects will be slightly modified
urifield of half of all
com.snowtide.pdf.annot.LinkAnnotationobjects will be slightly modified
- The values held by half of all form field objects (those objects
whose classes implement the
com.snowtide.pdf.forms.FormFieldinterface) will be slightly modified.
Please note that PDFTextStream may not be redistributed under any circumstance, except with an OEM license.
Deploying a PDFTextStream license file can be accomplished in any of four ways:
- Simply place the
pdftextstream.licensefile in your application’s current directory, and PDFTextStream will load it automatically.
- Set the
pdfts_license_pathenvironment variable to the full path where the
pdftextstream.licensefile may be found. For example, if you copy the
pdftextstream.licensefile to the
C:\WINDOWSdirectory, this can from the command line by issuing this command:
- Set the
pdfts_license_pathsystem property to the full path where the
pdftextstream.licensefile may be found. In Java, this can be done either by setting the system property before using PDFTextStream by calling the
java.lang.System.setProperty(String, String)method, or by specifying the full path of the license file’s location using a
–Dargument to the JVM, such as
–Dpdfts_license_path=~/pdftextstream.license. PDFTextStream.NET users can set this system property in an application’s
App.configfile, like so:
<appSettings> <add key="ikvm:pdfts_license_path" value="C:\WINDOWS\pdftextstream.license"/> </appSettings>
- The location of the license file may also be specified at runtime,
rather than at application startup or through configuration. This may be
done by calling the
com.snowtide.pdf.PDFTextStream.loadLicense(String)method. That method may be called at any time to load and verify a license file at the specified path.
- Place the
pdftextstream.licensefile at a root of the JRE’s classpath. For example, if an application's classpath is defined as shown in the second example in the 'Classpath' section above, then the license file should be placed either in
ext/resources/. PDFTextStream.NET users can specify the classpath in their application’s
App.configfile, like so:
<appSettings> <add key="ikvm:java.class.path" value="c:\resources\"/> </appSettings>
PDFTextStream offers a number of configuration options, all of which are
available in the
Please see that class’ API documentation for details of the available configuration