de.hybris.platform.util

Class MediaUtil

java.lang.Object

de.hybris.platform.util.MediaUtil

public class MediaUtil
extends Object

Tools for medias

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MediaUtil.SecureMediaURLRenderer

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUSTOM_EXTENSION_PREFIX Deprecated.
static String	CUSTOM_MIMETYPE_PREFIX Deprecated.
static String	DUMMY_FILE_NAME
static String	FALLBACK_FILE_EXT Deprecated. use DefaultMimeService.FALLBACK_FILE_EXT instead.
static String	FALLBACK_MIME Deprecated. use DefaultMimeService.FALLBACK_MIME instead.
static String	FILE_SEP
static String	MEDIA_DATA_DIRS
static String	MEDIA_READ_DIR
static String	URL_HAS_DATA
static String	URL_IS_EMPTY If the URL contains this string, the URL is empty.
static String	X_ZIP_COMPRESSED_MIME Deprecated. use DefaultMimeService.X_ZIP_COMPRESSED_MIME instead.
static String	X_ZIP_MIME Deprecated. use DefaultMimeService.X_ZIP_MIME instead.
static String	ZIP_MIME Deprecated. use DefaultMimeService.ZIP_MIME instead.

Constructor Summary

Constructors

Constructor and Description
MediaUtil()

Method Summary

Modifier and Type	Method and Description
static String	addLeadingFileSepIfNeeded(String path) Adds the leading file separator to the path if it doesn't contain one already.
static String	addTrailingFileSepIfNeeded(String path) Adds the trailing file separator to the path if it doesn't contain one already.
static String	appendFileNameToDirName(String dirname, String filename)
static String	assembleSecureMediaURL(MediaSource media)
static String	calculateMimeType(String originalName, String mimeType, byte[] firstBytes) Deprecated. use MimeService.getBestMime(String, byte[], String) instead.
static File	composeOrGetParent(File parent, String child) Builds the file from parent file and child pathname which can be directory or file.
static File	concatDirectoryWithFolder(File dir, MediaFolder subFolder) Concatenates given directory with given folder.
static long	copy(InputStream is, Collection<OutputStream> os) Copy the data from the Inputstream to a Collection of Outputstreams.
static long	copy(InputStream is, Collection<OutputStream> outStreams, boolean closeOutputStreams) Copy the data from the InputStream to a Collection of OutputStreams.
static long	copy(InputStream is, OutputStream os) Copy the data from the Inputstream to the Outputstream.
static long	copy(InputStream is, OutputStream os, boolean closeOutputStream) Copy the data from the Inputstream to the Outputstream.
static void	copyMediaData(Media src, Media tgt) Deprecated. Use DefaultMediaService.moveData(de.hybris.platform.core.model.media.MediaModel, de.hybris.platform.core.model.media.MediaModel)
static MediaUtil.SecureMediaURLRenderer	getCurrentSecureMediaURLRenderer()
static File	getDataDir() Deprecated. use getLocalStorageDataDir() instead.
static List<File>	getDataDirs() Deprecated. use getLocalStorageReplicationDirs() instead.
static String	getDefaultFileExtension(String mimetype) Deprecated. configure all mime types and extensions directly in advanced.properties file and use MimeService.getFileExtensionFromMime(String) instead.
static String	getFileExtension(String filename) Returns the file name extension (lowercase) or, if no '.' is found, the whole file name (without case change).
static String	getLocalMediaWebRootUrl() Returns local media web URL root URL.
static File	getLocalStorageDataDir()
static List<File>	getLocalStorageReplicationDirs() Reads directories defined in media.replication.dirs.
static File	getMediaReadDir() Returns the media read directory.
static String	getRootURL() Deprecated. use getLocalMediaWebRootUrl() instead.
static Set	getSupportedMimeTypes() Deprecated. use MimeService instead.
static String	getSystemDir()
static File	getTenantMediaReadDir() Same as getMediaReadDir() but including the current tenant subdirectory.
static String	guess(byte[] startBytes) Deprecated. use MimeService.getMimeFromFirstBytes(byte[]) instead.
static String	guess(File file) Deprecated. use MimeService.getMimeFromFirstBytes(byte[]) instead.
static String	guess(InputStream is) Deprecated. use MimeService.getMimeFromFirstBytes(byte[]) instead.
static String	guessMimeByURLExtension(String url) Deprecated. use MimeService.getMimeFromFileExtension(String) instead.
static boolean	isCurrentRequestSSLModeEnabled()
static boolean	isFileNamePrettyURLCompatible(String realFileName)
static boolean	isZipRelatedMime(String mime) Deprecated. use MimeService.isZipRelatedMime(String) instead.
static String	normalizeRealFileName(String realFileName)
static String	removeFileExtension(String fileName)
static String	removeTrailingFileSepIfNeeded(String path) Removes trailing separator from the path if it exists.
static void	setCurrentRequestSSLModeEnabled(boolean enabled)
static void	setCurrentSecureMediaURLRenderer(MediaUtil.SecureMediaURLRenderer renderer)
static void	unsetCurrentRequestSSLModeEnabled()
static void	unsetCurrentSecureMediaURLRenderer()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

