com.ibm.mm.sdk.common

Class DKLobICM

java.lang.Object

com.ibm.mm.sdk.common.dkAbstractDataObjectBase

com.ibm.mm.sdk.common.dkDataObject

com.ibm.mm.sdk.common.DKDDOBase

com.ibm.mm.sdk.common.DKDDO

com.ibm.mm.sdk.common.dkResource

com.ibm.mm.sdk.common.DKLobICM

All Implemented Interfaces:

dkDataObjectBase, dkXDO, dkXDOBase, java.io.Serializable

public class DKLobICM
extends dkResource

IBM Content Manager (ICM) implementation for Large Object (LOB) content management.

This class extends dkResource to provide comprehensive LOB/content management functionality for FileNet P8. It handles document content operations including upload, download, streaming, and metadata management.

Key Features:

• Content upload from files, streams, or byte arrays
• Content download to files, streams, or byte arrays
• Streaming support with offset and length control
• MIME type and filename management
• Version control and checkout/checkin
• Content size and timestamp tracking
• Automatic document checkout for content modifications

Content Operations:

• Add: add(InputStream), add(String filename), add(byte[])
• Retrieve: retrieve(), getContent(), getContentInputStream()
• Update: update(InputStream), update(String filename), setContent(byte[])
• Delete: del(), del(boolean flush)

Metadata Operations:

• getMimeType() / setMimeType(String)
• getOrgFileName() / setOrgFileName(String)
• getSize() / size() / sizeInDatastore()
• getVersionNumber()
• getCreatedTimestamp() / getUpdatedTimestamp()

Example usage - Upload content:

 // Create LOB from file
 DKDDO document = datastore.createDDO("Document", DKConstant.DK_CM_DOCUMENT);
 DKLobICM lob = new DKLobICM(document.getDocument(), datastore);
 lob.add("/path/to/file.pdf");
 lob.setMimeType("application/pdf");

 // Or from byte array
 byte[] content = "Hello, World!".getBytes();
 lob.setContent(content);
 lob.add();
 

Example usage - Download content:

 // Retrieve LOB
 DKLobICM lob = (DKLobICM) document.getParts().item(0);

 // Download to file
 lob.retrieve("/path/to/output.pdf", null);

 // Or get as byte array
 byte[] content = lob.getContent();

 // Or stream with offset/length
 InputStream stream = lob.getContentInputStream(null, 0, 1024);
 

See Also:

dkResource, DKParts, ContentTransfer, DKDDO, Serialized Form

Field Summary

Fields inherited from class com.ibm.mm.sdk.common.DKDDOBase

datastore, propertyIdMap, propertyNameToIdMap

Fields inherited from class com.ibm.mm.sdk.common.dkAbstractDataObjectBase

contentElementList, document, folder, objectStore, pid, semanticType

Constructor Summary

Constructors

Constructor and Description
DKLobICM(com.filenet.api.core.ContentTransfer contentTransfer, DKDatastoreICM datastore) Constructs a LOB from a FileNet ContentTransfer.
DKLobICM(com.filenet.api.core.Document document, DKDatastoreICM datastore) Constructs a LOB for a FileNet Document.
DKLobICM(com.filenet.api.core.Document document, DKDatastoreICM datastore, java.lang.String semanticType) Constructs a LOB for a FileNet Document with semantic type.

Method Summary

