oracle.ifs.server

Interface ContentStorageManager

All Known Implementing Classes:

OracleContentStorageManager, PostgresContentStorageManager, S_LibrarySessionContentStorageManager

public interface ContentStorageManager

Interface known as "CSM defining the server-side content storage management primary operations for read, write, update, and destruction of content, and miscellaneous operations for Oracle Text, BFILE, random access, authorization, buffer management.

CSM mediates access to the subsystem that stores, retrieves, and otherwise manages binary content. This subsystem includes:

• MEDIA and its subtypes
• the content storage tables
• content migration between MEDIAs
• quota
• Oracle Text indexing
• Oracle Text themes, gists, and summaries

Method Summary

Modifier and Type	Method and Description
byte[]	acquireByteBuffer() Acquires a byte buffer.
void	deleteFromContextRouter(Long coId) Deletes a row from the context router table.
int	deleteOldFilteredContent(S_LibrarySession session, long age) Delete old filtered content entries.
void	destroyContent(S_Media media, Long cid, Long coId, S_LibraryObjectDefinition sdef) Destroys the content, if any, for the specified ContentObject.
void	destroyTextRenditions(S_ContentObject co) Destroy all text renditions: themes, summaries, and filtered content.
void	dispose() Disposes this CSM.
Long	extractContentForIndexing(Long prevContentObjectId, int batchSize) Called by the ContentAgent, identifies rows in ODMZ_CONTEXT_ROUTER whose content is ready for indirect full-text indexing, and for each such row, sets the INDEXABLECONTENT BLOB column to the content.
void	filterContent(S_ContentObject co, boolean plaintext) Generate filtered content for the specified ContentObject.
void	generateSummary(S_ContentObject co, String pointOfView, long sizeAsPercent, long sizeAsNumParagraphs, String summaryLevel) Generate Summary for specified ContentObject.
void	generateThemes(S_ContentObject co, boolean fullThemes) Generate Themes for specified ContentObject.
int	getByteBufferSize() Estimates the size, in bytes, of a buffer that would be returned by acquireByteBuffer.
S_RandomAccessorImpl	getContentByRandomAccess(S_Document doc, S_ContentObject co) Gets a RandomAccessor for randomly reading the content of the specified document.
Reader	getContentReader(S_ContentObject co) Gets the content of the specified ContentObject as a Reader.
InputStream	getContentStream(S_ContentObject co) Gets the content of the specified ContentObject as an InputStream.
Reader	getFilteredContent(S_ContentObject co) Gets the filtered content for specified ContentObject.
String	getFullTextIndexName() Gets the name of the full text index.
Date	getLastAccessDate(Long coId) Gets the last access date for the specified ContentObject.
Long	getNewContentID() Gets a new ID to use for created new content.
Reader	getSummary(S_ContentObject co, String pointOfView) Gets the summary for specified ContentObject and point of view.
ContextTheme[]	getThemes(S_ContentObject co) Gets the generate Themes for specified ContentObject.
void	insertIntoContextRouter(Long coId, Long coClassId, Long cid, S_Media media, S_ContentVaultEntry cve, long contentSize, String oracleCharacterSet, String oracleLanguage, boolean text, boolean indirectFullTextIndexing) Inserts a row in the context router table.
void	invalidateFilteredContent(S_ContentObject co) Invalidates any Filtered Content that was generated for specified ContentObject.
void	invalidateSummaries(S_ContentObject co) Invalidates any Summary that was generated for specified ContentObject.
void	invalidateThemes(S_ContentObject co) Invalidates any Themes that have been generated for specified ContentObject.
boolean	isFullTextIndexingEnabled() Gets whether full-text indexing is enabled.
void	manuallyInsertIntoContextRouter(S_ContentObject co, Reader reader) Insert of a row in the context router table for the case of manual text indexing.
void	registerBfile(Object bfile) Binds the specified BFILE to this session.
void	registerRandomAccessor(S_RandomAccessorImpl ra) Binds the specified RandomAccessor to this session.
void	releaseByteBuffer(byte[] buffer) Releases a byte buffer previously acquired by acquireByteBuffer.
String	resolveCharacterSet(S_LibraryObjectDefinition def) Gets the CHARACTERSET attribute of the specified ContentObject definition, setting a default CHARACTERSET attribute if one isn't set.
Serializable	retrieveSerializedObject(Long contentRef) Retrieve serializable object from the default Media instance.
S_Media	selectMedia(S_ContentObject co, S_LibraryObjectDefinition def) Selects the media to use for the specified ContentObject.
void	setContentProperties(S_LibraryObjectDefinition sdef, S_ContentObject sco) Cascades updates to a ContentObject, defined in the specified definition, to other data structures.
Long	storeSerializedObject(Serializable obj) Store serializable object in the default Media instance.
void	syncIndex() Synchronize the full text index.
void	unregisterBfile(Object bfile) Unbinds the specified BFILE from this session.
void	unregisterRandomAccessor(S_RandomAccessorImpl ra) Unbinds the specified RandomAccessor from this session.
S_RandomAccessorImpl	updateContentByRandomAccess(S_Document doc, S_ContentObject co, S_LibraryObjectDefinition sdocdef, Long expirationPeriod) Gets a RandomAccessor for randomly writing and reading the content of the specified document.
S_Media	validateMedia(S_ContentObject co, S_LibraryObjectDefinition def) Sets the content of the specified ContentObject.
void	validateMediaAndSetContent(S_ContentObject co, S_LibraryObjectDefinition def) Sets the content of the specified ContentObject.
void	verifyCanDestroyContent(S_Media media, Long cid) Verify that content can be destroyed for the specified Media.

Method Detail

dispose

void dispose()

Disposes this CSM.

(Unpublished)

validateMedia

S_Media validateMedia(S_ContentObject co,
                      S_LibraryObjectDefinition def)
               throws IfsException

Sets the content of the specified ContentObject.

If media is specified in the definition, it is validated. Otherwise a media is chosen by default and set in the definition.

Parameters:

co - the ContentObject; required

def - the ContentObject definition; required

Returns:

the resolved Media

Throws:

IfsException - if the operation fails

(Published)

selectMedia

S_Media selectMedia(S_ContentObject co,
                    S_LibraryObjectDefinition def)
             throws IfsException

Selects the media to use for the specified ContentObject.

If media is specified in the definition, it is validated. Otherwise a media is chosen by default and set in the definition.

Parameters:

co - the ContentObject; required

def - the ContentObject definition; required

Returns:

the resolved Media

Throws:

IfsException - if the operation fails

(Unpublished)

validateMediaAndSetContent

void validateMediaAndSetContent(S_ContentObject co,
                                S_LibraryObjectDefinition def)
                         throws IfsException

Sets the content of the specified ContentObject.

The ContentObject may be existing or new. An existing ContentObject must not already have content (or destroyContent must be called prior to this method.)

Parameters:

co - the ContentObject; required

def - the ContentObject definition; required

Throws:

IfsException - if the operation fails

(Published)

resolveCharacterSet

String resolveCharacterSet(S_LibraryObjectDefinition def)
                    throws IfsException

Gets the CHARACTERSET attribute of the specified ContentObject definition, setting a default CHARACTERSET attribute if one isn't set.

The CHARACTERSET attribute, if set, should be a valid IANA charset (preferred) or the canonical name or alias of a valid Java charset. (In general, Java charset names follow the IANA charset conventions.) Although the CHARACTERSET attribute is not validated, some CMSDK operations (such as getting content as a Reader) will succeed only if the CHARACTERSET is a valid Java charset.

If the specified definition has the CHARACTERSET attribute set (including set to null), then that CHARACTERSET is returned. Otherwise, gets the default character set from the session's Localizer, sets the definition's CHARACTERSET attribute to that value, and also returns that value.

This method is called only if either the definition's FORMAT attribute has a BINARY value of false or content is set by Reader. In all other cases, no default CHARACTERSET is set on a ContentObject.

