de.hybris.platform.util

Class MediaUtil

java.lang.Object

de.hybris.platform.util.MediaUtil

public class MediaUtil
extends java.lang.Object

Tools for medias

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MediaUtil.PublicMediaURLRenderer
static interface	MediaUtil.SecureMediaURLRenderer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DUMMY_FILE_NAME
static java.lang.String	FILE_SEP
static java.lang.String	MEDIA_DATA_DIRS
static java.lang.String	MEDIA_READ_DIR
static java.lang.String	URL_HAS_DATA
static java.lang.String	URL_IS_EMPTY If the URL contains this string, the URL is empty.

Constructor Summary

Constructors

Constructor and Description
MediaUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addLeadingFileSepIfNeeded(java.lang.String path) Adds the leading file separator to the path if it doesn't contain one already.
static java.lang.String	addTrailingFileSepIfNeeded(java.lang.String path) Adds the trailing file separator to the path if it doesn't contain one already.
static java.lang.String	appendFileNameToDirName(java.lang.String dirname, java.lang.String filename)
static java.lang.String	assemblePublicMediaURL(java.lang.String rawUrl)
static java.lang.String	assembleSecureMediaURL(MediaSource media)
static java.io.File	composeOrGetParent(java.io.File parent, java.lang.String child) Builds the file from parent file and child pathname which can be directory or file.
static java.io.File	concatDirectoryWithFolder(java.io.File dir, MediaFolder subFolder) Concatenates given directory with given folder.
static long	copy(java.io.InputStream is, java.util.Collection<java.io.OutputStream> os) Copy the data from the Inputstream to a Collection of Outputstreams.
static long	copy(java.io.InputStream is, java.util.Collection<java.io.OutputStream> outStreams, boolean closeOutputStreams) Copy the data from the InputStream to a Collection of OutputStreams.
static long	copy(java.io.InputStream is, java.io.OutputStream os) Copy the data from the Inputstream to the Outputstream.
static long	copy(java.io.InputStream is, java.io.OutputStream os, boolean closeOutputStream) Copy the data from the Inputstream to the Outputstream.
static void	copyMediaData(Media src, Media tgt) Deprecated. since ages - Use DefaultMediaService.moveData(de.hybris.platform.core.model.media.MediaModel, de.hybris.platform.core.model.media.MediaModel)
static MediaUtil.PublicMediaURLRenderer	getCurrentPublicMediaURLRenderer()
static MediaUtil.SecureMediaURLRenderer	getCurrentSecureMediaURLRenderer()
static java.lang.String	getFileExtension(java.lang.String filename) Returns the file name extension (lowercase) or, if no '.' is found, the whole file name (without case change).
static java.lang.String	getLocalMediaWebRootUrl() Returns local media web URL root URL.
static java.io.File	getLocalStorageDataDir()
static java.util.List<java.io.File>	getLocalStorageReplicationDirs() Reads directories defined in media.replication.dirs.
static java.io.File	getMediaReadDir() Returns the media read directory.
static java.lang.String	getSystemDir()
static java.io.File	getTenantMediaReadDir() Same as getMediaReadDir() but including the current tenant subdirectory.
static boolean	isCurrentRequestSSLModeEnabled()
static boolean	isFileNamePrettyURLCompatible(java.lang.String realFileName)
static boolean	isZipRelatedMime(java.lang.String mime) Deprecated. since ages - useMimeService.isZipRelatedMime(String) instead.
static java.lang.String	normalizeRealFileName(java.lang.String realFileName)
static java.lang.String	removeFileExtension(java.lang.String fileName)
static java.lang.String	removeLeadingFileSepIfNeeded(java.lang.String path) Removes leading separator from the path if exists.
static java.lang.String	removeTrailingFileSepIfNeeded(java.lang.String path) Removes trailing separator from the path if it exists.
static void	setCurrentPublicMediaURLRenderer(MediaUtil.PublicMediaURLRenderer renderer)
static void	setCurrentRequestSSLModeEnabled(boolean enabled)
static void	setCurrentSecureMediaURLRenderer(MediaUtil.SecureMediaURLRenderer renderer)
static void	unsetCurrentPublicMediaURLRenderer()
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 java.lang.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 java.lang.String URL_HAS_DATA

