Class BlobDownloadOptions
- java.lang.Object
-
- org.apache.jackrabbit.oak.api.blob.BlobDownloadOptions
-
@ProviderType public class BlobDownloadOptions extends java.lang.Object
Download options to be provided to a call toBlobAccessProvider.getDownloadURI(Blob, BlobDownloadOptions)
.This object is an internal corollary to
org.apache.jackrabbit.api.binary.BinaryDownloadOptions
.
-
-
Field Summary
Fields Modifier and Type Field Description static BlobDownloadOptions
DEFAULT
-
Constructor Summary
Constructors Constructor Description BlobDownloadOptions(@Nullable java.lang.String mediaType, @Nullable java.lang.String characterEncoding, @Nullable java.lang.String fileName, @NotNull java.lang.String dispositionType)
Creates new download options.BlobDownloadOptions(@Nullable java.lang.String mediaType, @Nullable java.lang.String characterEncoding, @Nullable java.lang.String fileName, @NotNull java.lang.String dispositionType, boolean domainOverrideIgnored)
Creates new download options.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @Nullable java.lang.String
getCharacterEncoding()
Returns the character encoding that should be assumed for the blob that is to be downloaded.@NotNull java.lang.String
getDispositionType()
Returns the disposition type that should be assumed for the binary that is to be downloaded.@Nullable java.lang.String
getFileName()
Returns the filename that should be assumed for the blob that is to be downloaded.@Nullable java.lang.String
getMediaType()
Returns the internet media type that should be assumed for the blob that is to be downloaded.boolean
isDomainOverrideIgnored()
Indicates whether the data store should ignore any provided download domain override configuration value when generating the signed URI.
-
-
-
Field Detail
-
DEFAULT
public static final BlobDownloadOptions DEFAULT
-
-
Constructor Detail
-
BlobDownloadOptions
public BlobDownloadOptions(@Nullable @Nullable java.lang.String mediaType, @Nullable @Nullable java.lang.String characterEncoding, @Nullable @Nullable java.lang.String fileName, @NotNull @NotNull java.lang.String dispositionType)
Creates new download options.- Parameters:
mediaType
- the internet media type for the blob.characterEncoding
- the character encoding for the blob.fileName
- the file name for the blob.dispositionType
- the disposition type.
-
BlobDownloadOptions
public BlobDownloadOptions(@Nullable @Nullable java.lang.String mediaType, @Nullable @Nullable java.lang.String characterEncoding, @Nullable @Nullable java.lang.String fileName, @NotNull @NotNull java.lang.String dispositionType, boolean domainOverrideIgnored)
Creates new download options.- Parameters:
mediaType
- the internet media type for the blob.characterEncoding
- the character encoding for the blob.fileName
- the file name for the blob.dispositionType
- the disposition type.domainOverrideIgnored
- true if any configured domain override should be ignored when generating URIs; false otherwise.
-
-
Method Detail
-
getMediaType
@Nullable public @Nullable java.lang.String getMediaType()
Returns the internet media type that should be assumed for the blob that is to be downloaded. This value should be a validjcr:mimeType
.- Returns:
- The internet media type, or
null
if no type has been specified.
-
getCharacterEncoding
@Nullable public @Nullable java.lang.String getCharacterEncoding()
Returns the character encoding that should be assumed for the blob that is to be downloaded. This value should be a validjcr:encoding
.- Returns:
- The character encoding, or
null
if no encoding has been specified.
-
getFileName
@Nullable public @Nullable java.lang.String getFileName()
Returns the filename that should be assumed for the blob that is to be downloaded.- Returns:
- The file name, or
null
if no file name has been specified.
-
getDispositionType
@NotNull public @NotNull java.lang.String getDispositionType()
Returns the disposition type that should be assumed for the binary that is to be downloaded. The default value of this setting is "inline".- Returns:
- The disposition type.
- See Also:
- RFC 6266, Section 4.2
-
isDomainOverrideIgnored
public boolean isDomainOverrideIgnored()
Indicates whether the data store should ignore any provided download domain override configuration value when generating the signed URI.- Returns:
- true if the domain override should be ignored; false otherwise.
-
-