@Deprecated public interface ContentProvider
Modifier and Type | Field and Description |
---|---|
static String |
CNT_ID_DELIMITER
Deprecated.
If using content file prefixes for new content, make sure to only use this delimiter in between.
|
Modifier and Type | Method and Description |
---|---|
void |
addListener(ContentActionListener providerListener)
Deprecated.
Registers the given provider listener with the underlying content providing component/subsystem.
|
ContentReference |
createContent(ContentDefinitionId contentDefinitionId,
String contentIdPrefix,
InputStream inputStream,
Long contentLength,
ContentRelations contentRelations)
Deprecated.
Uploads new content to this content provider based on the given content definition which of course must initially being created by this same content provider.
|
void |
deleteContent(ContentReference contentReference,
ContentRelations contentRelations)
Deprecated.
Removes all content for the given reference.
|
void |
deleteContentVersion(ContentReference contentReference,
String version,
ContentRelations contentRelations)
Deprecated.
Removes the given version of the referenced content.
|
Collection<ContentReference> |
getAllContentReferences()
Deprecated.
Returns all content references known to the provider.
|
InputStream |
getContentVersion(ContentReference contentReference,
String version)
Deprecated.
Returns the content of a specific version of the referenced content object.
|
Collection<ContentDefinition> |
getDefinitions()
Deprecated.
Returns all definitions known to the provider.
|
ContentProviderId |
getId()
Deprecated.
The id of the provider.
|
InputStream |
getLatestContent(ContentReference contentReference)
Deprecated.
Returns an input stream to retrieve the content specified.
|
List<String> |
listVersions(ContentReference contentReference)
Deprecated.
Returns a list of available versions for the given referenced content object.
|
void |
removeListener(ContentActionListener providerListener)
Deprecated.
Unregisters the given provider listener from the underlying content providing subsystem.
|
void |
updateContent(ContentReference contentReference,
InputStream inputStream,
Long contentLength,
ContentRelations contentRelations)
Deprecated.
Uploads new content of an existing content object referenced by the given content reference previously retrieved by creating the content object.
|
static final String CNT_ID_DELIMITER
ContentProviderId getId()
Collection<ContentDefinition> getDefinitions()
Collection<ContentReference> getAllContentReferences()
ContentReference createContent(ContentDefinitionId contentDefinitionId, String contentIdPrefix, InputStream inputStream, Long contentLength, ContentRelations contentRelations)
contentDefinitionId
- the id of the content definition this content is based on (typically the definition contains information about the storage type, encryption,
versioning, etc needed by the provider to distinguish on how to store the content)contentIdPrefix
- the optional prefix used for the content id, this allows the provider to organize and browse keys hierarchically, similar to how a file system
organizes files into directories (might be null
), the prefix will be used to create the content id and is delimited using the CNT_ID_DELIMITER
, so
you don't have to add the delimiter after the end of the prefix, this is done by the provider automaticallyinputStream
- the input stream serving the content to be storedcontentLength
- the optional length of the content input stream, if known (if the content length is not specified, be aware as this might be resulting in out of memory
as the content might need to be buffered in order to store in the underlying provider)contentRelations
- the optional content usage parameter to be passed along to content action listeners containing information about the relation of the content to be
storedvoid updateContent(ContentReference contentReference, InputStream inputStream, Long contentLength, ContentRelations contentRelations)
contentReference
- the reference of the content to be overwritten or stored as a new content versioninputStream
- the input stream serving the content to be storedcontentLength
- the optional length of the content input stream, if known (if the content length is not specified, be aware as this might be resulting in out of memory
as the content might need to be buffered in order to store in the underlying provider)contentRelations
- the optional content usage parameter to be passed along to content action listeners containing information about the relation of the content to be
storedInputStream getLatestContent(ContentReference contentReference)
contentReference
- the content reference of the content object to return its input streamInputStream getContentVersion(ContentReference contentReference, String version)
contentReference
- the content reference of the content object to return its specific version input streamversion
- the specific version of the content to be returnedList<String> listVersions(ContentReference contentReference)
contentReference
- the referenced content object to return a list of versions forvoid deleteContent(ContentReference contentReference, ContentRelations contentRelations)
contentReference
- the reference of the content to be deletedcontentRelations
- the optional content usage parameter to be passed along to content action listeners containing information about the relation of the content to be
storedvoid deleteContentVersion(ContentReference contentReference, String version, ContentRelations contentRelations)
contentReference
- the referenced content to remove one specific version ofversion
- the version of the content to be deletedcontentRelations
- the optional content usage parameter to be passed along to content action listeners containing information about the relation of the content to be
storedvoid addListener(ContentActionListener providerListener)
providerListener
- the provider listener to be registeredvoid removeListener(ContentActionListener providerListener)
providerListener
- the provider listener to be unregisteredCopyright © 2010 - 2017 edorasware ag. All Rights Reserved.