Package io.wcm.handler.mediasource.dam

Class DamMediaSource

java.lang.Object

io.wcm.handler.media.spi.MediaSource

io.wcm.handler.mediasource.dam.DamMediaSource

@Model(adaptables={org.apache.sling.api.SlingHttpServletRequest.class,org.apache.sling.api.resource.Resource.class})
@ProviderType
public final class DamMediaSource
extends MediaSource

Default implementation for media requests to media items stored in AEM Assets (DAM).

Field Summary

Fields

Modifier and Type	Field	Description
static @NotNull java.lang.String	ID	Media source ID

Constructor Summary

Constructors

Constructor	Description
DamMediaSource()

Method Summary

Modifier and Type	Method	Description
boolean	accepts(@Nullable java.lang.String mediaRef)	Checks whether a media request string can be handled by this media source
void	enableMediaDrop(@NotNull io.wcm.handler.commons.dom.HtmlElement element, @NotNull MediaRequest mediaRequest)	Create a drop area for given HTML element to enable drag and drop of DAM assets from content finder to this element.
@NotNull java.lang.String	getId()
@NotNull java.lang.String	getPrimaryMediaRefProperty()
@NotNull Media	resolveMedia(@NotNull Media media)	Resolves a media request
void	setCustomIPECropRatios(@NotNull io.wcm.handler.commons.dom.HtmlElement element, @NotNull MediaRequest mediaRequest)	Sets list of cropping ratios to a list matching the selected media formats.
java.lang.String	toString()

Methods inherited from class io.wcm.handler.media.spi.MediaSource

accepts, getMediaCropDimension, getMediaCropProperty, getMediaMap, getMediaMapProperty, getMediaRef, getMediaRefProperty, getMediaRotation, getMediaRotationProperty, resolveRenditions, updateMediaArgsFromResource

Methods inherited from class java.lang.Object

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

Field Detail

ID

@NotNull
public static final @NotNull java.lang.String ID

Media source ID

See Also:

Constant Field Values

Constructor Detail

DamMediaSource

public DamMediaSource()

Method Detail

getId

@NotNull
public @NotNull java.lang.String getId()

Specified by:

getId in class MediaSource

Returns:

Media source ID

accepts

public boolean accepts(@Nullable
                       @Nullable java.lang.String mediaRef)

Description copied from class: MediaSource

Checks whether a media request string can be handled by this media source

Specified by:

accepts in class MediaSource

Parameters:

mediaRef - Media request string

Returns:

true if this media source can handle the given media request

getPrimaryMediaRefProperty

@NotNull
public @NotNull java.lang.String getPrimaryMediaRefProperty()

Specified by:

getPrimaryMediaRefProperty in class MediaSource

Returns:

Name of the property in which the primary media request is stored

resolveMedia

@NotNull
public @NotNull Media resolveMedia(@NotNull
                                   @NotNull Media media)

Description copied from class: MediaSource

Resolves a media request

Specified by:

resolveMedia in class MediaSource

Parameters:

media - Media metadata

Returns:

Resolved media metadata. Never null.

enableMediaDrop

public void enableMediaDrop(@NotNull
                            @NotNull io.wcm.handler.commons.dom.HtmlElement element,
                            @NotNull
                            @NotNull MediaRequest mediaRequest)

Description copied from class: MediaSource

Create a drop area for given HTML element to enable drag and drop of DAM assets from content finder to this element.

Specified by:

enableMediaDrop in class MediaSource

Parameters:

element - Html element

mediaRequest - Media request to detect media args and property names

setCustomIPECropRatios

public void setCustomIPECropRatios(@NotNull
                                   @NotNull io.wcm.handler.commons.dom.HtmlElement element,
                                   @NotNull
                                   @NotNull MediaRequest mediaRequest)

Description copied from class: MediaSource

Sets list of cropping ratios to a list matching the selected media formats.

Overrides:

setCustomIPECropRatios in class MediaSource

Parameters:

element - Html element

mediaRequest - Media request to detect media args and property names

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object