BlobManagementOptions
Inheritance: java.lang.Object
All Implemented Interfaces: com.aspose.slides.IBlobManagementOptions
public class BlobManagementOptions implements IBlobManagementOptions
Represents options which can be used to manage BLOB handling rules and other BLOB settings.
Constructors
| Constructor | Description |
|---|---|
| BlobManagementOptions() | Creates new default blob management options. |
Methods
| Method | Description |
|---|---|
| getPresentationLockingBehavior() | This property defines if an instance of the Presentation class can be an owner of the source - file or stream during the instance lifetime. |
| setPresentationLockingBehavior(int value) | This property defines if an instance of the Presentation class can be an owner of the source - file or stream during the instance lifetime. |
| isTemporaryFilesAllowed() | This property defines if temporary files can be created while working with BLOBs, what greatly decreases the memory consumption but requires permissions to create files. |
| setTemporaryFilesAllowed(boolean value) | This property defines if temporary files can be created while working with BLOBs, what greatly decreases the memory consumption but requires permissions to create files. |
| getTempFilesRootPath() | The root path where temporary files will be created. |
| setTempFilesRootPath(String value) | The root path where temporary files will be created. |
| getMaxBlobsBytesInMemory() | Defines the maximum total size (in bytes) that all BLOBs may occupy in memory. |
| setMaxBlobsBytesInMemory(long value) | Defines the maximum total size (in bytes) that all BLOBs may occupy in memory. |
BlobManagementOptions()
public BlobManagementOptions()
Creates new default blob management options.
getPresentationLockingBehavior()
public final int getPresentationLockingBehavior()
This property defines if an instance of the Presentation class can be an owner of the source - file or stream during the instance lifetime. If the instance is an owner, it locks the source. This helps to improve memory consumption and performance while working with BLOBs, but the source (stream or file) can’t be changed during Presentation’s instance lifetime.
Returns: int
setPresentationLockingBehavior(int value)
public final void setPresentationLockingBehavior(int value)
This property defines if an instance of the Presentation class can be an owner of the source - file or stream during the instance lifetime. If the instance is an owner, it locks the source. This helps to improve memory consumption and performance while working with BLOBs, but the source (stream or file) can’t be changed during Presentation’s instance lifetime.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
isTemporaryFilesAllowed()
public final boolean isTemporaryFilesAllowed()
This property defines if temporary files can be created while working with BLOBs, what greatly decreases the memory consumption but requires permissions to create files.
All files will be deleted after work with the presentation will be finished.
Returns: boolean
setTemporaryFilesAllowed(boolean value)
public final void setTemporaryFilesAllowed(boolean value)
This property defines if temporary files can be created while working with BLOBs, what greatly decreases the memory consumption but requires permissions to create files.
All files will be deleted after work with the presentation will be finished.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getTempFilesRootPath()
public final String getTempFilesRootPath()
The root path where temporary files will be created. System temorary directory will be used by default. Hosting process should have permissions to create files and folders there.
Returns: java.lang.String
setTempFilesRootPath(String value)
public final void setTempFilesRootPath(String value)
The root path where temporary files will be created. System temorary directory will be used by default. Hosting process should have permissions to create files and folders there.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getMaxBlobsBytesInMemory()
public final long getMaxBlobsBytesInMemory()
Defines the maximum total size (in bytes) that all BLOBs may occupy in memory. By default, all BLOBs are loaded into memory; only once this limit is reached are alternative mechanisms (such as temporary files) employed. Keeping BLOBs in memory maximizes performance but can lead to high memory usage. Use this property to tailor behavior to your environment or requirements.
This property is ignored if #isTemporaryFilesAllowed.isTemporaryFilesAllowed/#setTemporaryFilesAllowed(boolean).setTemporaryFilesAllowed(boolean) is set to false, since memory is then the only storage location available and limiting in-memory BLOB usage has no effect.
The default value is 629,145,600 bytes (600 MB).
You may set this property to zero, but a small minimum amount of memory will still be reserved.
Returns: long
setMaxBlobsBytesInMemory(long value)
public final void setMaxBlobsBytesInMemory(long value)
Defines the maximum total size (in bytes) that all BLOBs may occupy in memory. By default, all BLOBs are loaded into memory; only once this limit is reached are alternative mechanisms (such as temporary files) employed. Keeping BLOBs in memory maximizes performance but can lead to high memory usage. Use this property to tailor behavior to your environment or requirements.
This property is ignored if #isTemporaryFilesAllowed.isTemporaryFilesAllowed/#setTemporaryFilesAllowed(boolean).setTemporaryFilesAllowed(boolean) is set to false, since memory is then the only storage location available and limiting in-memory BLOB usage has no effect.
The default value is 629,145,600 bytes (600 MB).
You may set this property to zero, but a small minimum amount of memory will still be reserved.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | long |