Package io.wcm.handler.media

Class MediaRequest

java.lang.Object

io.wcm.handler.media.MediaRequest

@ProviderType
public final class MediaRequest
extends 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 String mediaRef, @Nullable MediaArgs mediaArgs)
MediaRequest(@NotNull org.apache.sling.api.resource.Resource resource, @Nullable MediaArgs mediaArgs)
MediaRequest(@Nullable org.apache.sling.api.resource.Resource resource, @Nullable String mediaRef, @Nullable MediaArgs mediaArgs, @Nullable MediaRequest.MediaPropertyNames mediaPropertyNames)
MediaRequest(@Nullable org.apache.sling.api.resource.Resource resource, @Nullable String mediaRef, @Nullable MediaArgs mediaArgs, @Nullable String refProperty, @Nullable String cropProperty)	Deprecated. Use MediaRequest(Resource, String, MediaArgs, MediaPropertyNames)
MediaRequest(@Nullable org.apache.sling.api.resource.Resource resource, @Nullable String mediaRef, @Nullable MediaArgs mediaArgs, @Nullable String refProperty, @Nullable String cropProperty, @Nullable String rotationProperty)	Deprecated. Use MediaRequest(Resource, String, MediaArgs, MediaPropertyNames)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getCropProperty()	Deprecated. Please use getMediaPropertyNames().
@NotNull MediaArgs	getMediaArgs()
@NotNull MediaRequest.MediaPropertyNames	getMediaPropertyNames()
@Nullable String	getMediaRef()
@Nullable String	getRefProperty()	Deprecated. Please use getMediaPropertyNames().
@Nullable org.apache.sling.api.resource.Resource	getResource()
@NotNull org.apache.sling.api.resource.ValueMap	getResourceProperties()
@Nullable String	getRotationProperty()	Deprecated. Please use getMediaPropertyNames().
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(@NotNull
                    @NotNull String mediaRef,
                    @Nullable
                    @Nullable MediaArgs mediaArgs)

Parameters:

mediaRef - Reference to media item

mediaArgs - Additional arguments affection media resolving

MediaRequest

@Deprecated
public MediaRequest(@Nullable
                    @Nullable org.apache.sling.api.resource.Resource resource,
                    @Nullable
                    @Nullable String mediaRef,
                    @Nullable
                    @Nullable MediaArgs mediaArgs,
                    @Nullable
                    @Nullable String refProperty,
                    @Nullable
                    @Nullable String cropProperty)

Deprecated.

Use MediaRequest(Resource, String, MediaArgs, MediaPropertyNames)

Parameters:

resource - Resource containing reference to media asset

mediaRef - Reference to media item

mediaArgs - Additional arguments affection media resolving

refProperty - Name of the property from which the media reference is read

cropProperty - Name of the property which contains the cropping parameters

MediaRequest

@Deprecated
public MediaRequest(@Nullable
                    @Nullable org.apache.sling.api.resource.Resource resource,
                    @Nullable
                    @Nullable String mediaRef,
                    @Nullable
                    @Nullable MediaArgs mediaArgs,
                    @Nullable
                    @Nullable String refProperty,
                    @Nullable
                    @Nullable String cropProperty,
                    @Nullable
                    @Nullable String rotationProperty)

Deprecated.

Use MediaRequest(Resource, String, MediaArgs, MediaPropertyNames)

Parameters:

resource - Resource containing reference to media asset

mediaRef - Reference to media item

mediaArgs - Additional arguments affection media resolving

refProperty - Name of the property from which the media reference is read

cropProperty - Name of the property which contains the cropping parameters

rotationProperty - Name of the property which contains the rotation parameter

MediaRequest

public MediaRequest(@Nullable
                    @Nullable org.apache.sling.api.resource.Resource resource,
                    @Nullable
                    @Nullable 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 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.

getRefProperty

@Deprecated
@Nullable
public @Nullable String getRefProperty()

Deprecated.

Please use getMediaPropertyNames().

Returns:

Name of the property from which the media reference is read

getCropProperty

@Deprecated
@Nullable
public @Nullable String getCropProperty()

Deprecated.

Please use getMediaPropertyNames().

Returns:

Name of the property which contains the cropping parameters

getRotationProperty

@Deprecated
@Nullable
public @Nullable String getRotationProperty()

Deprecated.

Please use getMediaPropertyNames().

Returns:

Name of the property which contains the rotation parameter

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 String toString()

Overrides:

toString in class Object