com.aspose.slides

Class BlobManagementOptions

java.lang.Object

com.aspose.slides.BlobManagementOptions

All Implemented Interfaces:

IBlobManagementOptions

public class BlobManagementOptions
extends java.lang.Object
implements IBlobManagementOptions

Represents options which can be used to manage BLOB handling rules and other BLOB settings.

Constructor Summary

Constructors

Constructor and Description
BlobManagementOptions() Creates new default blob management options.

Method Summary

Modifier and Type	Method and Description
long	getMaxBlobsBytesInMemory() Defines the maximum amount (in bytes) that all BLOBs in total may occupy in memory.
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.
java.lang.String	getTempFilesRootPath() The root path where temporary files will be created.
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.
void	setMaxBlobsBytesInMemory(long value) Defines the maximum amount (in bytes) that all BLOBs in total may occupy in memory.
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.
void	setTempFilesRootPath(java.lang.String value) The root path where temporary files will be created.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlobManagementOptions

public BlobManagementOptions()

Creates new default blob management options.

Method Detail

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.

Specified by:

getPresentationLockingBehavior in interface IBlobManagementOptions

setPresentationLockingBehavior

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.

Specified by:

setPresentationLockingBehavior in interface IBlobManagementOptions

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.

Specified by:

isTemporaryFilesAllowed in interface IBlobManagementOptions

setTemporaryFilesAllowed

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.

Specified by:

setTemporaryFilesAllowed in interface IBlobManagementOptions

getTempFilesRootPath

public final java.lang.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.

Specified by:

getTempFilesRootPath in interface IBlobManagementOptions

setTempFilesRootPath

public final void setTempFilesRootPath(java.lang.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.

Specified by:

setTempFilesRootPath in interface IBlobManagementOptions

getMaxBlobsBytesInMemory

public final long getMaxBlobsBytesInMemory()

Defines the maximum amount (in bytes) that all BLOBs in total may occupy in memory. First, all BLOBs loading into memory as default behavior and only when it reaches the limit defined by this property, other mechanisms (such as temporary files) can be involved. In terms of performance, the most efficient way is storing BLOBs in memory, but from the other side, it leads to a high memory consumption what may be undesirable. Using this property, you may set the optimal behavior for your environment or other requirements.

This property will be ignored if IsTemporaryFilesAllowed(isTemporaryFilesAllowed()/setTemporaryFilesAllowed(boolean)) is set to false. It makes no sense to limit the maximum BLOBs in memory, because if IsTemporaryFilesAllowed(isTemporaryFilesAllowed()/setTemporaryFilesAllowed(boolean)) is set to false, the memory is the only place where BLOBs can be stored.

Default value is 629,145,600 bytes (600Mb).

Specified by:

getMaxBlobsBytesInMemory in interface IBlobManagementOptions

setMaxBlobsBytesInMemory

public final void setMaxBlobsBytesInMemory(long value)

Defines the maximum amount (in bytes) that all BLOBs in total may occupy in memory. First, all BLOBs loading into memory as default behavior and only when it reaches the limit defined by this property, other mechanisms (such as temporary files) can be involved. In terms of performance, the most efficient way is storing BLOBs in memory, but from the other side, it leads to a high memory consumption what may be undesirable. Using this property, you may set the optimal behavior for your environment or other requirements.

This property will be ignored if IsTemporaryFilesAllowed(isTemporaryFilesAllowed()/setTemporaryFilesAllowed(boolean)) is set to false. It makes no sense to limit the maximum BLOBs in memory, because if IsTemporaryFilesAllowed(isTemporaryFilesAllowed()/setTemporaryFilesAllowed(boolean)) is set to false, the memory is the only place where BLOBs can be stored.

Default value is 629,145,600 bytes (600Mb).

Specified by:

setMaxBlobsBytesInMemory in interface IBlobManagementOptions