Package org.apache.jackrabbit.api.binary

Class BinaryDownloadOptions

java.lang.Object

org.apache.jackrabbit.api.binary.BinaryDownloadOptions

@ProviderType
public final class BinaryDownloadOptions
extends Object

Specifies the options to be used when obtaining a direct download URI via 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BinaryDownloadOptions.BinaryDownloadOptionsBuilder	Used to build an instance of BinaryDownloadOptions with the options set as desired by the caller.

Field Summary

Fields

Modifier and Type	Field	Description
static final BinaryDownloadOptions	DEFAULT	Provides a default instance of this class.

Method Summary

Modifier and Type	Method	Description
static @NotNull BinaryDownloadOptions.BinaryDownloadOptionsBuilder	builder()	Returns a BinaryDownloadOptions.BinaryDownloadOptionsBuilder instance to be used for creating an instance of this class.
final @Nullable String	getCharacterEncoding()	Returns the character encoding that should be assumed for the binary that is to be downloaded.
final @NotNull String	getDispositionType()	Returns the disposition type that should be assumed for the binary that is to be downloaded.
final @Nullable String	getFileName()	Returns the filename that should be assumed for the binary that is to be downloaded.
final @Nullable 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.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final BinaryDownloadOptions DEFAULT

Provides a default instance of this class. Using the default instance indicates that the caller is willing to accept the service provider default behavior.

Method Details

getMediaType

@Nullable
public final @Nullable String getMediaType()

Returns the internet media type that should be assumed for the binary that is to be downloaded. This value should be a valid jcr:mimeType. This value can be set by calling BinaryDownloadOptions.BinaryDownloadOptionsBuilder.withMediaType(String) when building an instance of this class.

Returns:

A String representation of the internet media type, or null if no type has been specified.

See Also:

• JCR 2.0 Repository Model - jcr:mimeType

getCharacterEncoding

@Nullable
public final @Nullable String getCharacterEncoding()

Returns the character encoding that should be assumed for the binary that is to be downloaded. This value should be a valid jcr:encoding. It can be set by calling BinaryDownloadOptions.BinaryDownloadOptionsBuilder.withCharacterEncoding(String) when building an instance of this class.

Returns:

The character encoding, or null if no encoding has been specified.

See Also:

• JCR 2.0 Repository Model - jcr:encoding

getFileName

@Nullable
public final @Nullable String getFileName()

Returns the filename that should be assumed for the binary that is to be downloaded. This value can be set by calling BinaryDownloadOptions.BinaryDownloadOptionsBuilder.withFileName(String) when building an instance of this class.

Returns:

The file name, or null if no file name has been specified.

getDispositionType

@NotNull
public final @NotNull String getDispositionType()

Returns the disposition type that should be assumed for the binary that is to be downloaded. This value can be set by calling BinaryDownloadOptions.BinaryDownloadOptionsBuilder.withDispositionTypeInline() or BinaryDownloadOptions.BinaryDownloadOptionsBuilder.withDispositionTypeAttachment() when building an instance of this class. The default value of this setting is "inline".

Returns:

The disposition type.

See Also:

• RFC 6266, Section 4.2

isDownloadDomainIgnored

public 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. This value can be set by calling BinaryDownloadOptions.BinaryDownloadOptionsBuilder.withDomainOverrideIgnored(boolean). The default value of this setting is false.

Returns:

true if the domain override should be ignored; false otherwise.

builder

@NotNull
public static @NotNull BinaryDownloadOptions.BinaryDownloadOptionsBuilder builder()

Returns a BinaryDownloadOptions.BinaryDownloadOptionsBuilder instance to be used for creating an instance of this class.

Returns:

A builder instance.