@ProviderType public final class BinaryDownloadOptions extends java.lang.Object
BinaryDownload.getURI(BinaryDownloadOptions)
. Setting these options
allows the caller to instruct the service provider that these options should
be applied to the response to a request made with the URI returned.
To specify download options, obtain a BinaryDownloadOptions.BinaryDownloadOptionsBuilder
via the builder()
method, then specify the options desired and
get the object via BinaryDownloadOptions.BinaryDownloadOptionsBuilder.build()
.
If no options are needed, use DEFAULT
which
instructs the implementation to use the service provider default behavior.
Modifier and Type | Class and Description |
---|---|
static class |
BinaryDownloadOptions.BinaryDownloadOptionsBuilder
Used to build an instance of
BinaryDownloadOptions with the
options set as desired by the caller. |
Modifier and Type | Field and Description |
---|---|
static BinaryDownloadOptions |
DEFAULT
Provides a default instance of this class.
|
Modifier and Type | Method and Description |
---|---|
static @NotNull BinaryDownloadOptions.BinaryDownloadOptionsBuilder |
builder()
Returns a
BinaryDownloadOptions.BinaryDownloadOptionsBuilder instance to be used for
creating an instance of this class. |
@Nullable java.lang.String |
getCharacterEncoding()
Returns the character encoding that should be assumed for the binary 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 binary that is to be
downloaded.
|
@Nullable java.lang.String |
getMediaType()
Returns the internet media type that should be assumed for the binary that is to be
downloaded.
|
boolean |
isDownloadDomainIgnored()
Returns a boolean value that indicates whether the data store should
ignore any provided download domain override configuration value when
generating the signed URI.
|
public static final BinaryDownloadOptions DEFAULT
@Nullable public final @Nullable java.lang.String getMediaType()
jcr:mimeType
. This
value can be set by calling BinaryDownloadOptions.BinaryDownloadOptionsBuilder.withMediaType(String)
when building an
instance of this class.null
if no
type has been specified.@Nullable public final @Nullable java.lang.String getCharacterEncoding()
jcr:encoding
.
It can be set by calling BinaryDownloadOptions.BinaryDownloadOptionsBuilder.withCharacterEncoding(String)
when building an
instance of this class.null
if no
encoding has been specified.@Nullable public final @Nullable java.lang.String getFileName()
BinaryDownloadOptions.BinaryDownloadOptionsBuilder.withFileName(String)
when building an
instance of this class.null
if no
file name has been specified.@NotNull public final @NotNull java.lang.String getDispositionType()
BinaryDownloadOptions.BinaryDownloadOptionsBuilder.withDispositionTypeInline()
or BinaryDownloadOptions.BinaryDownloadOptionsBuilder.withDispositionTypeAttachment()
when
building an instance of this class. The default value of this setting is
"inline".public boolean isDownloadDomainIgnored()
BinaryDownloadOptions.BinaryDownloadOptionsBuilder.withDomainOverrideIgnored(boolean)
. The
default value of this setting is false.@NotNull public static @NotNull BinaryDownloadOptions.BinaryDownloadOptionsBuilder builder()
BinaryDownloadOptions.BinaryDownloadOptionsBuilder
instance to be used for
creating an instance of this class.Copyright © 2010 - 2020 Adobe. All Rights Reserved