Package org.apache.jackrabbit.api.binary
Class BinaryUploadOptions
- java.lang.Object
-
- org.apache.jackrabbit.api.binary.BinaryUploadOptions
-
@ProviderType public final class BinaryUploadOptions extends java.lang.Object
Specifies the options to be used when requesting direct upload URIs viaJackrabbitValueFactory.initiateBinaryUpload(long, int, BinaryUploadOptions)
.To specify upload options, obtain a
BinaryUploadOptions.BinaryUploadOptionsBuilder
via thebuilder()
method, then specify the options desired and get the object viaBinaryUploadOptions.BinaryUploadOptionsBuilder.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 class
BinaryUploadOptions.BinaryUploadOptionsBuilder
Used to build an instance ofBinaryUploadOptions
with the options set as desired by the caller.
-
Field Summary
Fields Modifier and Type Field Description static BinaryUploadOptions
DEFAULT
Provides a default instance of this class.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static @NotNull BinaryUploadOptions.BinaryUploadOptionsBuilder
builder()
Returns aBinaryUploadOptions.BinaryUploadOptionsBuilder
instance to be used for creating an instance of this class.boolean
isDomainOverrideIgnored()
Indicates whether the option to ignore any configured domain override setting has been specified.
-
-
-
Field Detail
-
DEFAULT
public static final BinaryUploadOptions DEFAULT
Provides a default instance of this class. This instance enforces the proper default behaviors for the options.
-
-
Method Detail
-
isDomainOverrideIgnored
public boolean isDomainOverrideIgnored()
Indicates whether the option to ignore any configured domain override setting has been specified.- Returns:
- true if the domain override should be ignored; false otherwise.
The default behavior is
false
, meaning that any configured domain override setting should be honored.
-
builder
@NotNull public static @NotNull BinaryUploadOptions.BinaryUploadOptionsBuilder builder()
Returns aBinaryUploadOptions.BinaryUploadOptionsBuilder
instance to be used for creating an instance of this class.- Returns:
- A builder instance.
-
-