net.sourceforge.openutils.mgnlmedia.media.types
Interface MediaTypeHandler

All Known Implementing Classes:

AudioTypeHandler, BaseTypeHandler, BaseVideoTypeHandler, DocumentTypeHandler, ExternalVideoTypeHandler, ImageTypeHandler, MediaWithPreviewImageTypeHandler, SwfTypeHandler, VideoTypeHandler, YouTubeVideoTypeHandler

public interface MediaTypeHandler

Media Type Handler Interface

Version:

$Id: MediaTypeHandler.java 3269 2011-01-23 19:06:39Z fgiust $

Author:

molaschi

Field Summary

static String	METADATA_BITDEPTH
static String	METADATA_DURATION
static String	METADATA_EXTENSION
static String	METADATA_FRAMERATE
static String	METADATA_HEIGHT
static String	METADATA_NAME
static String	METADATA_SIZE
static String	METADATA_WIDTH

Method Summary

String	getAbstract(info.magnolia.cms.core.Content media) return abstract
String	getDescription(info.magnolia.cms.core.Content media) return description
String	getExtension(info.magnolia.cms.core.Content media) return filename
String	getFilename(info.magnolia.cms.core.Content media) return filename
String	getFullFilename(info.magnolia.cms.core.Content media) return filename
Map<String,String>	getMediaInfo(info.magnolia.cms.core.Content media) Returns the basic media info (file type, size for images, ...)
String	getNewNodeName(info.magnolia.cms.beans.runtime.MultipartForm form, javax.servlet.http.HttpServletRequest request) Get the name for a new node
String	getPreviewImageNodeDataName() Get the name of the nodedata for the image used for preview
String	getPreviewUrl(info.magnolia.cms.core.Content media) return thumbnail absolute url
String	getTags(info.magnolia.cms.core.Content media) return tags
String	getThumbnailUrl(info.magnolia.cms.core.Content media) return thumbnail absolute url
String	getTitle(info.magnolia.cms.core.Content media) return title
String	getUrl(info.magnolia.cms.core.Content media) return thumbnail absolute url
String	getUrl(info.magnolia.cms.core.Content media, Map<String,String> options)
void	init(info.magnolia.cms.core.Content typeDefinitionNode) init handler
boolean	isExternal(info.magnolia.cms.core.Content media) return true if media has no binary-data
boolean	onPostSave(info.magnolia.cms.core.Content media) Called from dialog when saving a media
boolean	onSavingPropertyMedia(info.magnolia.cms.core.Content media, info.magnolia.cms.core.Content parentNode, info.magnolia.cms.core.Content configNode, String name, javax.servlet.http.HttpServletRequest request, info.magnolia.cms.beans.runtime.MultipartForm form, int type, int valueType, int isRichEditValue, int encoding) Called when a media is going to be associated with a node
void	saveFromZipFile(info.magnolia.cms.core.Content media, File f, String cleanFileName, String extension) save a media file to a newly created media content
void	stop() Notify module stopping to handler

Field Detail

METADATA_NAME

static final String METADATA_NAME

See Also:

Constant Field Values

METADATA_WIDTH

static final String METADATA_WIDTH

See Also:

Constant Field Values

METADATA_HEIGHT

static final String METADATA_HEIGHT

See Also:

Constant Field Values

METADATA_BITDEPTH

static final String METADATA_BITDEPTH

See Also:

Constant Field Values

METADATA_DURATION

static final String METADATA_DURATION

See Also:

Constant Field Values

METADATA_FRAMERATE

static final String METADATA_FRAMERATE

See Also:

Constant Field Values

METADATA_EXTENSION

static final String METADATA_EXTENSION

See Also:

Constant Field Values

METADATA_SIZE

static final String METADATA_SIZE

See Also:

Constant Field Values

Method Detail

init

void init(info.magnolia.cms.core.Content typeDefinitionNode)

init handler

Parameters:

typeDefinitionNode - type definition node

isExternal

