de.hybris.platform.cmswebservices.media.controller

Class CatalogVersionMediaController

java.lang.Object

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

public class CatalogVersionMediaController
extends Object

Controller that provides media.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MEDIA_URI_PATH

Constructor Summary

Constructors

Constructor and Description
CatalogVersionMediaController()

Method Summary

Modifier and Type	Method and Description
MediaFileDto	getFile(MultipartFile file) Create a new media file DTO from the MultipartFile
protected LocationHeaderResource	getLocationHeaderResource()
MediaData	getMedia(HttpServletRequest request) Create a new media DTO from request parameters.
MediaData	getMediaByCode(HttpServletRequest request) Get a media by code.
MediaFacade	getMediaFacade()
protected Optional<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	setLocationHeaderResource(LocationHeaderResource locationHeaderResource)
void	setMediaFacade(MediaFacade mediaFacade)
MediaData	uploadMultipartMedia(String catalogId, 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 String MEDIA_URI_PATH

See Also:

Constant Field Values

Constructor Detail

CatalogVersionMediaController

public CatalogVersionMediaController()

Method Detail

uploadMultipartMedia

public MediaData uploadMultipartMedia(String catalogId,
                                      String versionId,
                                      MediaData media,
                                      MultipartFile multiPart,
                                      HttpServletRequest request,
                                      HttpServletResponse response)
                               throws 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:

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

Get a media by code. The resource will accept any GET ../media/**, which includes paths and image extensions at the end. To allow this resource to accept any image extension like .jpg, .gif, .png, Spring MVC needs to be configured accordingly. See spring mvc configuration <mvc:annotation-driven content-negotiation-manager="contentNegotiationManager"> where org.springframework.web.accept.ContentNegotiationManagerFactoryBean.favorPathExtension = false

Returns:

the Media item matching the code

Throws:

MediaNotFoundException - When the media code requested cannot be found.

parseMediaCode

protected Optional<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

public MediaData getMedia(HttpServletRequest request)

Create a new media DTO from request parameters.

Parameters:

request - - the http servlet request

Returns:

a media DTO

getFile

public MediaFileDto getFile(MultipartFile file)
                     throws IOException

Create a new media file DTO from the MultipartFile

Parameters:

file - - a Spring MultipartFile

Returns:

a media file DTO

Throws:

IOException - when an error occurs retrieving the input stream from the multi part file

getMediaFacade

public MediaFacade getMediaFacade()

setMediaFacade

public void setMediaFacade(MediaFacade mediaFacade)

getLocationHeaderResource

protected LocationHeaderResource getLocationHeaderResource()

setLocationHeaderResource

public void setLocationHeaderResource(LocationHeaderResource locationHeaderResource)