URL_IS_EMPTY

public static final String URL_IS_EMPTY

If the URL contains this string, the URL is empty. Use empty string or null. This string is put into URL, when the data is removed. BEWARE: Oracle converts empty strings to null.

URL_HAS_DATA

public static final String URL_HAS_DATA

See Also:

Constant Field Values

MEDIA_DATA_DIRS

public static final String MEDIA_DATA_DIRS

See Also:

Constant Field Values

MEDIA_READ_DIR

public static final String MEDIA_READ_DIR

See Also:

Constant Field Values

DUMMY_FILE_NAME

public static final String DUMMY_FILE_NAME

See Also:

Constant Field Values

CUSTOM_EXTENSION_PREFIX

@Deprecated
public static final String CUSTOM_EXTENSION_PREFIX

Deprecated.

See Also:

Constant Field Values

CUSTOM_MIMETYPE_PREFIX

@Deprecated
public static final String CUSTOM_MIMETYPE_PREFIX

Deprecated.

See Also:

Constant Field Values

ZIP_MIME

@Deprecated
public static final String ZIP_MIME

Deprecated. use DefaultMimeService.ZIP_MIME instead.

See Also:

Constant Field Values

X_ZIP_MIME

@Deprecated
public static final String X_ZIP_MIME

Deprecated. use DefaultMimeService.X_ZIP_MIME instead.

See Also:

Constant Field Values

X_ZIP_COMPRESSED_MIME

@Deprecated
public static final String X_ZIP_COMPRESSED_MIME

Deprecated. use DefaultMimeService.X_ZIP_COMPRESSED_MIME instead.

See Also:

Constant Field Values

FALLBACK_MIME

@Deprecated
public static final String FALLBACK_MIME

Deprecated. use DefaultMimeService.FALLBACK_MIME instead.

See Also:

Constant Field Values

FALLBACK_FILE_EXT

@Deprecated
public static final String FALLBACK_FILE_EXT

Deprecated. use DefaultMimeService.FALLBACK_FILE_EXT instead.

See Also:

Constant Field Values

FILE_SEP

public static final String FILE_SEP

See Also:

Constant Field Values

Constructor Detail

MediaUtil

public MediaUtil()

Method Detail

isCurrentRequestSSLModeEnabled

public static boolean isCurrentRequestSSLModeEnabled()

setCurrentRequestSSLModeEnabled

public static void setCurrentRequestSSLModeEnabled(boolean enabled)

unsetCurrentRequestSSLModeEnabled

public static void unsetCurrentRequestSSLModeEnabled()

setCurrentSecureMediaURLRenderer

public static void setCurrentSecureMediaURLRenderer(MediaUtil.SecureMediaURLRenderer renderer)

unsetCurrentSecureMediaURLRenderer

public static void unsetCurrentSecureMediaURLRenderer()

getCurrentSecureMediaURLRenderer

public static MediaUtil.SecureMediaURLRenderer getCurrentSecureMediaURLRenderer()

isZipRelatedMime

@Deprecated
public static boolean isZipRelatedMime(String mime)

Deprecated. use MimeService.isZipRelatedMime(String) instead.

Checks whether provided mime string is zip archive related.

assembleSecureMediaURL

public static String assembleSecureMediaURL(MediaSource media)

getMediaReadDir

public static final File getMediaReadDir()

Returns the media read directory. If not set in the configuration, a temporary directory will be returned.

Returns:

media read directory

See Also:

getTenantMediaReadDir()

getTenantMediaReadDir

public static final File getTenantMediaReadDir()

Same as getMediaReadDir() but including the current tenant subdirectory.

Returns:

media read directory including tenant subdirectory

See Also:

getMediaReadDir()

getSupportedMimeTypes

@Deprecated
public static final Set getSupportedMimeTypes()

Deprecated. use MimeService instead.

getDataDirs

@Deprecated
public static List<File> getDataDirs()

Deprecated. use getLocalStorageReplicationDirs() instead.

Reads directories media.replication.dirs

getDataDir

@Deprecated
public static File getDataDir()

Deprecated. use getLocalStorageDataDir() instead.

getLocalStorageReplicationDirs

public static List<File> getLocalStorageReplicationDirs()

Reads directories defined in media.replication.dirs. This method is called from getDataDirs when FILE mode is set

getLocalStorageDataDir

public static File getLocalStorageDataDir()

composeOrGetParent

public static File composeOrGetParent(File parent,
                                      String child)

Builds the file from parent file and child pathname which can be directory or file. If child is blank or null simply parent is returned.

getSystemDir

public static String getSystemDir()

copy

public static long copy(InputStream is,
                        OutputStream os)
                 throws IOException

Copy the data from the Inputstream to the Outputstream. The Outputstream will always be closed after. Not the Inputstream

Parameters:

is - the Inputstream

os - the Outputstream

Returns:

how many bytes where copied

Throws:

