com.ibm.ecm.extension

Class PluginDocumentContent

java.lang.Object

com.ibm.ecm.extension.PluginDocumentContent

public abstract class PluginDocumentContent
extends java.lang.Object

Instances of PluginDocumentContent are returned by some of the PluginServicesCallbacks.retrieveDocumentContent to provide access to document content.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name
protected java.util.List<java.lang.String>	partContentType
protected java.lang.Long	size
protected java.lang.String	type

Constructor Summary

Constructors

Constructor and Description
PluginDocumentContent()

Method Summary

Modifier and Type	Method and Description
void	changePDFToTIFF() This changes the MIME type and file extension from PDF to TIFF.
void	close() Clean up any resources, such as temporary files, used by this object.
int	getContentPartCount() CM - returns the number of parts in the document.
java.lang.Long	getContentSize() Returns the content size, if known.
java.lang.String	getContentType() Returns the mimetype of the document(/part;/element)
java.lang.String	getContentUrl() P8 - returns the url for external document/elements, otherwise returns null.
java.lang.String	getETag() Get a unique hash for this content, suitable to use as an ETag header, for this content.
java.lang.String	getFileName() Get the file name for the document(/part;/element)
abstract java.io.InputStream	getInputStream() Returns the InputStream of the document(/part;/element) content stream.
int	getNumPagesInLastSegment() OD - returns the number of pages in the last segment.
int	getNumPagesInSegment() OD - returns the number of pages per segment.
int	getNumSegments() OD - returns the number of segments in the document.
java.lang.String	getPartContentType(int partNum) CM - Returns the mimetype of the part, for multi-part documents.
java.lang.String	getTextEncoding() CM - returns the encoding for text/plain documents For other repositories, returns null.
boolean	isViaUrl() P8 - returns true for external document/elements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

protected java.lang.String type

size

protected java.lang.Long size

name

protected java.lang.String name

partContentType

protected java.util.List<java.lang.String> partContentType

Constructor Detail

PluginDocumentContent

public PluginDocumentContent()

Method Detail

getFileName

public java.lang.String getFileName()

Get the file name for the document(/part;/element)

Returns:

getContentType

public java.lang.String getContentType()

Returns the mimetype of the document(/part;/element)

Returns:

changePDFToTIFF

public void changePDFToTIFF()

This changes the MIME type and file extension from PDF to TIFF. It is called when Daeja applies role-based redactions to a PDF file, and the redacted file is returned from Daeja as a TIFF file.

getPartContentType

public java.lang.String getPartContentType(int partNum)

CM - Returns the mimetype of the part, for multi-part documents. P8 - Returns the mimetype of the part for multi-part documents. For other repositories, returns the same value as getContentType, for partNum value of 1, otherwise returns null.

Parameters:

partNum -

Returns:

Since:

2.0.3

getContentSize

public java.lang.Long getContentSize()

Returns the content size, if known. If unknown, returns 0.

Returns:

getInputStream

public abstract java.io.InputStream getInputStream()
                                            throws java.lang.Exception

Returns the InputStream of the document(/part;/element) content stream.

Returns:

Throws:

java.lang.Exception

isViaUrl

public boolean isViaUrl()

P8 - returns true for external document/elements. For other repositories returns false.

Returns:

getContentUrl

public java.lang.String getContentUrl()

P8 - returns the url for external document/elements, otherwise returns null. For other repositories returns false.

Returns:

getContentPartCount

public int getContentPartCount()

CM - returns the number of parts in the document. P8 - returns the number of content elements in the document. For other repositories, returns 1.

Returns:

int

getTextEncoding

public java.lang.String getTextEncoding()

CM - returns the encoding for text/plain documents For other repositories, returns null.

Returns:

getNumSegments

public int getNumSegments()

OD - returns the number of segments in the document. For other repositories, returns -1.

Returns:

getNumPagesInSegment

public int getNumPagesInSegment()

OD - returns the number of pages per segment. For other repositories, returns -1.

Returns:

getNumPagesInLastSegment

public int getNumPagesInLastSegment()

OD - returns the number of pages in the last segment. For other repositories, returns -1.

Returns:

getETag

public java.lang.String getETag()

Get a unique hash for this content, suitable to use as an ETag header, for this content. If not available or implemented, return null.

Returns:

Since:

2.0.3.8

close

public void close()

Clean up any resources, such as temporary files, used by this object.

Since:

2.0.3.8