de.hybris.platform.cmswebservices.media.controller

Class CatalogVersionMediaController

java.lang.Object

de.hybris.platform.cmswebservices.media.controller.CatalogVersionMediaController

public class CatalogVersionMediaController
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MEDIA_URI_PATH

Constructor Summary

Constructors

Constructor and Description
CatalogVersionMediaController()

Method Summary

Modifier and Type	Method and Description
protected DataMapper	getDataMapper()
MediaFileDto	getFile(MultipartFile file, java.io.InputStream inputStream) Create a new media file DTO from the MultipartFile.
protected LocationHeaderResource	getLocationHeaderResource()
MediaData	getMedia(HttpServletRequest request) Deprecated. since 6.4, method no longer used
MediaData	getMediaByCode(HttpServletRequest request)
protected MediaFacade	getMediaFacade()
protected java.util.Optional<java.lang.String>	parseMediaCode(HttpServletRequest request) Parses the Request URI after the Media code, which is defined by everything after the /media less the first '/', if present.
void	setDataMapper(DataMapper dataMapper)
void	setLocationHeaderResource(LocationHeaderResource locationHeaderResource)
void	setMediaFacade(MediaFacade mediaFacade)
MediaData	uploadMultipartMedia(java.lang.String catalogId, java.lang.String versionId, MediaData media, MultipartFile multiPart, HttpServletRequest request, HttpServletResponse response) Upload a media.

Methods inherited from class java.lang.Object

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

Field Detail

MEDIA_URI_PATH

public static final java.lang.String MEDIA_URI_PATH

See Also:

Constant Field Values

Constructor Detail

CatalogVersionMediaController

public CatalogVersionMediaController()

Method Detail

uploadMultipartMedia

public MediaData uploadMultipartMedia(java.lang.String catalogId,
                                      java.lang.String versionId,
                                      MediaData media,
                                      MultipartFile multiPart,
                                      HttpServletRequest request,
                                      HttpServletResponse response)
                               throws java.io.IOException,
                                      WebserviceValidationException

Upload a media.

Parameters:

catalogId - the unique identifier of the catalog for which to link the new media.

versionId - the specific catalog version to which the new media will be associated to.

media - the MediaData containing the data for the associated media item to be created.

multiPart - the file that was uploaded for the new media.

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

the newly created Media item

Throws:

java.io.IOException - when an error occurs parsing the MultipartFile

WebserviceValidationException - when the media query parameters provided contain validation errors

getMediaByCode

public MediaData getMediaByCode(HttpServletRequest request)
                         throws MediaNotFoundException

Throws:

MediaNotFoundException

parseMediaCode

protected java.util.Optional<java.lang.String> parseMediaCode(HttpServletRequest request)

Parses the Request URI after the Media code, which is defined by everything after the /media less the first '/', if present.

Parameters:

request - the http servlet request

Returns:

an optional object to hold the parsed media code

getMedia

@Deprecated
public MediaData getMedia(HttpServletRequest request)

Deprecated. since 6.4, method no longer used

Create a new media DTO from request parameters.

Parameters:

request - - the http servlet request

Returns:

a media DTO

getFile

public MediaFileDto getFile(MultipartFile file,
                            java.io.InputStream inputStream)

Create a new media file DTO from the MultipartFile.

Parameters:

file - - a Spring MultipartFile

inputStream - - an input stream used to read the file

Returns:

a media file DTO

getMediaFacade

protected MediaFacade getMediaFacade()

setMediaFacade

public void setMediaFacade(MediaFacade mediaFacade)

getLocationHeaderResource

protected LocationHeaderResource getLocationHeaderResource()

setLocationHeaderResource

public void setLocationHeaderResource(LocationHeaderResource locationHeaderResource)

getDataMapper

protected DataMapper getDataMapper()

setDataMapper

public void setDataMapper(DataMapper dataMapper)