|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFileTransformationManagerSPI
Service provider interface for file transformations.
Method Summary | |
---|---|
void |
addTransformedFileConfig(TransformedFileConfig file,
ITransaction transaction)
Persists a transformed file. |
void |
changeFilename(SessionConfig sessionConfig,
String fileId,
String newFilename,
ITransaction transaction)
Changes the filename of a tranformed file. |
File |
getFile(SessionConfig sessionConfig,
TransformedFileConfig transformedFileConfig,
ITransaction transaction)
Returns a file based on the TransformedFileConfig indicated. |
IServiceInterfaceUrl |
getFileHref(SessionConfig sessionConfig,
TransformedFileConfig transformedFileConfig,
ITransaction transaction)
Returns the href for linking to the given transformed file in a portal's page. |
TransformedFileConfig |
getTransformedFileConfig(String fileTrnsfPersistedId,
ITransaction transaction)
Returns the persisted generated file. |
Collection<TransformedFileConfig> |
getTransformedFileConfigByOriginalId(String originalFileId,
ITransaction transaction)
Returns all transformed files by the original file. |
void |
moveTransformedFiles(FileConfig fileConfig,
IWebRootPortalBaseFolder oldWebRoot)
Moves the transformed public files from the old web root to the current. |
void |
recreateFiles(SessionConfig sessionConfig,
FileTransformation fileTransformation,
ITransaction transaction)
Recreates all derived files of a given transformation. |
void |
recreateTransformations(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction)
Recreates all transformations of a given file. |
void |
removeFileTransformationInternal(SessionConfig sessionConfig,
FileTransformation fileTransformation,
IWebRootPortalBaseFolder webRoot,
ITransaction transaction)
Removes the specified transformation and all related files. |
void |
removeTransformedFileConfig(TransformedFileConfig transformedFileConfig,
ITransaction transaction)
Deletes asynchronously the persisted transformed file. |
void |
removeTransformedFileConfig(TransformedFileConfig transformedFileConfig,
IWebRootPortalBaseFolder webRootBaseFolder,
ITransaction transaction)
Deletes synchronously persisted transformed file. |
void |
transformFile(SessionConfig sessionConfig,
String fileId,
FileTransformation fileTransformation,
ITransaction transaction)
Transforms a given file. |
void |
updateMetadata(String transformedFileConfigId,
ITransaction transaction)
Updates metadata information from a given tranformed file |
Methods inherited from interface lumis.portal.file.transformation.IFileTransformationManager |
---|
addFileTransformation, getFileTransformation, getFileTransformationsByServiceInstanceId, removeFileTransformation, updateFileTransformation |
Method Detail |
---|
void removeFileTransformationInternal(SessionConfig sessionConfig, FileTransformation fileTransformation, IWebRootPortalBaseFolder webRoot, ITransaction transaction) throws PortalException
sessionConfig
- the current session configuration.fileTransformation
- the file transformation.webRoot
- base folder for the website.transaction
- the transaction for persistence access.
PortalException
void recreateFiles(SessionConfig sessionConfig, FileTransformation fileTransformation, ITransaction transaction) throws PortalException
sessionConfig
- the current session configuration.fileTransformation
- the file transformationtransaction
- the transaction for persistence access.
PortalException
void recreateTransformations(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws PortalException
sessionConfig
- the current session configuration.serviceInstanceId
- the desired serviceInstanceId.transaction
- the transaction for persistence access.
PortalException
void transformFile(SessionConfig sessionConfig, String fileId, FileTransformation fileTransformation, ITransaction transaction) throws PortalException
sessionConfig
- the current session configuration.fileId
- the file to be transformed.fileTransformation
- the transformation to be user.transaction
- the current transaction
PortalException
void addTransformedFileConfig(TransformedFileConfig file, ITransaction transaction) throws PortalException
file
- the transformed file to be persistedtransaction
- the current transaction
PortalException
TransformedFileConfig getTransformedFileConfig(String fileTrnsfPersistedId, ITransaction transaction) throws PortalException
fileTrnsfPersistedId
- the file id of the generated file.transaction
- the current transaction
PortalException
void removeTransformedFileConfig(TransformedFileConfig transformedFileConfig, ITransaction transaction) throws PortalException
transformedFileConfig
- the transformed file config to be deleted.transaction
- the current transaction
PortalException
void removeTransformedFileConfig(TransformedFileConfig transformedFileConfig, IWebRootPortalBaseFolder webRootBaseFolder, ITransaction transaction) throws PortalException
transformedFileConfig
- the transformed file config to be deleted.webRootBaseFolder
- base folder for the website.transaction
- in which the deletion should occur.
PortalException
Collection<TransformedFileConfig> getTransformedFileConfigByOriginalId(String originalFileId, ITransaction transaction) throws PortalException
originalFileId
- the original file of the transformed config persistedtransaction
- the current transaction
PortalException
File getFile(SessionConfig sessionConfig, TransformedFileConfig transformedFileConfig, ITransaction transaction) throws PortalException
TransformedFileConfig
indicated.
sessionConfig
- identifier for the session.transformedFileConfig
- the transformedfileConfig of the asked file.transaction
- the transaction for persistence access.
PortalException
IServiceInterfaceUrl getFileHref(SessionConfig sessionConfig, TransformedFileConfig transformedFileConfig, ITransaction transaction) throws PortalException
sessionConfig
- user session information.transformedFileConfig
- the transformed file.transaction
- the transaction for persistence access.
PortalException
void updateMetadata(String transformedFileConfigId, ITransaction transaction) throws PortalException
transformedFileConfigId
- file that the metadata information will be updatedtransaction
- the transaction for persistence access.
PortalException
- if any error updating occursvoid changeFilename(SessionConfig sessionConfig, String fileId, String newFilename, ITransaction transaction) throws PortalException
sessionConfig
- identifier for the session.fileId
- the file id.newFilename
- the new filename for the file.transaction
- the transaction for persistence access.
PortalException
void moveTransformedFiles(FileConfig fileConfig, IWebRootPortalBaseFolder oldWebRoot) throws PortalException
fileConfig
- the file whose transformations are to be moved.oldWebRoot
- the web root folder the file was originally in, or
null
if it was not in any web root.
PortalException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |