com.edorasware.commons.core.content

Interface ContentProvider

All Superinterfaces:

Identifiable

All Known Implementing Classes:

BaseConfigurableContentProvider, DatabaseContentProvider, FilesystemContentProvider

public interface ContentProvider
extends Identifiable

Represents a content provider which is used to add, get, update and delete content. The content provider itself needs to check if it is able to resolve a given ContentReference and if it supports versioning of the content.

Method Summary

Modifier and Type	Method and Description
void	addContent(ContentScope contentScope, ContentReference contentReference, ContentMetadata contentMetadata, org.springframework.core.io.Resource resource, long inputStreamLength) Add content with the specified ContentInfo and the content itself as InputStream.
ContentReference	createContentReference(ContentInfo contentInfo) Creates a new ContentReference for the specified ContentInfo.
void	deleteContent(ContentScope contentScope) Deletes all the content of the content provider for the supplied ContentScope.
int	deleteContent(ContentScope contentScope, ContentReference contentReference) Deletes all versions of the specified ContentReference such that the passed in ContentReference cannot be used anymore to retrieve content.
void	deleteContent(ContentScope contentScope, 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.
List<ContentReference>	deleteContent(ContentScope contentScope, String contentSourceId) Deletes the content that is associated to the supplied ContentSourceId for the ContentScope.
org.springframework.core.io.Resource	getContent(ContentScope contentScope, ContentReference contentReference) Returns the latest version of the content within the content scope.
org.springframework.core.io.Resource	getContent(ContentScope contentScope, ContentReference contentReference, String version) Returns the specified version of the content.
Optional<ContentMetadata>	getContentMetadata(ContentScope contentScope, ContentReference contentReference) Returns the metadata of the latest version of the content.
Optional<ContentMetadata>	getContentMetadata(ContentScope contentScope, ContentReference contentReference, String version) Returns the metadata of the supplied version of the content.
Optional<ContentReference>	getContentReference(ContentScope contentScope, String contentReferenceId) Gets the content reference associated to the supplied ContentReferenceId for the ContentScope.
List<ContentReference>	getContentReferences(ContentScope contentScope, String contentSourceId) Gets a list of all the content references associated to the supplied ContentSourceId for the ContentScope.
List<String>	getContentVersions(ContentScope contentScope, ContentReference contentReference) Returns a list with all versions of the content of the specified ContentReference.
String	getName() Returns the name of the content provider.
void	processContent(ContentScope contentScope, ContentProcessor contentProcessor) Process all content in the given provider with the processor
void	setContentSourceId(ContentScope contentScope, ContentReference contentReference, String contentSourceId) Sets the ContentSourceId for a selected ContentReference.
boolean	supports(ContentReference contentReference) Returns true if the specified ContentReference is resolvable by the content provider, false otherwise.
boolean	supportsVersioning() Returns true if the content provider supports versioning, false otherwise.
ContentReference	updateContent(ContentScope contentScope, ContentReference contentReference, org.springframework.core.io.Resource resource, long inputStreamLength, ContentMetadata contentMetadata) Updates the specified ContentReference with the specified InputStream.
ContentReference	updateContent(ContentScope contentScope, ContentReference contentReference, org.springframework.core.io.Resource inputStream, long inputStreamLength, ContentMetadata contentMetadata, boolean overwrite) Updates the specified ContentReference with the specified InputStream.
void	updateContentMetadata(ContentScope contentScope, ContentReference contentReference, ContentMetadata contentMetadata) Updates the content metadata.

Methods inherited from interface com.edorasware.commons.core.id.Identifiable

getId

Method Detail

getName

String getName()

Returns the name of the content provider.

Returns:

the name of the content provider

supportsVersioning

boolean supportsVersioning()

Returns true if the content provider supports versioning, false otherwise.

Returns:

true if the content provider supports versioning, false otherwise.

supports

boolean supports(ContentReference contentReference)

Returns true if the specified ContentReference is resolvable by the content provider, false otherwise.

Parameters:

contentReference - the content reference to be checked

Returns:

true if the specified ContentReference is resolvable by the content provider, false otherwise.

createContentReference

ContentReference createContentReference(ContentInfo contentInfo)

Creates a new ContentReference for the specified ContentInfo.

Returns:

the content reference for the specified ContentInfo

addContent

void addContent(ContentScope contentScope,
                ContentReference contentReference,
                ContentMetadata contentMetadata,
                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.

Parameters:

contentScope - the content scope.

contentReference - the content reference

contentMetadata - the content meta data

resource - the content as input stream

inputStreamLength - the length of the input stream

Throws:

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

IllegalArgumentException - if the content provider id of the content info is not equal to the content provider’s one or if the specified input stream or its length is not valid

getContent

org.springframework.core.io.Resource getContent(ContentScope contentScope,
                                                ContentReference contentReference)

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

Parameters:

contentScope - the content scope

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 and scope

IllegalArgumentException - if the content provider id of the content reference is not equal to the content provider’s one

getContent

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

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

Parameters:

contentScope - the content scope

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 and scope

IllegalArgumentException - if the content provider id of the content reference is not equal to the content provider’s one

getContentMetadata

Optional<ContentMetadata> getContentMetadata(ContentScope contentScope,
                                             ContentReference contentReference)

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

Parameters:

contentScope - the content scope

contentReference - the content reference of the content to be returned

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 is not valid

getContentMetadata

Optional<ContentMetadata> getContentMetadata(ContentScope contentScope,
                                             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:

contentScope - the content scope

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 is not valid

getContentVersions

List<String> getContentVersions(ContentScope contentScope,
                                ContentReference contentReference)

Returns a list with all 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:

contentScope - the content scope

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

Returns:

a list with all the content versions

Throws:

ContentNotFoundException - if no versions of the content is found for the specified content reference and scope

IllegalArgumentException - if the content provider id of the content reference is not equal to the content provider’s one

getContentReferences

List<ContentReference> getContentReferences(ContentScope contentScope,
                                            String contentSourceId)

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

Parameters:

contentScope - the content scope

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(ContentScope contentScope,
                                               String contentReferenceId)

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

Parameters:

contentScope - the content scope

contentReferenceId - the content reference id

Returns:

optional the content reference

Throws:

ContentException - if there is an error while retrieving the content reference

updateContent

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

Updates the specified ContentReference with the specified InputStream. A new ContentReference will be returned with the new version set. The source id and the version of the specified content reference are ignored. The source id set at the the creation of the content reference is used for the new reference. The provided InputStream will always be closed.

Parameters:

contentScope - the content scope

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

ContentNotFoundException - if the content to be updated is not found for the specified content reference and scope

IllegalArgumentException - if the content provider id of the content reference is not equal to the content provider’s one or if the specified input stream or its length is not valid.

updateContent

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

Updates the specified ContentReference with the specified InputStream. 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 and the version of the specified content reference are ignored. The source id set at the the creation of the content reference is used for the new reference. The provided InputStream will always be closed.

Parameters:

contentScope - the content scope

contentReference - the content reference to be updated

inputStream - 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

Throws:

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

ContentNotFoundException - if the content to be updated is not found for the specified content reference and scope

IllegalArgumentException - if the content scope is not valid or if the content provider id of the content reference is not equal to the content provider’s one or if the specified input stream or its length is not valid.

updateContentMetadata

void updateContentMetadata(ContentScope contentScope,
                           ContentReference contentReference,
                           ContentMetadata contentMetadata)

Updates the content metadata.

Parameters:

contentScope - the content scope

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(ContentScope contentScope,
                        ContentReference contentReference,
                        String contentSourceId)

Sets the ContentSourceId for a selected ContentReference. All the versions of the content reference are updated.

Parameters:

contentScope - the content scope

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

void deleteContent(ContentScope contentScope)

Deletes all the content of the content provider for the supplied ContentScope. CAUTION: This method is very destructive. All the configured content providers are called to delete the content. This method is intended only for maintenance purposes.

Throws:

ContentException - if there is an error deleting the content

deleteContent

int deleteContent(ContentScope contentScope,
                  ContentReference contentReference)

Deletes all versions of the specified ContentReference such that the passed in ContentReference cannot be used anymore to retrieve content. If the last content reference of a scope is deleted, the scope itself will not be considered valid anymore.

Parameters:

contentScope - the content scope

contentReference - the content reference to be deleted

Returns:

the number of content versions deleted

Throws:

ContentException - if there is an error while deleting the content

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

IllegalArgumentException - if the content reference or the content provider are not valid of if the content provider id of the content reference is not equal to the content provider’s one

deleteContent

void deleteContent(ContentScope contentScope,
                   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. If all content versions are deleted the whole content gets deleted (same as deleteContent(ContentScope, ContentReference)). If the last content reference of a scope is deleted, the scope itself will not be considered valid anymore.

Parameters:

contentScope - the content scope

contentReference - the content reference to be deleted

version - the version of the content to be deleted

Throws:

ContentException - if there is an error while deleting the version of the content

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

IllegalArgumentException - if the content scope or the content reference or the version are not valid or if the content provider id of the content reference is not equal to the content provider’s one

deleteContent

List<ContentReference> deleteContent(ContentScope contentScope,
                                     String contentSourceId)

Deletes the content that is associated to the supplied ContentSourceId for the ContentScope.

Parameters:

contentScope - the content scope

contentSourceId - the content source id

Returns:

the list of deleted content references

Throws:

ContentException - if there is an error deleting the content

IllegalArgumentException - if the arguments are null

processContent

void processContent(ContentScope contentScope,
                    ContentProcessor contentProcessor)

Process all content in the given provider with the processor

Parameters:

contentProcessor - content processor to process content