public class MediaManager extends Manager
| Modifier and Type | Class and Description |
|---|---|
protected static class |
MediaManager.MediaManagerSerializableDTO |
Manager.GenericManagerSingletonCreator, Manager.ManagerSingletonCreator| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
BEAN_NAME
Identifier of this manager used at core-spring.xml spring configuration.
|
static java.lang.String |
MEDIACONTAINER
Deprecated.
since ages - use CoreConstants.TC.MEDIACONTAINER instead
|
static java.lang.String |
MEDIACONTEXT
Deprecated.
since ages - use CoreConstants.TC.MEDIACONTEXT instead
|
static java.lang.String |
MEDIAFOLDER
Deprecated.
since ages - use CoreConstants.TC.MEDIAFOLDER instead
|
static java.lang.String |
MEDIAFORMAT
Deprecated.
since ages - use CoreConstants.TC.MEDIAFORMAT instead
|
static java.lang.String |
MEDIAFORMATMAPPING
Deprecated.
since ages - use CoreConstants.TC.MEDIAFORMATMAPPING instead
|
static java.lang.String |
MEDIAFORMATTER
Deprecated.
since ages - use CommonsConstants.TC.MEDIAFORMATTER instead
|
static java.lang.String |
PREFERRED_URL_STRATEGY_ID |
static java.lang.String |
ROOT_FOLDER_QUALIFIER
Identifier of the root media folder created at system initialization.
|
| Constructor and Description |
|---|
MediaManager() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
checkBeforeItemRemoval(SessionContext ctx,
Item item)
Superclass method overridden to avoid call to EJB layer.
|
Media |
createMedia(PK pk,
java.lang.String code)
Creates a new media item.
|
Media |
createMedia(PK pkBase,
java.lang.String code,
ComposedType type)
Creates a new media item with a specific type.
|
Media |
createMedia(java.lang.String code)
Creates a new media item.
|
Media |
createMedia(java.lang.String code,
ComposedType type)
Creates a new media item with a specific type.
|
Media |
createMedia(java.lang.String code,
MediaFormat format)
Creates a new media with given code and format.
|
MediaContainer |
createMediaContainer(java.util.Map<java.lang.String,java.lang.Object> attributeValues)
Creates a new container with given parameters.
|
MediaContainer |
createMediaContainer(SessionContext ctx,
java.util.Map<java.lang.String,java.lang.Object> attributeValues)
Creates a new container with given parameters.
|
MediaContainer |
createMediaContainer(java.lang.String qualifier)
Creates a new container with given qualifier.
|
MediaContext |
createMediaContext(java.util.Map<java.lang.String,java.lang.Object> attributeValues)
Creates a new context with given parameters.
|
MediaContext |
createMediaContext(SessionContext ctx,
java.util.Map<java.lang.String,java.lang.Object> attributeValues)
Creates a new context with given parameters.
|
MediaContext |
createMediaContext(java.lang.String qualifier)
Creates a new context with given qualifier.
|
MediaFolder |
createMediaFolder(java.util.Map<java.lang.String,java.lang.Object> attributeValues)
Creates a new folder with given parameters.
|
MediaFolder |
createMediaFolder(SessionContext ctx,
java.util.Map<java.lang.String,java.lang.Object> attributeValues)
Creates a new folder with given parameters.
|
MediaFolder |
createMediaFolder(java.lang.String qualifier,
java.lang.String path)
Creates a new folder with given qualifier and path.
|
MediaFormat |
createMediaFormat(java.util.Map<java.lang.String,java.lang.Object> attributeValues)
Creates a new format with given parameters.
|
MediaFormat |
createMediaFormat(SessionContext ctx,
java.util.Map<java.lang.String,java.lang.Object> attributeValues)
Creates a new format with given parameters.
|
MediaFormat |
createMediaFormat(java.lang.String qualifier)
Creates a new format with given qualifier.
|
MediaFormatMapping |
createMediaFormatMapping(java.util.Map<java.lang.String,java.lang.Object> attributeValues)
Creates a new mapping with given parameters.
|
MediaFormatMapping |
createMediaFormatMapping(MediaFormat source,
MediaFormat target)
Creates a new mapping with given source and target format.
|
MediaFormatMapping |
createMediaFormatMapping(SessionContext ctx,
java.util.Map<java.lang.String,java.lang.Object> attributeValues)
Creates a new mapping with given parameters.
|
protected MediaSource |
createMediaSource(AbstractMedia media) |
void |
deleteMedia(java.lang.String folderQualifier,
java.lang.String location)
Delete media.
|
void |
deleteMediaDataUnlessReferenced(PK mediaPk,
java.lang.Long dataPk,
java.lang.String folderQualifier,
java.lang.String location)
This method deletes media data unless it is referenced by another media object.
|
java.util.Collection |
getAllMedia()
Deprecated.
since ages - use plain
FlexibleSearchService.getModelsByExample(Object) to get
a de.hybris.platform.core.model.media.MediaModels instances. See more at loading by
exemplary model. |
java.util.List<MediaContext> |
getAllMediaContexts()
Deprecated.
since ages - use plain
FlexibleSearchService.getModelsByExample(Object) to get
a MediaContexts instances. See more at loading by
exemplary model. |
java.util.Collection<MediaFolder> |
getAllMediaFolders()
Deprecated.
since ages - use plain
FlexibleSearchService.getModelsByExample(Object) to get
a MediaFolderModels instances. See more at loading by
exemplary model. |
java.util.Collection |
getAllMedias()
Deprecated.
since 'medias' is incorrect term. Please use
getAllMedia() instead. |
java.lang.String |
getBestMime(java.lang.String filePath)
Gets the best mime for provided media file path.
|
java.lang.String |
getBestMime(java.lang.String fileName,
byte[] firstBytes,
java.lang.String overrideMime)
Gets the best mime.
|
java.lang.String |
getDownloadURLForMedia(java.lang.String folderQualifier,
MediaSource mediaSource) |
java.lang.String |
getFileExtensionFromMime(java.lang.String mime)
Gets the file extension from mime.
|
static MediaManager |
getInstance()
Gets the instance of this manager.
|
byte[] |
getMediaAsByteArray(java.lang.String folderQualifier,
java.lang.String location) |
java.io.File |
getMediaAsFile(java.lang.String folderQualifier,
java.lang.String location)
This method try to return media data as
File. |
java.io.InputStream |
getMediaAsStream(MediaSource mediaSource)
Gets media as stream.
|
java.io.InputStream |
getMediaAsStream(java.lang.String folderQualifier,
java.lang.String location)
Gets the media as stream.
|
java.util.Collection |
getMediaByCode(java.lang.String searchString)
Finds all media which code matches the specified search pattern.
|
java.util.Collection |
getMediaByMimeType(java.lang.String mimePattern)
Finds all media whose mime type matches the given pattern.
|
java.util.Collection |
getMediaByURL(java.lang.String urlPattern)
Deprecated.
since ages
|
java.util.Collection |
getMediaByURLExact(java.lang.String url)
Deprecated.
since ages - use plain
FlexibleSearchService.getModelsByExample(Object) to get
a de.hybris.platform.core.model.media.MediaModels instances for a specified
de.hybris.platform.core.model.media.MediaModel.CODE. See more at loading by
exemplary model. |
java.util.Collection<MediaFolder> |
getMediaFolderByQualifier(java.lang.String searchString)
Finds all folders whose qualifier matches the specified search pattern.
|
MediaFormat |
getMediaFormatByQualifier(java.lang.String qualifier)
Gets first media format matching given qualifier.
|
MediaHeadersRegistry |
getMediaHeadersRegistry() |
java.util.Collection |
getMediasByCode(java.lang.String searchString)
Deprecated.
since 'medias' is incorrect term
|
java.util.Collection |
getMediasByMimeType(java.lang.String mimePattern)
Deprecated.
since 'medias' is incorrect term
|
MediaStorageRegistry |
getMediaStorageFactory() |
protected java.lang.String |
getMediaTypeCode()
Gets the code of the media type.
|
java.lang.String |
getMimeTypeByExtension(java.lang.String fileExtension)
Returns the MimeType for the given fileextension.
|
MediaFolder |
getOrCreateRootMediaFolder()
Gets the or create root media folder.
|
MediaFolder |
getRootMediaFolder()
Deprecated.
since ages - use
MediaService.getRootFolder() instead |
java.lang.String |
getURLForMedia(java.lang.String folderQualifier,
MediaSource mediaSource) |
boolean |
hasData(MediaSource mediaSource) |
boolean |
hasForeignDataOwners(PK mediaPk,
java.lang.Long dataPk) |
void |
initializeMediaStorage(boolean freshInit)
Executes any configured media storage initializer on initialization process.
|
boolean |
isFolderConfiguredAsSecured(java.lang.String folderQualifier) |
boolean |
isPathTargetSecuredFolder(java.lang.String folderQualifier,
java.lang.String location) |
boolean |
isSecuredFolder(java.lang.String folderQualifier) |
boolean |
isZipRelatedMime(java.lang.String mime) |
protected void |
notifyItemRemoval(SessionContext ctx,
Item item)
Superclass method overridden to avoid call to EJB layer.
|
void |
setLocalMediaFileCache(LocalMediaFileCacheService localMediaFileCache) |
void |
setLocationHashService(MediaLocationHashService locationHashService) |
void |
setMediaHeadersRegistry(MediaHeadersRegistry mediaHeadersRegistry) |
void |
setMediaStorageConfigService(MediaStorageConfigService mediaStorageConfig) |
void |
setMediaStorageRegistry(MediaStorageRegistry mediaStorageRegistry) |
void |
setMimeService(MimeService mimeService) |
StoredMediaData |
storeMedia(MediaDataStoreCommand command)
Store media.
|
void |
verifyMediaHashForLocation(java.lang.String folderQualifier,
java.lang.String location,
java.lang.String storedHash) |
java.lang.Object |
writeReplace() |
afterItemCreation, beforeItemCreation, destroy, extractNonRequiredRemoteFromItem, extractRequiredRemoteFromItem, getAllValuesSessionContext, getAttribute, getAttributeMap, getFirstItemByAttribute, getFirstItemByAttribute, getRemote, getRemoteManagerClass, getSession, getSingletonManagerInstance, getTenant, getTransientObject, getTransientObjectMap, init, setAttribute, setTenant, setTransientObject, wrappublic static final java.lang.String BEAN_NAME
@Deprecated public static final java.lang.String MEDIAFOLDER
MediaFolder type.@Deprecated public static final java.lang.String MEDIACONTAINER
MediaContainer type.@Deprecated public static final java.lang.String MEDIACONTEXT
MediaContext type.@Deprecated public static final java.lang.String MEDIAFORMAT
MediaFormat type.@Deprecated public static final java.lang.String MEDIAFORMATMAPPING
MediaFormatMapping type.@Deprecated public static final java.lang.String MEDIAFORMATTER
MediaFormatter type.public static final java.lang.String ROOT_FOLDER_QUALIFIER
public static final java.lang.String PREFERRED_URL_STRATEGY_ID
public void setMimeService(MimeService mimeService)
public void setMediaHeadersRegistry(MediaHeadersRegistry mediaHeadersRegistry)
public void setLocalMediaFileCache(LocalMediaFileCacheService localMediaFileCache)
public void setMediaStorageConfigService(MediaStorageConfigService mediaStorageConfig)
public void setMediaStorageRegistry(MediaStorageRegistry mediaStorageRegistry)
public void setLocationHashService(MediaLocationHashService locationHashService)
public MediaStorageRegistry getMediaStorageFactory()
public java.lang.String getFileExtensionFromMime(java.lang.String mime)
public java.lang.String getBestMime(java.lang.String fileName,
byte[] firstBytes,
java.lang.String overrideMime)
public java.lang.String getBestMime(java.lang.String filePath)
public boolean hasForeignDataOwners(PK mediaPk, java.lang.Long dataPk)
public StoredMediaData storeMedia(MediaDataStoreCommand command)
public void deleteMedia(java.lang.String folderQualifier,
java.lang.String location)
folderQualifier - the folder qualifierlocation - the locationpublic void deleteMediaDataUnlessReferenced(PK mediaPk, java.lang.Long dataPk, java.lang.String folderQualifier, java.lang.String location)
mediaPk - PK of the given media objectdataPk - Data PK of the given media objectfolderQualifier - Folder qualifier of the given media objectlocation - Location of media data in the storagepublic java.io.InputStream getMediaAsStream(java.lang.String folderQualifier,
java.lang.String location)
folderQualifier - the folder qualifierlocation - the locationpublic java.io.InputStream getMediaAsStream(MediaSource mediaSource)
mediaSource - Wrapper interface for the media object.public byte[] getMediaAsByteArray(java.lang.String folderQualifier,
java.lang.String location)
throws java.io.IOException
java.io.IOExceptionpublic boolean hasData(MediaSource mediaSource)
public MediaHeadersRegistry getMediaHeadersRegistry()
public boolean isZipRelatedMime(java.lang.String mime)
public void verifyMediaHashForLocation(java.lang.String folderQualifier,
java.lang.String location,
java.lang.String storedHash)
public boolean isPathTargetSecuredFolder(java.lang.String folderQualifier,
java.lang.String location)
public boolean isFolderConfiguredAsSecured(java.lang.String folderQualifier)
public java.io.File getMediaAsFile(java.lang.String folderQualifier,
java.lang.String location)
File. It may throw UnsupportedOperationException
when underlying MediaStorageStrategy does not support it.folderQualifier - the folder qualifierlocation - the locationpublic java.lang.String getURLForMedia(java.lang.String folderQualifier,
MediaSource mediaSource)
public java.lang.String getDownloadURLForMedia(java.lang.String folderQualifier,
MediaSource mediaSource)
protected MediaSource createMediaSource(AbstractMedia media)
public void initializeMediaStorage(boolean freshInit)
freshInit - determines whether it is fresh init or updatepublic boolean isSecuredFolder(java.lang.String folderQualifier)
public static MediaManager getInstance()
protected void checkBeforeItemRemoval(SessionContext ctx, Item item) throws ConsistencyCheckException
checkBeforeItemRemoval in class Managerctx - the current session contextitem - the item which should be removedConsistencyCheckException - thrown to abort removal due to consistency errorsprotected void notifyItemRemoval(SessionContext ctx, Item item)
notifyItemRemoval in class Managerctx - the currency session contextitem - the item which is going to be removedprotected java.lang.String getMediaTypeCode()
public Media createMedia(java.lang.String code)
code - code of new mediapublic Media createMedia(PK pk, java.lang.String code)
pk - the pk for the new item; it will be equipped with type code additionally (code - code of new mediapublic Media createMedia(java.lang.String code, ComposedType type)
ComposedType.newInstance(Map) to achieve attribute checks.code - the code of the new mediatype - the type of the new mediapublic Media createMedia(PK pkBase, java.lang.String code, ComposedType type)
ComposedType.newInstance(Map) to achieve attribute checks.pkBase - the pk for the new item; it will be equipped with type code additionally (code - the code of the new mediatype - the type of the new media@Deprecated public java.util.Collection getAllMedias()
getAllMedia() instead.@Deprecated public java.util.Collection getAllMedia()
FlexibleSearchService.getModelsByExample(Object) to get
a de.hybris.platform.core.model.media.MediaModels instances. See more at loading by
exemplary model.@Deprecated public java.util.Collection getMediasByCode(java.lang.String searchString)
searchString - pattern used for searchingpublic java.util.Collection getMediaByCode(java.lang.String searchString)
searchString - pattern used for searching@Deprecated public java.util.Collection getMediasByMimeType(java.lang.String mimePattern)
mimePattern - a SQL pattern for the mime typeMedia objectspublic java.util.Collection getMediaByMimeType(java.lang.String mimePattern)
mimePattern - a SQL pattern for the mime typeMedia objects@Deprecated public java.util.Collection getMediaByURL(java.lang.String urlPattern)
urlPattern - a SQL pattern for the urlMedia objects@Deprecated public java.util.Collection getMediaByURLExact(java.lang.String url)
FlexibleSearchService.getModelsByExample(Object) to get
a de.hybris.platform.core.model.media.MediaModels instances for a specified
de.hybris.platform.core.model.media.MediaModel.CODE. See more at loading by
exemplary model.url - the url media will be neededpublic java.lang.String getMimeTypeByExtension(java.lang.String fileExtension)
fileExtension - Fileextension, no dot, allowed are Lower- and Uppercases.public MediaFolder createMediaFolder(java.lang.String qualifier, java.lang.String path)
qualifier - qualifier for new folderpath - path for new folderpublic MediaFolder createMediaFolder(java.util.Map<java.lang.String,java.lang.Object> attributeValues)
attributeValues - parameters used for creationpublic MediaFolder createMediaFolder(SessionContext ctx, java.util.Map<java.lang.String,java.lang.Object> attributeValues)
attributeValues - parameters used for creationctx - session contextpublic java.util.Collection<MediaFolder> getMediaFolderByQualifier(java.lang.String searchString)
searchString - pattern used for searching the folders@Deprecated public java.util.Collection<MediaFolder> getAllMediaFolders()
FlexibleSearchService.getModelsByExample(Object) to get
a MediaFolderModels instances. See more at loading by
exemplary model.MediaFolder's in system.@Deprecated public MediaFolder getRootMediaFolder()
MediaService.getRootFolder() insteadJaloSystemException - when root media folder does not existpublic MediaFolder getOrCreateRootMediaFolder()
public MediaContainer createMediaContainer(java.lang.String qualifier)
qualifier - qualifier for new containerpublic MediaContainer createMediaContainer(java.util.Map<java.lang.String,java.lang.Object> attributeValues)
attributeValues - parameters used for creationpublic MediaContainer createMediaContainer(SessionContext ctx, java.util.Map<java.lang.String,java.lang.Object> attributeValues)
attributeValues - parameters used for creationctx - session contextpublic MediaFormat createMediaFormat(java.lang.String qualifier)
qualifier - qualifier for new formatpublic MediaFormat createMediaFormat(java.util.Map<java.lang.String,java.lang.Object> attributeValues)
attributeValues - parameters used for creationpublic MediaFormat createMediaFormat(SessionContext ctx, java.util.Map<java.lang.String,java.lang.Object> attributeValues)
attributeValues - parameters used for creationctx - session contextpublic MediaContext createMediaContext(java.lang.String qualifier)
qualifier - qualifier for new contextpublic MediaContext createMediaContext(java.util.Map<java.lang.String,java.lang.Object> attributeValues)
attributeValues - parameters used for creationpublic MediaContext createMediaContext(SessionContext ctx, java.util.Map<java.lang.String,java.lang.Object> attributeValues)
attributeValues - parameters used for creationctx - session contextpublic MediaFormatMapping createMediaFormatMapping(MediaFormat source, MediaFormat target)
source - source formattarget - target formatpublic MediaFormatMapping createMediaFormatMapping(java.util.Map<java.lang.String,java.lang.Object> attributeValues)
attributeValues - parameters used for creationpublic MediaFormatMapping createMediaFormatMapping(SessionContext ctx, java.util.Map<java.lang.String,java.lang.Object> attributeValues)
attributeValues - parameters used for creationctx - session contextpublic Media createMedia(java.lang.String code, MediaFormat format)
code - code for new mediaformat - format for new media@Deprecated public java.util.List<MediaContext> getAllMediaContexts()
FlexibleSearchService.getModelsByExample(Object) to get
a MediaContexts instances. See more at loading by
exemplary model.public MediaFormat getMediaFormatByQualifier(java.lang.String qualifier)
qualifier - qualifier a format is needed forpublic java.lang.Object writeReplace()
throws java.io.ObjectStreamException
writeReplace in class Managerjava.io.ObjectStreamExceptionCopyright © 2018 SAP SE. All Rights Reserved.