wt.content
Interface ContentServiceSvr

public interface ContentServiceSvr

These methods are only able to be invoked from classes running in the server. Most of these methods are only needed by the ContentHttp class. They are also used by the loader and the indexing modules.

Supported API: true

Extendable: false

See Also:

ContentServerHelper

Method Summary

void	deleteContent(ContentHolder holder, ContentItem item) Deletes the passed ContentItem for the given ContentHolder.
void	deleteContent(WTSet contentItemSet) Deletes the contents associated with the input content item set.
InputStream	findContentStream(ApplicationData appData) Return the stream based on a ContentHolder and an ApplicationData object.
Enumeration	getHtmlFormatNames() Returns the list of valid formats for ApplicationData objects in the system.
wt.content.Aggregate	updateContent(ContentHolder holder, wt.content.Aggregate agg) Update a ContentHolder with the given Aggreate.
ApplicationData	updateContent(ContentHolder holder, ApplicationData appData, wt.fv.uploadtocache.CachedContentDescriptor cachedContDesc) Update a ContentHolder with the given content passed in with a CachedContDesc.
ApplicationData	updateContent(ContentHolder holder, ApplicationData appData, wt.fv.uploadtocache.CachedContentDescriptor cachedContDesc, boolean mustCreateNewFile) Supported API: true
ApplicationData	updateContent(ContentHolder holder, ApplicationData appData, InputStream is) Update a ContentHolder based on a persised ContentHolder and ContentItemInfo object and a new ApplicationData object and the corresponding stream to the content.
ApplicationData	updateContent(ContentHolder holder, ApplicationData appData, InputStream is, boolean mustCreateNewFile) Supported API: true
ApplicationData	updateContent(ContentHolder holder, ApplicationData appData, String fullPath) Update a ContentHolder with the given content passed in with a path.
wt.content.ExternalStoredData	updateContent(ContentHolder holder, wt.content.ExternalStoredData xStoredData) Update a ContentHolder with the given content passed in with a path.
URLData	updateContent(ContentHolder holder, URLData urlData) Update a ContentHolder with the given content passed in with a path.
Object[]	updateContent(Object[][] holderDataArray) Update multiple ContentHolders with its corresponding ApplicationData passed in as part of the object[][2].
Object[]	updateContent(Object[][] holderDataArray, boolean mustCreateNewFile) Update multiple ContentHolders with its corresponding ApplicationData passed in as part of the object[][2].
FormatContentHolder	updateHolderFormat(FormatContentHolder holder) This method will update the format for a FormatContentHolder based on the content in it at it's current state.
WTSet	updateHolderFormat(WTSet inHolderSet) This method will update the format for a FormatContentHolder based on the content in it at it's current state.
ApplicationData	updatePrimary(FormatContentHolder holder, ApplicationData appData, InputStream is) Update the primary for the passed FormatContentHolder with the passed ApplicationData and stream.
ContentItem	updatePrimary(FormatContentHolder holder, ContentItem item) Update the primary for the passed FormatContentHolder with the passed ContentItem.
void	writeContentStream(ApplicationData appData, String path) Write out the content to a path based on a ContentHolder and an ApplicationData object.

Method Detail

findContentStream

InputStream findContentStream(ApplicationData appData)
                              throws WTException

Return the stream based on a ContentHolder and an ApplicationData object.

Supported API: true

Parameters:

appData -

Returns:

InputStream

Throws:

WTException

writeContentStream

void writeContentStream(ApplicationData appData,
                        String path)
                        throws WTException,
                               IOException

Write out the content to a path based on a ContentHolder and an ApplicationData object.

Supported API: true

Parameters:

appData -

path -

Throws:

WTException

IOException

getHtmlFormatNames

Enumeration getHtmlFormatNames()
                               throws WTException

Returns the list of valid formats for ApplicationData objects in the system. These values are cached in the server, so this does not require a database hit every time.

Supported API: true

Returns:

Enumeration

Throws:

WTException

updateContent

ApplicationData updateContent(ContentHolder holder,
                              ApplicationData appData,
                              String fullPath)
                              throws WTException,
                                     PropertyVetoException,
                                     IOException,
                                     FileNotFoundException

Update a ContentHolder with the given content passed in with a path. This would be used for data migration tools.

Supported API: true

Parameters:

holder -

appData -

fullPath -

Returns:

ApplicationData

Throws:

WTException

PropertyVetoException

IOException

FileNotFoundException

updateContent

ApplicationData updateContent(ContentHolder holder,
                              ApplicationData appData,
                              wt.fv.uploadtocache.CachedContentDescriptor cachedContDesc)
                              throws WTException,
                                     PropertyVetoException

Update a ContentHolder with the given content passed in with a CachedContDesc. This would be used for Cached Content.

Supported API: true

Parameters:

holder -

appData -

cachedContDesc -

Returns:

ApplicationData

Throws:

WTException

PropertyVetoException

updateContent

URLData updateContent(ContentHolder holder,
                      URLData urlData)
                      throws WTException,
                             PropertyVetoException

Update a ContentHolder with the given content passed in with a path. This would be used for data migration tools.

Supported API: true

Parameters:

holder -

urlData -

Returns:

URLData

Throws:

WTException

PropertyVetoException

updateContent

ApplicationData updateContent(ContentHolder holder,
                              ApplicationData appData,
                              InputStream is)
                              throws WTException,
                                     PropertyVetoException,
                                     IOException,
                                     FileNotFoundException

Update a ContentHolder based on a persised ContentHolder and ContentItemInfo object and a new ApplicationData object and the corresponding stream to the content.