Modifier and Type	Method and Description
void	add() Adds/persists the LOB content to the document.
void	add(java.io.InputStream inputStream, long length) Adds content from an input stream.
void	add(java.io.InputStream inputStream, long length, int bitwiseAddOptions) Adds content from an input stream with options.
void	add(int bitwiseAddOptions)
void	add(java.lang.String fullyQualifiedFileName) Adds content from a file.
void	add(java.lang.String fullyQualifiedFileName, int bitwiseAddOptions)
void	del() Deletes this LOB content.
void	del(boolean flush)
void	del(int option)
byte[]	getContent() Gets the entire content as a byte array.
java.io.InputStream	getContentInputStream(DKNVPair[] options, long offset, long length) Gets an input stream for the content with offset and length control.
void	getContentToClientFile(java.lang.String fileName, int fileOption)
com.filenet.api.core.ContentTransfer	getContentTransfer() Gets the underlying FileNet ContentTransfer object.
java.lang.String	getCreatedTimestamp()
java.io.InputStream	getInputStream(DKNVPair[] optionsDKNVPair, int offset, int length) Deprecated. Use getContentInputStream(DKNVPair[], long, long) instead
java.lang.String	getItemId()
java.lang.String	getMimeType() Gets the MIME type of this content.
boolean	getNewVersion() Gets whether this will create a new version.
java.lang.String	getOrgFileName()
int	getPartNumber()
java.lang.String	getReferencedTimestamp()
java.lang.String	getResourceName()
java.lang.String	getRMName()
long	getSize() Gets the size of the content in bytes.
java.lang.String	getUpdatedTimestamp()
java.lang.String	getVersionNumber() Gets the version number of the document.
boolean	isContentChanged() Checks if the content has been modified.
boolean	isNull()
boolean	isOpenSynchronous()
boolean	isSet() Checks if content has been set.
void	retrieve() Retrieve (refresh) the document or folder from the object store.
void	retrieve(DKNVPair[] optionsDKNVPair) Retrieve (refresh) the document from the object store with options.
java.lang.Object	retrieve(DKNVPair[] optionsDKNVPair, long offset, long length)
void	retrieve(DKNVPair[] optionsDKNVPair, java.lang.String targetLocalFileName, int offset, int length)
void	retrieve(DKThirdPartyServerDef thirdPartyServerDef, DKNVPair[] optionsDKNVPair)
void	retrieve(java.lang.String targetLocalFileName, DKNVPair[] optionsDKNVPair)
void	setContent(byte[] aByteArray) Sets the content from a byte array.
void	setContentFromClientFile(java.lang.String fileName)
void	setMimeType(java.lang.String string) Sets the MIME type for this content.
void	setNewVersion(boolean newVersion)
void	setNull()
void	setOrgFileName(java.lang.String ofile)
int	size()
long	sizeInDatastore()
void	update() Updates the LOB with current changes.
void	update(java.io.InputStream inputStream, long length)
void	update(java.io.InputStream inputStream, long length, int bitwiseUpdateOptions) Updates content from an input stream.
void	update(int bitwiseUpdateOptions) Updates the LOB with options.
void	update(java.lang.String fullyQualifiedFileName)
void	update(java.lang.String fullyQualifiedFileName, int bitwiseUpdateOptions)

Methods inherited from class com.ibm.mm.sdk.common.DKDDO

addElement, del, getDatastore, getDocument, getFolder, removeMember, retrieve, toString, toXML, update

Methods inherited from class com.ibm.mm.sdk.common.DKDDOBase

dataCount, dataId, dataId, dataIdsByNameSpace, dataPropertyCount, dataPropertyId, getData, getDataByName, getDataByName, getDataName, getDataProperty, getDataPropertyByName, getDataPropertyByName, getDataPropertyByName, getDataPropertyName, getObjectType, getProperty, getProperty, getPropertyByName, getPropertyName, isDataPropertySet, isDataSet, isNull, isPropertySet, propertyCount, setData, setProperty, setProperty, setPropertyObject

Methods inherited from class com.ibm.mm.sdk.common.dkDataObject

getId, getPidObject, getProperties, save, setPidObject

Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDataObjectBase

getContentElementList, getNativeObject, getObject, getSemanticType, setContentElementList, setDocument, setObject, setSemanticType

Methods inherited from class java.lang.Object

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

Constructor Detail

DKLobICM

public DKLobICM(com.filenet.api.core.ContentTransfer contentTransfer,
                DKDatastoreICM datastore)

Constructs a LOB from a FileNet ContentTransfer.

Used when wrapping existing content elements from documents.

Parameters:

contentTransfer - the FileNet content transfer object

datastore - the datastore instance

DKLobICM

public DKLobICM(com.filenet.api.core.Document document,
                DKDatastoreICM datastore)

Constructs a LOB for a FileNet Document.

Parameters:

document - the FileNet document

datastore - the datastore instance

DKLobICM

public DKLobICM(com.filenet.api.core.Document document,
                DKDatastoreICM datastore,
                java.lang.String semanticType)

Constructs a LOB for a FileNet Document with semantic type.

Parameters:

document - the FileNet document

datastore - the datastore instance

semanticType - the CM8 semantic type

Method Detail

getInputStream

@Deprecated
public java.io.InputStream getInputStream(DKNVPair[] optionsDKNVPair,
                                                      int offset,
                                                      int length)

Deprecated. Use getContentInputStream(DKNVPair[], long, long) instead

Gets an input stream for the content.

Parameters:

optionsDKNVPair - retrieval options

offset - starting offset in bytes

length - number of bytes to read

Returns:

input stream for the content

getContentInputStream

public java.io.InputStream getContentInputStream(DKNVPair[] options,
                                                 long offset,
                                                 long length)

Gets an input stream for the content with offset and length control.

Allows reading a specific portion of the content by specifying offset and length. Useful for streaming large files or implementing range requests.

Parameters:

options - retrieval options (currently unused)

offset - starting offset in bytes (0-based)

length - number of bytes to read (0 or negative for entire content)

Returns:

input stream positioned at the specified offset

Throws:

java.lang.RuntimeException - if content retrieval fails

getContent

public byte[] getContent()

Gets the entire content as a byte array.

Loads the complete content into memory. Use with caution for large files.

Returns:

the content as a byte array, or null if no content exists

Throws:

java.lang.RuntimeException - if content reading fails

setContent

public void setContent(byte[] aByteArray)

Sets the content from a byte array.

Prepares the content for upload. Call add() to persist the changes.

Parameters:

aByteArray - the content bytes

add

public void add()
         throws DKException,
                java.lang.Exception

Adds/persists the LOB content to the document.

Saves the content that was set via setContent() or other add() methods.

Specified by:

add in interface dkXDO

Overrides:

add in class DKDDO

Throws:

DKException - if the add operation fails

java.lang.Exception - if an unexpected error occurs

add

public void add(java.io.InputStream inputStream,
                long length)
         throws DKException,
                java.lang.Exception

Adds content from an input stream.

Parameters:

inputStream - the input stream containing content

length - the number of bytes to read (0 for all)

Throws:

DKException - if the add operation fails

java.lang.Exception - if an unexpected error occurs

add

public void add(java.io.InputStream inputStream,
                long length,
                int bitwiseAddOptions)
         throws DKException,
                java.lang.Exception

Adds content from an input stream with options.

Parameters:

inputStream - the input stream containing content

length - the number of bytes to read (0 for all)

bitwiseAddOptions - bitwise options for the add operation

Throws:

DKException - if the add operation fails

java.lang.Exception - if an unexpected error occurs

add

public void add(int bitwiseAddOptions)
         throws DKException,
                java.lang.Exception

Throws:

DKException

java.lang.Exception

add

public void add(java.lang.String fullyQualifiedFileName)
         throws DKException,
                java.lang.Exception

Adds content from a file.

Reads the file and uploads its content to the document. The filename is automatically set as the original filename.

Parameters:

fullyQualifiedFileName - the full path to the file

Throws:

DKException - if the file cannot be read or the add operation fails

java.lang.Exception - if an unexpected error occurs

add

public void add(java.lang.String fullyQualifiedFileName,
                int bitwiseAddOptions)
         throws DKException,
                java.lang.Exception

Throws:

DKException

java.lang.Exception

retrieve

public void retrieve()

Description copied from class: DKDDO

Retrieve (refresh) the document or folder from the object store. This method fetches the latest version of the object from FileNet P8, refreshing all properties to their current values in the repository. Supports both documents (DK_CM_DOCUMENT) and folders (DK_CM_FOLDER).

Overrides:

retrieve in class DKDDO

retrieve

public void retrieve(DKNVPair[] optionsDKNVPair)

Description copied from class: DKDDO

Retrieve (refresh) the document from the object store with options. This overloaded method accepts an array of DKNVPair options but ignores them, internally calling the parameterless retrieve() method.

Overrides:

retrieve in class DKDDO

Parameters:

optionsDKNVPair - retrieve options (ignored in this implementation)

retrieve

public java.lang.Object retrieve(DKNVPair[] optionsDKNVPair,
                                 long offset,
                                 long length)

retrieve

public void retrieve(DKNVPair[] optionsDKNVPair,
                     java.lang.String targetLocalFileName,
                     int offset,
                     int length)

retrieve

public void retrieve(DKThirdPartyServerDef thirdPartyServerDef,
                     DKNVPair[] optionsDKNVPair)

retrieve

public void retrieve(java.lang.String targetLocalFileName,
                     DKNVPair[] optionsDKNVPair)

setMimeType

public void setMimeType(java.lang.String string)
                 throws DKException,
                        java.lang.Exception

Sets the MIME type for this content.

Parameters:

string - the MIME type (e.g., "application/pdf", "text/plain")

Throws:

DKException - if the operation fails

java.lang.Exception - if an unexpected error occurs

getMimeType

public java.lang.String getMimeType()
                             throws DKException

Gets the MIME type of this content.

Returns:

the MIME type string