Parameters:

def - the ContentObject definition

Returns:

the character set

Throws:

IfsException - if the operation fails

(Published)

getContentStream

InputStream getContentStream(S_ContentObject co)
                      throws IfsException

Gets the content of the specified ContentObject as an InputStream.

Parameters:

co - the ContentObject; required

Returns:

the content stream

Throws:

IfsException - if the operation fails

(Published)

getContentReader

Reader getContentReader(S_ContentObject co)
                 throws IfsException

Gets the content of the specified ContentObject as a Reader.

Parameters:

co - the ContentObject; required

Returns:

the content

Throws:

IfsException - if the operation fails

(Published)

setContentProperties

void setContentProperties(S_LibraryObjectDefinition sdef,
                          S_ContentObject sco)
                   throws IfsException

Cascades updates to a ContentObject, defined in the specified definition, to other data structures.

Parameters:

sdef - definition containing the uppdates

sco - the existing ContentObject being updated

Throws:

IfsException - if the operation fails

(Published)

getLastAccessDate

Date getLastAccessDate(Long coId)
                throws IfsException

Gets the last access date for the specified ContentObject.

Parameters:

coId - the ContentObject id; required

Returns:

the last access date, or null if none

Throws:

IfsException - if the operation fails

(Published)

destroyContent

void destroyContent(S_Media media,
                    Long cid,
                    Long coId,
                    S_LibraryObjectDefinition sdef)
             throws IfsException

Destroys the content, if any, for the specified ContentObject.

Parameters:

media - the media

cid - the content id

coId - the ContentObject id

sdef - the ContentObject definition

Throws:

IfsException - if the operation fails

(Published)

isFullTextIndexingEnabled

boolean isFullTextIndexingEnabled()
                           throws IfsException

Gets whether full-text indexing is enabled.

Each invocation of this method queries the database. S_LibrarySession.isFullTextIndexingEnabled() caches the value returned by this method, and should almost always be used instead of this method.

Returns:

whether full-text indexing is enabled

Throws:

IfsException - if the operation fails

(Published)

getFullTextIndexName

String getFullTextIndexName()

Gets the name of the full text index.

Returns:

the name of the full text index

(Published)

syncIndex

void syncIndex()
        throws IfsException

Synchronize the full text index.

Throws:

IfsException - if the operation fails

(Published)

insertIntoContextRouter

void insertIntoContextRouter(Long coId,
                             Long coClassId,
                             Long cid,
                             S_Media media,
                             S_ContentVaultEntry cve,
                             long contentSize,
                             String oracleCharacterSet,
                             String oracleLanguage,
                             boolean text,
                             boolean indirectFullTextIndexing)
                      throws IfsException

Inserts a row in the context router table.

Parameters:

coId - the ContentObject id; required

coClassId - the ContentObject class id; required

cid - the content id; required

media - the Media where the content is stored; required

cve - the ContentVaultEntry (can be null)

contentSize - the content size; required

oracleCharacterSet - the Oracle character set code

oracleLanguage - the Oracle language code

text - whether the context is a text format

indirectFullTextIndexing - whether to perform indirect full-text indexing

Throws:

IfsException - if the operation fails

(Published)

manuallyInsertIntoContextRouter

void manuallyInsertIntoContextRouter(S_ContentObject co,
                                     Reader reader)
                              throws IfsException

Insert of a row in the context router table for the case of manual text indexing.

Unlike Oracle, Postgres uses a different Full text search insert mode known as "manual text indexing". This is driven by an agent.

Parameters:

co - the ContentObject; required

reader - the manually obtained text reader to be indexed

Throws:

IfsException - if the operation fails

(Published)

deleteFromContextRouter

void deleteFromContextRouter(Long coId)
                      throws IfsException

Deletes a row from the context router table.

Parameters:

coId - the ContentObject id; required

Throws:

IfsException - if the operation fails

(Published)

extractContentForIndexing

Long extractContentForIndexing(Long prevContentObjectId,
                               int batchSize)
                        throws IfsException