IOException - when an error in the inputstream occurs; an error in the outputstream will be catched and printed to the commandline

copy

public static long copy(InputStream is,
                        OutputStream os,
                        boolean closeOutputStream)
                 throws IOException

Copy the data from the Inputstream to the Outputstream.

Parameters:

is - the Inputstream

os - the Outputstream

closeOutputStream - set to false if the Outputstream should not be closed afterwards.

Returns:

how many bytes where copied

Throws:

IOException - when an error in the inputstream occurs; an error in the outputstream will be catched and printed to the commandline

copy

public static long copy(InputStream is,
                        Collection<OutputStream> os)
                 throws IOException

Copy the data from the Inputstream to a Collection of Outputstreams. The Outputstreams will always be closed after. Not the Inputstream

Parameters:

is - the Inputstream

os - a Collection of Outputstreams

Returns:

how many bytes where copied

Throws:

IOException - when an error in the inputstream occurs; an error in the outputstreams will be catched and printed to the commandline

copy

public static long copy(InputStream is,
                        Collection<OutputStream> outStreams,
                        boolean closeOutputStreams)
                 throws IOException

Copy the data from the InputStream to a Collection of OutputStreams. The OutputStreams will only be closed after if closeOutputStream is set to true. Not the InputStream

Parameters:

is - the InputStream

outStreams - a Collection of OutputStreams

closeOutputStreams - set to false if the OutputStream should not be closed afterwards.

Returns:

how many bytes where copied

Throws:

IOException - when an error in the input stream occurs; an error in the output streams will be caught and printed to the command line

getRootURL

@Deprecated
public static String getRootURL()

Deprecated. use getLocalMediaWebRootUrl() instead.

getLocalMediaWebRootUrl

public static String getLocalMediaWebRootUrl()

Returns local media web URL root URL. By default: /medias.

guessMimeByURLExtension

@Deprecated
public static String guessMimeByURLExtension(String url)

Deprecated. use MimeService.getMimeFromFileExtension(String) instead.

Tries to find what kind of MIME belong to given URL.

appendFileNameToDirName

public static String appendFileNameToDirName(String dirname,
                                             String filename)

calculateMimeType

@Deprecated
public static String calculateMimeType(String originalName,
                                                   String mimeType,
                                                   byte[] firstBytes)

Deprecated. use MimeService.getBestMime(String, byte[], String) instead.

guess

@Deprecated
public static String guess(File file)

Deprecated. use MimeService.getMimeFromFirstBytes(byte[]) instead.

guess

@Deprecated
public static String guess(InputStream is)
                                throws IOException

Deprecated. use MimeService.getMimeFromFirstBytes(byte[]) instead.

Throws:

IOException

guess

@Deprecated
public static String guess(byte[] startBytes)

Deprecated. use MimeService.getMimeFromFirstBytes(byte[]) instead.

getFileExtension

public static final String getFileExtension(String filename)

Returns the file name extension (lowercase) or, if no '.' is found, the whole file name (without case change).

Parameters:

filename - the file name to get extension from

normalizeRealFileName

public static String normalizeRealFileName(String realFileName)

isFileNamePrettyURLCompatible

public static boolean isFileNamePrettyURLCompatible(String realFileName)

concatDirectoryWithFolder

public static File concatDirectoryWithFolder(File dir,
                                             MediaFolder subFolder)

Concatenates given directory with given folder. Extracts the relative path from folder and adds it to the directory.

Parameters:

dir - directory

subFolder - folder whose path will be added to directory

Returns:

new concatenated directory

Since:

3.1-u4

addTrailingFileSepIfNeeded

public static String addTrailingFileSepIfNeeded(String path)

Adds the trailing file separator to the path if it doesn't contain one already.

Parameters:

path - the path

Returns:

modified path or empty string if path is null or empty

removeTrailingFileSepIfNeeded

public static String removeTrailingFileSepIfNeeded(String path)

Removes trailing separator from the path if it exists.

Parameters:

path - the path

Returns:

modified path

addLeadingFileSepIfNeeded

public static String addLeadingFileSepIfNeeded(String path)

Adds the leading file separator to the path if it doesn't contain one already.

Parameters:

path - the path

Returns:

modified path or empty string if path is null or empty

getDefaultFileExtension

@Deprecated
public static final String getDefaultFileExtension(String mimetype)

Deprecated. configure all mime types and extensions directly in advanced.properties file and use MimeService.getFileExtensionFromMime(String) instead.

Returns the default file extension depending of the given Mimetype
or NULL if the mimetype is unknown.

Parameters:

mimetype - The mimetype you request the default file extension for (e.g. 'image/jpeg' or 'audio/x-realaudio')

Returns:

The default file extension depending of the given Mimetype or NULL if the mimetype is unknown.

copyMediaData

@Deprecated
public static void copyMediaData(Media src,
                                             Media tgt)

Deprecated. Use DefaultMediaService.moveData(de.hybris.platform.core.model.media.MediaModel, de.hybris.platform.core.model.media.MediaModel)

removeFileExtension

public static String removeFileExtension(String fileName)