Package io.wcm.handler.media

Class MediaRequest

java.lang.Object

io.wcm.handler.media.MediaRequest

@ProviderType
public final class MediaRequest
extends java.lang.Object

Holds all properties that are part of a media handling request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MediaRequest.MediaPropertyNames	Defines property names to read media parameters from for this media request.

Constructor Summary

Constructors

Constructor	Description
MediaRequest(@NotNull org.apache.sling.api.resource.Resource resource, @Nullable MediaArgs mediaArgs)
MediaRequest(@Nullable java.lang.String mediaRef, @Nullable MediaArgs mediaArgs)
MediaRequest(@Nullable org.apache.sling.api.resource.Resource resource, @Nullable java.lang.String mediaRef, @Nullable MediaArgs mediaArgs, @Nullable MediaRequest.MediaPropertyNames mediaPropertyNames)

Method Summary

Modifier and Type	Method	Description
@NotNull MediaArgs	getMediaArgs()
@NotNull MediaRequest.MediaPropertyNames	getMediaPropertyNames()
@Nullable java.lang.String	getMediaRef()
@Nullable org.apache.sling.api.resource.Resource	getResource()
@NotNull org.apache.sling.api.resource.ValueMap	getResourceProperties()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaRequest

public MediaRequest(@NotNull
                    @NotNull org.apache.sling.api.resource.Resource resource,
                    @Nullable
                    @Nullable MediaArgs mediaArgs)

Parameters:

resource - Resource containing reference to media asset

mediaArgs - Additional arguments affection media resolving

MediaRequest

public MediaRequest(@Nullable
                    @Nullable java.lang.String mediaRef,
                    @Nullable
                    @Nullable MediaArgs mediaArgs)

Parameters:

mediaRef - Reference to media item

mediaArgs - Additional arguments affection media resolving

MediaRequest

public MediaRequest(@Nullable
                    @Nullable org.apache.sling.api.resource.Resource resource,
                    @Nullable
                    @Nullable java.lang.String mediaRef,
                    @Nullable
                    @Nullable MediaArgs mediaArgs,
                    @Nullable
                    @Nullable MediaRequest.MediaPropertyNames mediaPropertyNames)

Parameters:

resource - Resource containing reference to media asset

mediaRef - Reference to media item

mediaArgs - Additional arguments affection media resolving

mediaPropertyNames - Defines property names to read media parameters from for this media request.

Method Detail

getResource

@Nullable
public @Nullable org.apache.sling.api.resource.Resource getResource()

Returns:

Resource containing reference to media asset

getMediaRef

@Nullable
public @Nullable java.lang.String getMediaRef()

Returns:

Reference to media item

getMediaArgs

@NotNull
public @NotNull MediaArgs getMediaArgs()

Returns:

Additional arguments affection media resolving

getMediaPropertyNames

@NotNull
public @NotNull MediaRequest.MediaPropertyNames getMediaPropertyNames()

Returns:

Defines property names to read media parameters from for this media request.

getResourceProperties

@NotNull
public @NotNull org.apache.sling.api.resource.ValueMap getResourceProperties()

Returns:

Properties from resource containing target link. The value map is a copy of the original map so it is safe to change the property values contained in the map.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object