See Also:

Constant Field Values

MEDIA_DATA_DIRS

public static final java.lang.String MEDIA_DATA_DIRS

See Also:

Constant Field Values

MEDIA_READ_DIR

public static final java.lang.String MEDIA_READ_DIR

See Also:

Constant Field Values

DUMMY_FILE_NAME

public static final java.lang.String DUMMY_FILE_NAME

See Also:

Constant Field Values

FILE_SEP

public static final java.lang.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()

setCurrentPublicMediaURLRenderer

public static void setCurrentPublicMediaURLRenderer(MediaUtil.PublicMediaURLRenderer renderer)

unsetCurrentPublicMediaURLRenderer

public static void unsetCurrentPublicMediaURLRenderer()

getCurrentPublicMediaURLRenderer

public static MediaUtil.PublicMediaURLRenderer getCurrentPublicMediaURLRenderer()

isZipRelatedMime

@Deprecated
public static boolean isZipRelatedMime(java.lang.String mime)

Deprecated. since ages - useMimeService.isZipRelatedMime(String) instead.

Checks whether provided mime string is zip archive related.

assembleSecureMediaURL

public static java.lang.String assembleSecureMediaURL(MediaSource media)

assemblePublicMediaURL

public static java.lang.String assemblePublicMediaURL(java.lang.String rawUrl)

getMediaReadDir

public static final java.io.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 java.io.File getTenantMediaReadDir()

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

Returns:

media read directory including tenant subdirectory

See Also:

getMediaReadDir()

getLocalStorageReplicationDirs

public static java.util.List<java.io.File> getLocalStorageReplicationDirs()

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

getLocalStorageDataDir

public static java.io.File getLocalStorageDataDir()

composeOrGetParent

public static java.io.File composeOrGetParent(java.io.File parent,
                                              java.lang.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 java.lang.String getSystemDir()

copy

public static long copy(java.io.InputStream is,
                        java.io.OutputStream os)
                 throws java.io.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:

java.io.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(java.io.InputStream is,
                        java.io.OutputStream os,
                        boolean closeOutputStream)
                 throws java.io.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:

java.io.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(java.io.InputStream is,
                        java.util.Collection<java.io.OutputStream> os)
                 throws java.io.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:

java.io.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(java.io.InputStream is,
                        java.util.Collection<java.io.OutputStream> outStreams,
                        boolean closeOutputStreams)
                 throws java.io.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:

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

getLocalMediaWebRootUrl

public static java.lang.String getLocalMediaWebRootUrl()

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

appendFileNameToDirName

public static java.lang.String appendFileNameToDirName(java.lang.String dirname,
                                                       java.lang.String filename)

getFileExtension

public static final java.lang.String getFileExtension(java.lang.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 java.lang.String normalizeRealFileName(java.lang.String realFileName)

isFileNamePrettyURLCompatible

public static boolean isFileNamePrettyURLCompatible(java.lang.String realFileName)

concatDirectoryWithFolder

public static java.io.File concatDirectoryWithFolder(java.io.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 java.lang.String addTrailingFileSepIfNeeded(java.lang.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 java.lang.String removeTrailingFileSepIfNeeded(java.lang.String path)

Removes trailing separator from the path if it exists.

Parameters:

path - the path

Returns:

modified path

removeLeadingFileSepIfNeeded

public static java.lang.String removeLeadingFileSepIfNeeded(java.lang.String path)

Removes leading separator from the path if exists.

Parameters:

path - the path

Returns:

modified path

addLeadingFileSepIfNeeded

public static java.lang.String addLeadingFileSepIfNeeded(java.lang.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

copyMediaData

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

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

removeFileExtension

public static java.lang.String removeFileExtension(java.lang.String fileName)