Called by the ContentAgent, identifies rows in ODMZ_CONTEXT_ROUTER whose content is ready for indirect full-text indexing, and for each such row, sets the INDEXABLECONTENT BLOB column to the content.

To avoid long-running transactions, this method is repeatedly called to extract content in batches. Only rows in ODMZ_CONTEXT_ROUTER whose id is greater than previousContentObjectId are considered. Each invocation processes no more than batchSize rows in ODMZ_CONTEXT_ROUTER.

Parameters:

prevContentObjectId - the id of the last ODMZ_CONTEXT_ROUTER row processed in the previous batch, or null if this is the first batch

batchSize - the maximum number of rows to process in this batch

Returns:

the id of the last ODMZ_CONTEXT_ROUTER row processed in this batch, or null if no rows were processed

Throws:

IfsException - 32385: if the operation fails

(Published)

generateThemes

void generateThemes(S_ContentObject co,
                    boolean fullThemes)
             throws IfsException

Generate Themes for specified ContentObject.

Parameters:

co - the ContentObject

fullThemes - whether full themes are desired

Throws:

IfsException - if the operation fails

(Unpublished)

getThemes

ContextTheme[] getThemes(S_ContentObject co)
                  throws IfsException

Gets the generate Themes for specified ContentObject.

Parameters:

co - the ContentObject

Returns:

the themes

Throws:

IfsException - if the operation fails

(Unpublished)

invalidateThemes

void invalidateThemes(S_ContentObject co)
               throws IfsException

Invalidates any Themes that have been generated for specified ContentObject.

Parameters:

co - the ContentObject

Throws:

IfsException - if the operation fails

(Unpublished)

generateSummary

void generateSummary(S_ContentObject co,
                     String pointOfView,
                     long sizeAsPercent,
                     long sizeAsNumParagraphs,
                     String summaryLevel)
              throws IfsException

Generate Summary for specified ContentObject.

Parameters:

co - the ContentObject

pointOfView - the point Of view

sizeAsPercent - the size As Percent

sizeAsNumParagraphs - the size As number of paragraphs

summaryLevel - the summary level

Throws:

IfsException - if the operation fails

(Unpublished)

getSummary

Reader getSummary(S_ContentObject co,
                  String pointOfView)
           throws IfsException

Gets the summary for specified ContentObject and point of view.

Parameters:

co - the ContentObject

pointOfView - the point Of view

Returns:

the summary

Throws:

IfsException - if the operation fails

(Unpublished)

invalidateSummaries

void invalidateSummaries(S_ContentObject co)
                  throws IfsException

Invalidates any Summary that was generated for specified ContentObject.

Parameters:

co - the ContentObject

Throws:

IfsException - if the operation fails

(Unpublished)

filterContent

void filterContent(S_ContentObject co,
                   boolean plaintext)
            throws IfsException

Generate filtered content for the specified ContentObject.

Parameters:

co - the ContentObject

plaintext - whether to use plain text

Throws:

IfsException - if the operation fails

(Unpublished)

getFilteredContent

Reader getFilteredContent(S_ContentObject co)
                   throws IfsException

Gets the filtered content for specified ContentObject.

Parameters:

co - the ContentObject

Returns:

the filtered content

Throws:

IfsException - if the operation fails

(Unpublished)

invalidateFilteredContent

void invalidateFilteredContent(S_ContentObject co)
                        throws IfsException

Invalidates any Filtered Content that was generated for specified ContentObject.

Parameters:

co - the ContentObject

Throws:

IfsException - if the operation fails

(Unpublished)

deleteOldFilteredContent

int deleteOldFilteredContent(S_LibrarySession session,
                             long age)
                      throws IfsException

Delete old filtered content entries.

Parameters:

session - the S_LibrarySession

age - the number of seconds that constitutes an "old" entry

Throws:

IfsException - if the operation fails

(Unpublished)

destroyTextRenditions

void destroyTextRenditions(S_ContentObject co)
                    throws IfsException

