com.edorasware.commons.core.content

Interface ContentManager

All Known Subinterfaces:

ConfigurableContentManager

All Known Implementing Classes:

DefaultConfigurableContentManager

public interface ContentManager

Content manager which interacts with the ContentProviders to get, update and delete content based on its ContentScope.

Method Summary

Modifier and Type	Method and Description
ContentReference	addContent(ContentInfo contentInfo, org.springframework.core.io.Resource resource, long inputStreamLength) Add content with the specified ContentInfo and the content itself as InputStream.
int	deleteContent(ContentReference contentReference) Deletes all versions of the specified ContentReference such that the passed in ContentReference cannot be used anymore to retrieve content.
void	deleteContent(ContentReference contentReference, String version) Deletes a specific version of the specified ContentReference such that the passed in ContentReference cannot be used anymore to retrieve content with that version.
void	deleteContent(String contentSourceId) Deletes the content that is associated to the supplied ContentSourceId.
org.springframework.core.io.Resource	getContent(ContentReference contentReference) Returns the latest version of the content.
org.springframework.core.io.Resource	getContent(ContentReference contentReference, String version) Returns the specified version of the content.
byte[]	getContentAsBytes(ContentReference contentReference) Returns the latest version of the content as a byte array.
byte[]	getContentAsBytes(ContentReference contentReference, String version) Returns the specified version of the content as a byte array.
Optional<ContentMetadata>	getContentMetadata(ContentReference contentReference) Returns the metadata of the latest version of the content.
Optional<ContentMetadata>	getContentMetadata(ContentReference contentReference, String version) Returns the metadata of the supplied version of the content.
Optional<ContentReference>	getContentReference(String contentReferenceId) Gets the content reference associated to the supplied ContentReferenceId.
List<ContentReference>	getContentReferences(String contentSourceId) Gets a list of all the content references associated to the supplied ContentSourceId.
List<String>	getContentVersions(ContentReference contentReference) Returns a list with all the versions of the content of the specified ContentReference.
ContentProvider	getDefaultContentProvider() Returns the default ContentProvider configured for the content manager instance.
void	setContentSourceId(ContentReference contentReference, String contentSourceId) Sets the ContentSourceId for a selected ContentReference.
ContentReference	updateContent(ContentReference contentReference, org.springframework.core.io.Resource resource, long inputStreamLength, ContentMetadata contentMetadata) This method behaves exactly like calling updateContent(ContentReference, Resource, long, ContentMetadata, boolean) with the last parameter set to false.
ContentReference	updateContent(ContentReference contentReference, org.springframework.core.io.Resource resource, long inputStreamLength, ContentMetadata contentMetadata, boolean overwrite) Updates the the content and the metadata of the specified ContentReference with the specified InputStream and ContentMetadata, with the option to overwrite te existing version.
void	updateContentMetadata(ContentReference contentReference, ContentMetadata contentMetadata) Updates the content metadata.

Method Detail

addContent

ContentReference addContent(ContentInfo contentInfo,
                            org.springframework.core.io.Resource resource,
                            long inputStreamLength)

Add content with the specified ContentInfo and the content itself as InputStream. The provided InputStream will always be closed. This method triggers the ContentListener.contentAdded(ContentEvent) method of the registered content listeners.

Parameters:

contentInfo - the content info

resource - the content as input stream

inputStreamLength - the length of the input stream

Returns:

the content reference of the added content

Throws:

ContentException - if there is an error with the specified input stream or the content could not be added

ContentProviderNotFoundException - if the content provider with the content provider id of the content info is not found

IllegalArgumentException - if the specified content info, the input stream or its length is not valid. Also, if the provided content metadata object size field is not a non-zero positive number

getContent

org.springframework.core.io.Resource getContent(ContentReference contentReference)

Returns the latest version of the content. The version of the specified ContentReference is not taken into account.

Parameters:

contentReference - the content reference of the content to be returned

Returns:

the content as input stream of the specified content reference. Must be closed after the data has been read.

Throws:

ContentException - if there is an error while retrieving the content

ContentNotFoundException - if the content is not found for the specified content reference

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

ContentPreProcessingException - if the content is still in processing

IllegalArgumentException - if the content reference is not valid

getContentAsBytes

byte[] getContentAsBytes(ContentReference contentReference)

Returns the latest version of the content as a byte array.

Note	Whenever possible you should use the stream-based content access methods as they will allow large content to be processed without requiring that the whole content be loaded into memory at the same time.

Parameters:

contentReference - the content reference of the content to be returned

Returns:

the content as a byte array

Throws:

ContentException - if there is an error while retrieving the content

ContentNotFoundException - if the content is not found for the specified content reference

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

ContentPreProcessingException - if the content is still in processing

IllegalArgumentException - if the content reference is not valid

getContent

org.springframework.core.io.Resource getContent(ContentReference contentReference,
                                                String version)

Returns the specified version of the content. The version of the specified ContentReference is not taken into account.

Parameters:

contentReference - the content reference of the content to be returned

version - the version of the content to be returned

Returns:

the content as input stream of the specified content reference and its version. Must be closed after the data has been read.

Throws:

ContentException - if there is an error while retrieving the content

ContentNotFoundException - if the content or the specified version of it is not found for the specified content reference

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

IllegalArgumentException - if the content reference or the version is not valid

getContentAsBytes

byte[] getContentAsBytes(ContentReference contentReference,
                         String version)

Returns the specified version of the content as a byte array.

Note	Whenever possible you should use the stream-based content access methods as they will allow large content to be processed without requiring that the whole content be loaded into memory at the same time.

Parameters:

contentReference - the content reference of the content to be returned

Returns:

the content as a byte array

Throws:

ContentException - if there is an error while retrieving the content

ContentNotFoundException - if the content is not found for the specified content reference

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

ContentPreProcessingException - if the content is still in processing

IllegalArgumentException - if the content reference is not valid

getContentMetadata

Optional<ContentMetadata> getContentMetadata(ContentReference contentReference)

Returns the metadata of the latest version of the content. The version of the specified ContentReference is not taken into account.

Parameters:

contentReference - the content reference of the content to be returned

Returns:

the Optional content metadata object of the specified content reference.

Throws:

ContentException - if there is an error while retrieving the content

ContentNotFoundException - if the content (and the content metadata) is not found for the specified content reference

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

IllegalArgumentException - if the content reference is not valid

getContentMetadata

Optional<ContentMetadata> getContentMetadata(ContentReference contentReference,
                                             String version)

Returns the metadata of the supplied version of the content. The version of the specified ContentReference is not taken into account.

Parameters:

contentReference - the content reference of the content to be returned

version - the version

Returns:

the content metadata object of the specified content reference.

Throws:

ContentException - if there is an error while retrieving the content

ContentNotFoundException - if the content (and the content metadata) is not found for the specified content reference

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

IllegalArgumentException - if the content reference or the version are not valid

getContentVersions

List<String> getContentVersions(ContentReference contentReference)

Returns a list with all the versions of the content of the specified ContentReference. The first entry of the list holds the first version and the last entry the last one.

Parameters:

contentReference - the content reference of the content versions to be returned

Returns:

a list with all the content versions

Throws:

ContentNotFoundException - if the content is not found for the specified content reference

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

IllegalArgumentException - if the content reference is not valid

getContentReferences

List<ContentReference> getContentReferences(String contentSourceId)

Gets a list of all the content references associated to the supplied ContentSourceId. In case of a multi-versioned content reference, the last version is retrieved.

Parameters:

contentSourceId - the content source id

Returns:

the content references

Throws:

ContentException - if there is an error while retrieving the content

IllegalArgumentException - if the content source id is null or undefined

getContentReference

Optional<ContentReference> getContentReference(String contentReferenceId)

Gets the content reference associated to the supplied ContentReferenceId. In case of a multi-versioned content reference, the last version is retrieved.

Parameters:

contentReferenceId - the content reference id

Returns:

an optional content reference

Throws:

ContentException - if there is an error while retrieving the content

getDefaultContentProvider

ContentProvider getDefaultContentProvider()

Returns the default ContentProvider configured for the content manager instance.

Returns:

the default content provider

updateContent

ContentReference updateContent(ContentReference contentReference,
                               org.springframework.core.io.Resource resource,
                               long inputStreamLength,
                               ContentMetadata contentMetadata)

This method behaves exactly like calling updateContent(ContentReference, Resource, long, ContentMetadata, boolean) with the last parameter set to false.

Parameters:

contentReference - the content reference to be updated

resource - the updated content as input stream

inputStreamLength - the length of the input stream

contentMetadata - the optional content metadata

Returns:

the content reference with the new version

Throws:

ContentException - if there is an error with the specified input stream or the content could not be added

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

IllegalArgumentException - if the content reference, the input stream or its length is not valid. Also, if the provided content metadata object size field is not a non-zero positive number

updateContent

ContentReference updateContent(ContentReference contentReference,
                               org.springframework.core.io.Resource resource,
                               long inputStreamLength,
                               ContentMetadata contentMetadata,
                               boolean overwrite)

Updates the the content and the metadata of the specified ContentReference with the specified InputStream and ContentMetadata, with the option to overwrite te existing version. A new ContentReference will be returned with the new version set if the overwrite flag is set to false. The same ContentReference will be returned if the overwrite flag is set to true. The source id of the specified content reference must not be changed. The provided InputStream will always be closed. This method triggers the ContentListener.contentUpdated(ContentEvent) method of the registered content listeners.

Parameters:

contentReference - the content reference to be updated

resource - the updated content as input stream

inputStreamLength - the length of the input stream

contentMetadata - the optional content metadata

overwrite - true if the content that is about to be updated shall be overwritten, otherwise false

Returns:

the content reference with the new version (or the same if the overwrite flag is set to true)

Throws:

ContentException - if there is an error with the specified input stream or the content could not be added

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

IllegalArgumentException - if the content reference, the input stream or its length is not valid

updateContentMetadata

void updateContentMetadata(ContentReference contentReference,
                           ContentMetadata contentMetadata)

Updates the content metadata. This method triggers the ContentListener.contentUpdated(ContentEvent) method of the registered content listeners.

Parameters:

contentReference - the content reference

contentMetadata - the content metadata

Throws:

ContentException - if there is an error updating the content metadata

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

IllegalArgumentException - if the content reference is not valid or if the provided content metadata object size field is not a non-zero positive number

setContentSourceId

void setContentSourceId(ContentReference contentReference,
                        String contentSourceId)

Sets the ContentSourceId for a selected ContentReference. All the versions of the content reference are updated. This method triggers the ContentListener.contentUpdated(ContentEvent) method of the registered content listeners.

Parameters:

contentReference - the content reference

contentSourceId - the content source id

Throws:

ContentException - if there is an error updating the content source id

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

IllegalArgumentException - if the content reference or the content source id are not valid

deleteContent

int deleteContent(ContentReference contentReference)

Deletes all versions of the specified ContentReference such that the passed in ContentReference cannot be used anymore to retrieve content. This method triggers the ContentListener.contentDeleted(ContentEvent, Optional) method of the registered content listeners.

Parameters:

contentReference - the content reference to be deleted

Returns:

the number of content versions deleted

Throws:

ContentException - if there is an error deleting the content

ContentNotFoundException - if the content is not found for the specified content reference

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

IllegalArgumentException - if the content reference is not valid

deleteContent

void deleteContent(ContentReference contentReference,
                   String version)

Deletes a specific version of the specified ContentReference such that the passed in ContentReference cannot be used anymore to retrieve content with that version. This method triggers the ContentListener.contentDeleted(ContentEvent, Optional) method of the registered content listeners.

Parameters:

contentReference - the content reference to be deleted

version - the version of the content to be deleted

Throws:

ContentException - if there is an error deleting the content

ContentNotFoundException - if the content or the specified version of it is not found for the specified content reference

ContentProviderNotFoundException - if the content provider with the content provider id of the content reference is not found

IllegalArgumentException - if the content reference or the version is not valid

deleteContent

void deleteContent(String contentSourceId)

Deletes the content that is associated to the supplied ContentSourceId. All the configured content providers are called to delete the content. This method triggers the ContentListener.contentDeleted(ContentEvent, Optional) method of the registered content listeners.

Parameters:

contentSourceId - the content source id

Throws:

ContentException - if there is an error deleting the content

IllegalArgumentException - if the {ContentSourceId is null