public final class plop extends java.lang.Object implements IpCOS
Constructor and Description |
---|
plop()
Create a new PLOP context.
|
Modifier and Type | Method and Description |
---|---|
int |
add_recipient(java.lang.String optlist)
Add recipient for encryption with certificate security.
|
void |
close_document(int doc,
java.lang.String optlist)
Close the input and output documents.
|
java.lang.String |
convert_to_unicode(java.lang.String inputformat,
byte[] inputstring,
java.lang.String optlist)
Convert an arbitrary encoded string to a Unicode string in several formats.
|
int |
create_document(java.lang.String filename,
java.lang.String optlist)
Create a PDF output document (which may be protected) in memory or on disk file.
|
void |
create_pvf(java.lang.String filename,
byte[] data,
java.lang.String optlist)
Create a named virtual read-only file from data provided in memory.
|
int |
delete_pvf(java.lang.String filename)
Delete a named virtual file and free its data structures (but not the contents).
|
void |
delete()
Delete a PLOP context and release all its internal resources.
|
java.lang.String |
get_apiname()
Get the name of the API function which threw the last exception or failed.
|
byte[] |
get_buffer()
Fetch full or partial buffer contents of the output document from memory.
|
java.lang.String |
get_errmsg()
Get the descriptive text of the last thrown exception, or the reason of a failed function call.
|
int |
get_errnum()
Get the number of the last thrown exception, or the reason of a failed function call.
|
double |
info_pvf(java.lang.String filename,
java.lang.String keyword)
Query properties of a virtual file or the PDFlib Virtual File system (PVF).
|
int |
open_document(java.lang.String filename,
java.lang.String optlist)
Open a PDF document (which may be protected) for processing.
|
void |
pcos_close_document(int doc,
java.lang.String optlist)
Close PLOP input document via the IpCOS interface.
|
double |
pcos_get_number(int doc,
java.lang.String path)
Get the value of a pCOS path with type number or boolean.
|
byte[] |
pcos_get_stream(int doc,
java.lang.String optlist,
java.lang.String path)
Get the value of a pCOS path with type name, number, string, or boolean.
|
java.lang.String |
pcos_get_string(int doc,
java.lang.String path)
Get the value of a pCOS path with type name, string, or boolean.
|
int |
pcos_open_document(java.lang.String filename,
java.lang.String optlist)
Open a disk-based or virtual PDF document via the IpCOS interface.
|
int |
prepare_signature(java.lang.String optlist)
Prepare signature options.
|
void |
set_option(java.lang.String optlist)
Set one or more global options for PLOP.
|
public plop() throws PLOPException
PLOPException
- May throw an exception in case
of memory shortage.public final int add_recipient(java.lang.String optlist) throws PLOPException
PLOPException
- PLOP output cannot be finished after an exception.public final void close_document(int doc, java.lang.String optlist) throws PLOPException
PLOPException
- PLOP output cannot be finished after an exception.public final java.lang.String convert_to_unicode(java.lang.String inputformat, byte[] inputstring, java.lang.String optlist) throws PLOPException
convert_to_unicode
in interface IpCOS
inputformat
- Unicode text format or encoding name specifying
interpretation of the input stringinputstring
- String to be converted to Unicodeoptlist
- An option list specifying options for input
interpretation and Unicode conversionPLOPException
- PLOP output cannot be finished after an exception.public final int create_document(java.lang.String filename, java.lang.String optlist) throws PLOPException
PLOPException
- PLOP output cannot be finished after an exception.public final void create_pvf(java.lang.String filename, byte[] data, java.lang.String optlist) throws PLOPException
create_pvf
in interface IpCOS
filename
- The name of the virtual filedata
- Data for the virtual fileoptlist
- An option listPLOPException
- PLOP output cannot be finished after an exception.public final int delete_pvf(java.lang.String filename) throws PLOPException
delete_pvf
in interface IpCOS
filename
- The name of the virtual file.PLOPException
- PLOP output cannot be finished after an exception.public final java.lang.String get_apiname()
get_apiname
in interface IpCOS
public final byte[] get_buffer() throws PLOPException
PLOPException
- PLOP output cannot be finished after an exception.public final java.lang.String get_errmsg()
get_errmsg
in interface IpCOS
public final int get_errnum()
get_errnum
in interface IpCOS
public final double info_pvf(java.lang.String filename, java.lang.String keyword) throws PLOPException
info_pvf
in interface IpCOS
filename
- The name of the virtual file. The filename may be empty
if keyword=filecount.keyword
- A keyword for the requested informationPLOPException
- PLOP output cannot be finished after an exception.public final int open_document(java.lang.String filename, java.lang.String optlist) throws PLOPException
PLOPException
- PLOP output cannot be finished after an exception.public final double pcos_get_number(int doc, java.lang.String path) throws PLOPException
pcos_get_number
in interface IpCOS
doc
- A valid document handle obtained with pcos_open_document()path
- A full pCOS path for a numerical or boolean objectPLOPException
- PLOP output cannot be finished after an exception.public final byte[] pcos_get_stream(int doc, java.lang.String optlist, java.lang.String path) throws PLOPException
pcos_get_stream
in interface IpCOS
doc
- A valid document handle obtained with pcos_open_document()optlist
- An option list specifying stream retrieval optionspath
- A full pCOS path for a stream or string objectPLOPException
- PLOP output cannot be finished after an exception.public final java.lang.String pcos_get_string(int doc, java.lang.String path) throws PLOPException
pcos_get_string
in interface IpCOS
doc
- A valid document handle obtained with pcos_open_document()path
- A full pCOS path for a string, number, name, or boolean objectPLOPException
- PLOP output cannot be finished after an exception.public final int prepare_signature(java.lang.String optlist) throws PLOPException
PLOPException
- PLOP output cannot be finished after an exception.public final void set_option(java.lang.String optlist) throws PLOPException
set_option
in interface IpCOS
optlist
- An option list specifying global optionsPLOPException
- PLOP output cannot be finished after an exception.public final void delete()
public int pcos_open_document(java.lang.String filename, java.lang.String optlist) throws java.lang.Exception
pcos_open_document
in interface IpCOS
filename
- The full path name of the PDF file to be opened.
The file will be searched by means of the SearchPath resource.optlist
- An option list specifying document options.java.lang.Exception
- see manualpublic void pcos_close_document(int doc, java.lang.String optlist) throws java.lang.Exception
pcos_close_document
in interface IpCOS
doc
- A valid document handle obtained with open_document().optlist
- An option list specifying document options.java.lang.Exception
- see manual