org.adroitlogic.x.feature.filestore.impl

Class FileStoreFeatureImpl

java.lang.Object

org.adroitlogic.x.api.AbstractIntegrationFeature

org.adroitlogic.x.feature.filestore.impl.FileStoreFeatureImpl

All Implemented Interfaces:

org.adroitlogic.x.api.dec.Initializable, FileStoreFeature

@IntegrationFeature(clazz=FileStoreFeature.class,
                    name="file-store")
public final class FileStoreFeatureImpl
extends org.adroitlogic.x.api.AbstractIntegrationFeature
implements FileStoreFeature

File caching implementation to cache the message file entries using a object pool which implements using the GenericObjectPool This implementation facilitates to configure initialSize(defaults to 200), warnThreshold(defaults to 6144) and stopThreshold(defaults to 8192) for the file cached entries in the pool. If it exceeds the warnThreshold, warn log will be created to notify to the user, if it exceeds the stop threshold, NoSuchElementException exception will be thrown by the object pool.

Since:

17.01

Author:

Ruwan Linton, Manjula Piyumal, Sudheeara Palihakkara

Constructor Summary

Constructors

Constructor and Description
FileStoreFeatureImpl()

Method Summary

Modifier and Type	Method and Description
void	destroy()
XMessageFileEntity	getFileEntity(UUID messageUuid) Deprecated.
XMessageFileEntity	getTempFileEntity(org.adroitlogic.x.api.XMessage xMessage) Use this api to get a temp XMessageFileEntity from the file store.
void	init(org.springframework.context.ApplicationContext context)
void	releaseFile(XMessageFileEntity messageFileEntity) Use this api to release a specific message entity from the file store, this call will either delete the actual file from the file system or released to the file pool depending on the FileStoreFeature implementation.
void	resetPayloadToFileBackedFormat(org.adroitlogic.x.api.XMessage xMessage) Use this api to reset a payload of a message to a new instance of MessageFileFormat which is consist of a new XMessageFileEntity.

Methods inherited from class org.adroitlogic.x.api.AbstractIntegrationFeature

setProjectConfig, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStoreFeatureImpl

public FileStoreFeatureImpl()

Method Detail

init

public void init(org.springframework.context.ApplicationContext context)

Specified by:

init in interface org.adroitlogic.x.api.dec.Initializable

Overrides:

init in class org.adroitlogic.x.api.AbstractIntegrationFeature

destroy

public void destroy()

Specified by:

destroy in interface org.adroitlogic.x.api.dec.Initializable

Overrides:

destroy in class org.adroitlogic.x.api.AbstractIntegrationFeature

getFileEntity

@Deprecated
public XMessageFileEntity getFileEntity(UUID messageUuid)
                                             throws org.adroitlogic.x.api.IntegrationRuntimeException

Deprecated.

Get a temp file wrapped with XMessageFileEntity from file store. Note: this file not be released by the framework unless it used in a constructor of a XMessage, thus it should be released at the end of use by calling releaseFile(XMessageFileEntity) Method has been marked as deprecated since it is not encourage to use this method in order to get a temp file, instead use getTempFileEntity(XMessage)

Parameters:

messageUuid - the uuid of the message

Returns:

new temporary file in XMessageFile instance

Throws:

org.adroitlogic.x.api.IntegrationRuntimeException - in case of a failure to get the file entity

getTempFileEntity

public XMessageFileEntity getTempFileEntity(org.adroitlogic.x.api.XMessage xMessage)
                                     throws org.adroitlogic.x.api.IntegrationRuntimeException

Description copied from interface: FileStoreFeature

Use this api to get a temp XMessageFileEntity from the file store. The returned entity will be naturally deleted at the end of the given message's end of life.

Specified by:

getTempFileEntity in interface FileStoreFeature

Parameters:

xMessage - Message for attaching the release hook

Returns:

an instance of XMessageFileEntity

Throws:

org.adroitlogic.x.api.IntegrationRuntimeException - If couldn't create a message file

resetPayloadToFileBackedFormat

public void resetPayloadToFileBackedFormat(org.adroitlogic.x.api.XMessage xMessage)
                                    throws org.adroitlogic.x.api.IntegrationRuntimeException

Description copied from interface: FileStoreFeature

Use this api to reset a payload of a message to a new instance of MessageFileFormat which is consist of a new XMessageFileEntity. Created XMessageFileEntity will be naturally released at the end of the given XMessage's life.

Specified by:

resetPayloadToFileBackedFormat in interface FileStoreFeature

Parameters:

xMessage - XMessage instance for reset payload

Throws:

org.adroitlogic.x.api.IntegrationRuntimeException - If couldn't create a message file

releaseFile

public final void releaseFile(XMessageFileEntity messageFileEntity)
                       throws org.adroitlogic.x.api.IntegrationRuntimeException

Description copied from interface: FileStoreFeature

Use this api to release a specific message entity from the file store, this call will either delete the actual file from the file system or released to the file pool depending on the FileStoreFeature implementation.

Specified by:

releaseFile in interface FileStoreFeature

Parameters:

messageFileEntity - XMessageFileEntity instance to be released

Throws:

org.adroitlogic.x.api.IntegrationRuntimeException - If couldn't release the messageFile or delete underlying file