Throws:

DKException - if the operation fails

setOrgFileName

public void setOrgFileName(java.lang.String ofile)

getOrgFileName

public java.lang.String getOrgFileName()
                                throws DKException

Throws:

DKException

getPartNumber

public int getPartNumber()
                  throws DKException

Throws:

DKException

getContentTransfer

public com.filenet.api.core.ContentTransfer getContentTransfer()

Gets the underlying FileNet ContentTransfer object.

Returns:

the ContentTransfer instance

del

public void del()
         throws DKException

Deletes this LOB content.

Overrides:

del in class DKDDO

Throws:

DKException - if the delete operation fails

del

public void del(boolean flush)
         throws DKException

Throws:

DKException

del

public void del(int option)
         throws DKException

Overrides:

del in class DKDDO

Throws:

DKException

getContentToClientFile

public void getContentToClientFile(java.lang.String fileName,
                                   int fileOption)
                            throws DKException,
                                   java.lang.Exception

Throws:

DKException

java.lang.Exception

getCreatedTimestamp

public java.lang.String getCreatedTimestamp()
                                     throws DKException,
                                            java.lang.Exception

Throws:

DKException

java.lang.Exception

getReferencedTimestamp

public java.lang.String getReferencedTimestamp()
                                        throws DKException,
                                               java.lang.Exception

Throws:

DKException

java.lang.Exception

getItemId

public java.lang.String getItemId()

getResourceName

public java.lang.String getResourceName()
                                 throws DKException

Throws:

DKException

getRMName

public java.lang.String getRMName()
                           throws DKException

Throws:

DKException

getSize

public long getSize()
             throws DKException

Gets the size of the content in bytes.

Returns:

the content size in bytes

Throws:

DKException - if the operation fails

size

public int size()
         throws DKException

Throws:

DKException

sizeInDatastore

public long sizeInDatastore()
                     throws DKException

Throws:

DKException

getUpdatedTimestamp

public java.lang.String getUpdatedTimestamp()
                                     throws DKException,
                                            java.lang.Exception

Throws:

DKException

java.lang.Exception

getVersionNumber

public java.lang.String getVersionNumber()
                                  throws DKException

Gets the version number of the document.

Returns:

the version number as a string

Throws:

DKException - if the operation fails

isSet

public boolean isSet()
              throws DKException

Checks if content has been set.

Returns:

true if content exists and has non-zero size, false otherwise

Throws:

DKException - if the check fails

setContentFromClientFile

public void setContentFromClientFile(java.lang.String fileName)
                              throws DKException,
                                     java.lang.Exception

Throws:

DKException

java.lang.Exception

isOpenSynchronous

public boolean isOpenSynchronous()

isNull

public boolean isNull()

setNewVersion

public void setNewVersion(boolean newVersion)

setNull

public void setNull()
             throws DKException

Throws:

DKException

update

public void update(java.io.InputStream inputStream,
                   long length)
            throws DKException,
                   java.lang.Exception

Throws:

DKException

java.lang.Exception

update

public void update()
            throws DKException

Updates the LOB with current changes.

Overrides:

update in class DKDDO

Throws:

DKException - if the update fails

update

public void update(int bitwiseUpdateOptions)
            throws DKException,
                   java.lang.Exception

Updates the LOB with options.

Overrides:

update in class DKDDO

Parameters:

bitwiseUpdateOptions - bitwise options for the update

Throws:

DKException - if the update fails

java.lang.Exception - if an unexpected error occurs

update

public void update(java.io.InputStream inputStream,
                   long length,
                   int bitwiseUpdateOptions)
            throws DKException,
                   java.lang.Exception

Updates content from an input stream.

Parameters:

inputStream - the input stream containing new content

length - the number of bytes to read

bitwiseUpdateOptions - bitwise options for the update

Throws:

DKException - if the update fails

java.lang.Exception - if an unexpected error occurs

update

public void update(java.lang.String fullyQualifiedFileName)
            throws DKException,
                   java.lang.Exception

Throws:

DKException

java.lang.Exception

update

public void update(java.lang.String fullyQualifiedFileName,
                   int bitwiseUpdateOptions)
            throws DKException,
                   java.lang.Exception

Throws:

DKException

java.lang.Exception

isContentChanged

public boolean isContentChanged()

Checks if the content has been modified.

Returns:

true if content has changed, false otherwise

getNewVersion

public boolean getNewVersion()

Gets whether this will create a new version.

Returns:

true (always creates new version)