boolean isExternal(info.magnolia.cms.core.Content media)

return true if media has no binary-data

Parameters:

media - media

Returns:

true if media has no binary-data

getUrl

String getUrl(info.magnolia.cms.core.Content media)

return thumbnail absolute url

Parameters:

media - media

Returns:

url

getUrl

String getUrl(info.magnolia.cms.core.Content media,
              Map<String,String> options)

Parameters:

media -

options -

Returns:

url

getThumbnailUrl

String getThumbnailUrl(info.magnolia.cms.core.Content media)

return thumbnail absolute url

Parameters:

media - media

Returns:

url

getPreviewUrl

String getPreviewUrl(info.magnolia.cms.core.Content media)

return thumbnail absolute url

Parameters:

media - media

Returns:

url

getFilename

String getFilename(info.magnolia.cms.core.Content media)

return filename

Parameters:

media - media

Returns:

filename

getExtension

String getExtension(info.magnolia.cms.core.Content media)

return filename

Parameters:

media - media

Returns:

filename

getFullFilename

String getFullFilename(info.magnolia.cms.core.Content media)

return filename

Parameters:

media - media

Returns:

filename

getTitle

String getTitle(info.magnolia.cms.core.Content media)

return title

Parameters:

media - media

Returns:

title

getTags

String getTags(info.magnolia.cms.core.Content media)

return tags

Parameters:

media - media

Returns:

tags

getDescription

String getDescription(info.magnolia.cms.core.Content media)

return description

Parameters:

media - media

Returns:

description

getAbstract

String getAbstract(info.magnolia.cms.core.Content media)

return abstract

Parameters:

media - media

Returns:

abstract

getMediaInfo

Map<String,String> getMediaInfo(info.magnolia.cms.core.Content media)

Returns the basic media info (file type, size for images, ...)

Parameters:

media - media

Returns:

a formatted string for media info

onPostSave

boolean onPostSave(info.magnolia.cms.core.Content media)

Called from dialog when saving a media

Parameters:

media - media saving

Returns:

true if continue saving

getNewNodeName

String getNewNodeName(info.magnolia.cms.beans.runtime.MultipartForm form,
                      javax.servlet.http.HttpServletRequest request)

Get the name for a new node

Parameters:

form - multipart form

request - current request

Returns:

new name

getPreviewImageNodeDataName

String getPreviewImageNodeDataName()

Get the name of the nodedata for the image used for preview

Returns:

the name of the nodedata for the image used for preview

onSavingPropertyMedia

boolean onSavingPropertyMedia(info.magnolia.cms.core.Content media,
                              info.magnolia.cms.core.Content parentNode,
                              info.magnolia.cms.core.Content configNode,
                              String name,
                              javax.servlet.http.HttpServletRequest request,
                              info.magnolia.cms.beans.runtime.MultipartForm form,
                              int type,
                              int valueType,
                              int isRichEditValue,
                              int encoding)
                              throws javax.jcr.RepositoryException,
                                     info.magnolia.cms.security.AccessDeniedException

Called when a media is going to be associated with a node

Parameters:

media - media

parentNode - node to be associated

configNode - configuration node

name - property name

request - current request

form - request form

type - typee

valueType - value type

isRichEditValue - is rich edit

encoding - encoding

Returns:

true on success

Throws:

javax.jcr.RepositoryException - repository exception

info.magnolia.cms.security.AccessDeniedException - access denied exception

saveFromZipFile

void saveFromZipFile(info.magnolia.cms.core.Content media,
                     File f,
                     String cleanFileName,
                     String extension)
                     throws info.magnolia.cms.security.AccessDeniedException,
                            javax.jcr.RepositoryException

save a media file to a newly created media content

Parameters:

media - media content to save to

f - file input stream

cleanFileName - file name without extension

extension - file extension

Throws:

javax.jcr.RepositoryException - exception working on repository

info.magnolia.cms.security.AccessDeniedException - exception accessing node

stop

void stop()

Notify module stopping to handler