Supported API: true

Parameters:

holder -

appData -

is -

Returns:

ApplicationData

Throws:

WTException

PropertyVetoException

IOException

FileNotFoundException

updateContent

wt.content.Aggregate updateContent(ContentHolder holder,
                                   wt.content.Aggregate agg)
                                   throws WTException,
                                          PropertyVetoException

Update a ContentHolder with the given Aggreate. The Aggregate is attached as secondary content by default.

Supported API: true

Parameters:

holder -

agg -

Returns:

Aggregate

Throws:

WTException

PropertyVetoException

updateHolderFormat

FormatContentHolder updateHolderFormat(FormatContentHolder holder)
                                       throws WTException,
                                              PropertyVetoException

This method will update the format for a FormatContentHolder based on the content in it at it's current state. This method should be called after modifying a FormatContentHolder for a load or an upload.

Supported API: true

Parameters:

holder -

Returns:

FormatContentHolder

Throws:

WTException

PropertyVetoException

deleteContent

void deleteContent(ContentHolder holder,
                   ContentItem item)
                   throws WTException,
                          WTPropertyVetoException

Deletes the passed ContentItem for the given ContentHolder.

Supported API: true

Parameters:

holder -

item -

Throws:

WTException

WTPropertyVetoException

updatePrimary

ApplicationData updatePrimary(FormatContentHolder holder,
                              ApplicationData appData,
                              InputStream is)
                              throws WTException,
                                     PropertyVetoException,
                                     FileNotFoundException,
                                     IOException

Update the primary for the passed FormatContentHolder with the passed ApplicationData and stream. This can be an update or the save of a new primary.

Supported API: true

Parameters:

holder -

appData -

is -

Returns:

ApplicationData

Throws:

WTException

PropertyVetoException

FileNotFoundException

IOException

updatePrimary

ContentItem updatePrimary(FormatContentHolder holder,
                          ContentItem item)
                          throws WTException,
                                 PropertyVetoException

Update the primary for the passed FormatContentHolder with the passed ContentItem. This can be an update or the save of a new primary.

Supported API: true

Parameters:

holder -

item -

Returns:

ContentItem

Throws:

WTException

PropertyVetoException

updateContent

ApplicationData updateContent(ContentHolder holder,
                              ApplicationData appData,
                              wt.fv.uploadtocache.CachedContentDescriptor cachedContDesc,
                              boolean mustCreateNewFile)
                              throws WTException,
                                     PropertyVetoException

Supported API: true

Parameters:

holder -

appData -

cachedContDesc -

mustCreateNewFile -

Returns:

ApplicationData

Throws:

WTException

PropertyVetoException

updateContent

ApplicationData updateContent(ContentHolder holder,
                              ApplicationData appData,
                              InputStream is,
                              boolean mustCreateNewFile)
                              throws WTException,
                                     PropertyVetoException,
                                     IOException,
                                     FileNotFoundException

Supported API: true

Parameters:

holder -

appData -

is -

mustCreateNewFile -

Returns:

ApplicationData

Throws:

WTException

PropertyVetoException

IOException

FileNotFoundException

updateContent

Object[] updateContent(Object[][] holderDataArray,
                       boolean mustCreateNewFile)
                       throws WTException,
                              PropertyVetoException

Update multiple ContentHolders with its corresponding ApplicationData passed in as part of the object[][2]. The first index object is a ContentHolder, the second index object is a Hashtable containing ApplicationData and CachedContentDescriptor information, i.e. each element in the table, the key is a ApplicationData, the value is the corresponding CachedContentDescriptor. Returns an array of WTReference objects corresponding with the ApplicationData objects from the input array.

Supported API: true

Parameters:

holderDataArray -

mustCreateNewFile -

Returns:

Object[]

Throws:

WTException

PropertyVetoException

updateContent

Object[] updateContent(Object[][] holderDataArray)
                       throws WTException,
                              PropertyVetoException

Update multiple ContentHolders with its corresponding ApplicationData passed in as part of the object[][2]. The first index object is a ContentHolder, the second index object is a Hashtable containing ApplicationData and CachedContentDescriptor information, i.e. each element in the table, the key is a ApplicationData, the value is the corresponding CachedContentDescriptor. This will call updateContent() with mustCreateNewFile set to true. Returns an array of WTReference objects corresponding with the ApplicationData objects from the input array.

Supported API: true

Parameters:

holderDataArray -

Returns:

Object[]

Throws:

WTException

PropertyVetoException

deleteContent

void deleteContent(WTSet contentItemSet)
                   throws WTException,
                          WTPropertyVetoException

Deletes the contents associated with the input content item set.

Supported API: true

Parameters:

contentItemSet -

Throws:

WTException

WTPropertyVetoException

updateHolderFormat

WTSet updateHolderFormat(WTSet inHolderSet)
                         throws WTException,
                                PropertyVetoException

This method will update the format for a FormatContentHolder based on the content in it at it's current state. This method should be called after modifying a FormatContentHolder for a load or an upload.

Supported API: true

Parameters:

inHolderSet -

Returns:

WTSet

Throws:

WTException

PropertyVetoException

updateContent

wt.content.ExternalStoredData updateContent(ContentHolder holder,
                                            wt.content.ExternalStoredData xStoredData)
                                            throws WTException,
                                                   PropertyVetoException

Update a ContentHolder with the given content passed in with a path. This would be used for data migration tools.

Supported API: true

Parameters:

holder -

xStoredData -

Returns:

ExternalStoredData

Throws:

WTException

PropertyVetoException