Destroy all text renditions: themes, summaries, and filtered content.

Parameters:

co - the ContentObject

Throws:

IfsException - if the operation fails

(Unpublished)

registerBfile

void registerBfile(Object bfile)
            throws IfsException

Binds the specified BFILE to this session.

Parameters:

bfile - the BFILE

Throws:

IfsException - if the operation fails

(Unpublished)

unregisterBfile

void unregisterBfile(Object bfile)
              throws IfsException

Unbinds the specified BFILE from this session.

Parameters:

bfile - the BFILE

Throws:

IfsException - if the operation fails

(Unpublished)

getContentByRandomAccess

S_RandomAccessorImpl getContentByRandomAccess(S_Document doc,
                                              S_ContentObject co)
                                       throws IfsException

Gets a RandomAccessor for randomly reading the content of the specified document.

Parameters:

doc - the document

co - the ContentObject of the document

Returns:

a read-only RandomAccessor

Throws:

IfsException - if the operation fails

(Published)

updateContentByRandomAccess

S_RandomAccessorImpl updateContentByRandomAccess(S_Document doc,
                                                 S_ContentObject co,
                                                 S_LibraryObjectDefinition sdocdef,
                                                 Long expirationPeriod)
                                          throws IfsException

Gets a RandomAccessor for randomly writing and reading the content of the specified document.

Parameters:

doc - the document

co - the ContentObject of the document

sdocdef - a DocumentDefinition, as a S_LibraryObjectDefinition

expirationPeriod - the expiration period for the RandomAccessor, in seconds, or null for the default expiration period

Returns:

a read/write RandomAccessor

Throws:

IfsException - if the operation fails

(Published)

registerRandomAccessor

void registerRandomAccessor(S_RandomAccessorImpl ra)
                     throws IfsException

Binds the specified RandomAccessor to this session.

Parameters:

ra - the random acccessor

Throws:

IfsException - if the operation fails

(Published)

unregisterRandomAccessor

void unregisterRandomAccessor(S_RandomAccessorImpl ra)
                       throws IfsException

Unbinds the specified RandomAccessor from this session.

Parameters:

ra - the random accessor

Throws:

IfsException - if the operation fails

(Published)

getNewContentID

Long getNewContentID()
              throws IfsException

Gets a new ID to use for created new content.

Returns:

the ID to use for new content entry

Throws:

IfsException - if the operation fails

(Published)

storeSerializedObject

Long storeSerializedObject(Serializable obj)
                    throws IfsException

Store serializable object in the default Media instance.

Parameters:

obj - the object to store

Returns:

the ID that identifies the newly stored object

Throws:

IfsException - if the operation fails

(Unpublished)

retrieveSerializedObject

Serializable retrieveSerializedObject(Long contentRef)
                               throws IfsException

Retrieve serializable object from the default Media instance.

Parameters:

contentRef - the ID that identifies the newly stored object

Returns:

the object to store

Throws:

IfsException - if the operation fails

(Unpublished)

verifyCanDestroyContent

void verifyCanDestroyContent(S_Media media,
                             Long cid)
                      throws IfsException

Verify that content can be destroyed for the specified Media.

Parameters:

media - the Media to check

cid - the content ID

Throws:

IfsException - if the operation fails

(Published)

getByteBufferSize

int getByteBufferSize()
               throws IfsException

Estimates the size, in bytes, of a buffer that would be returned by acquireByteBuffer.

Returns:

the estimated size, in bytes

Throws:

IfsException - if the operation fails

(Published)

acquireByteBuffer

byte[] acquireByteBuffer()
                  throws IfsException

Acquires a byte buffer.

releaseByteBuffer must be called to release the byte buffer when it is no longer needed.

Returns:

the buffer

Throws:

IfsException - if the operation fails

(Published)

releaseByteBuffer

void releaseByteBuffer(byte[] buffer)
                throws IfsException

Releases a byte buffer previously acquired by acquireByteBuffer.

Parameters:

buffer - the buffer

Throws:

IfsException - if the operation fails

(Published)