|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DigitalAssetResourceManagerPlugin
DigitalAssetResourceManagerPlugin provides an interface for a given Digital Asset Manager that wishes to provide the management capabilities for files/images within WCM.
If a plugin is defined within the system and enabled, WCM will call to this plugin to retrieve digital asset and to associate/bind a WCM resource with a given DAM resource.
A DigitalAssetResourceManagerPlugin can be registered with WCM by using the Eclipse extension support and defining an
extension point for the com.ibm.workplace.wcm.api.extensions.DigitalAssetResourceManagerPlugin
extension.
Method Summary | |
---|---|
boolean |
canHandle(DigitalAssetID id)
Determines if this plugin supports/handles DigitalAssets associated with the provided DigitalAssetID. |
boolean |
canHandle(java.lang.String digitalAssetID)
Determines if this plugin supports/handles DigitalAssets associated with the provided DigitalAssetID/selection token. |
DigitalAsset |
consumeSelectedAsset(java.lang.String digitalAssetPath,
DigitalAsset asset)
Consumes a selected asset. |
DigitalAssetID |
createDigitalAssetID(DigitalAsset asset)
Creates a DigitalAssetID for the given DigitalAsset |
java.io.InputStream |
getAssetInputStream(DigitalAsset asset)
Gets InputStrem to the given DigitalAsset. |
DigitalAssetResourceSerializer |
getDigitalAssetResourceSerializer()
Serializer object to allow a DigitalAssetID and DigitalAssetMetaData to be serialized to and from Strings. |
java.lang.String |
getName()
Provides the Name of the plugin |
java.lang.String |
getProviderName()
Provides the Provider/Company name for the DAM |
java.lang.String |
getRenderableDigitalAssetURLString(DigitalAsset da)
Return a URL or PoC URI string the asset represented by the provided DigitalAsset. |
java.lang.String |
getRenderableRenditionNameString(java.lang.String rendPath)
Returns the short name of the rendition resource |
java.lang.String |
getRenderableRenditionURLString(java.lang.String rendPath)
Returns the renditions URL. |
java.io.InputStream |
getRenditionInputStream(java.lang.String renditionPath)
Gets InputStrem to the given Rendition. |
boolean |
supportsInputStream()
Check if the provider supports InputStreams and the getAssetInputStream(DigitalAsset) method. |
boolean |
supportsType(java.lang.Class<? extends Resource> resourceType)
Check if the provider supports the given resource type. |
Method Detail |
---|
java.lang.String getName()
java.lang.String getProviderName()
java.lang.String getRenderableDigitalAssetURLString(DigitalAsset da)
For example, This URL/URI may be used in rendering the resource/asset in a IMG tag.
da
- - the DigitalAsset of the asset WCM wishes to obtain the URL for.
DigitalAssetID createDigitalAssetID(DigitalAsset asset)
asset
- - asset for which an ID is needed.
java.io.InputStream getAssetInputStream(DigitalAsset asset) throws DigitalAssetException, com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
supportsInputStream()
if the provider does support input streams.
asset
- - DigitalAsset the InputStream is to be retrieved for
DigitalAssetException
- - thrown if any exception occurred getting the InputStream
com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
- if the file cannot be retrieved, or provider does not
support input streams.DigitalAsset consumeSelectedAsset(java.lang.String digitalAssetPath, DigitalAsset asset) throws DigitalAssetException
The token parameter is the string provided by the chooser plugin when an asset is selected
digitalAssetPath
- - selected path of a DigitalAssetasset
- - the current DigitalAsset into which the selected asset should be consumed into.
DigitalAssetException
- - thrown if any exception occurred getting the InputStreamboolean canHandle(DigitalAssetID id)
id
- - DigitalAssetID associated with a DigitalAsset
boolean canHandle(java.lang.String digitalAssetID)
The supplied digitalAssetID
may be of 2 forms.
digitalAssetID
- the serialized ID or selectedToken to be checked
DigitalAssetResourceSerializer getDigitalAssetResourceSerializer()
boolean supportsType(java.lang.Class<? extends Resource> resourceType)
resourceType
- - the resource type to check for
boolean supportsInputStream()
getAssetInputStream(DigitalAsset)
method.
java.io.InputStream getRenditionInputStream(java.lang.String renditionPath)
supportsInputStream()
renditionPath
- - Rendition the InputStream is to be retrieved
java.lang.String getRenderableRenditionURLString(java.lang.String rendPath)
rendPath
- the DAM's path to the given rendition
java.lang.String getRenderableRenditionNameString(java.lang.String rendPath)
rendPath
- the DAM's path to the given rendition
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |