lumis.portal.file

Class FileManager

java.lang.Object

lumis.portal.file.FileManager

All Implemented Interfaces:

IFileManager

public class FileManager
extends Object
implements IFileManager

Manager for file and files

Since:

4.0.0

Version:

$Revision: 22901 $ $Date: 2019-07-02 14:51:03 +0000 (Tue, 02 Jul 2019) $

Field Summary

Fields inherited from interface lumis.portal.file.IFileManager

CONTENT_TYPE_PROVIDER_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
FileManager()

Method Summary

Modifier and Type	Method and Description
FileConfig	add(SessionConfig sessionConfig, FileConfig fileConfig, ITransaction transaction) Deprecated.
FileConfig	add(SessionConfig sessionConfig, String name, File file, String contentType, String serviceInstanceId, ITransaction transaction) Persists a file.
FileConfig	add(SessionConfig sessionConfig, String fileId, String fileRelativePath, String name, File file, String serviceInstanceId, ITransaction transaction) Persists a file.
FileConfig	add(SessionConfig sessionConfig, String fileId, String fileRelativePath, String name, File file, String contentType, String serviceInstanceId, ITransaction transaction) Persists a file.
void	changeFilename(SessionConfig sessionConfig, String fileId, String newFilename, ITransaction transaction) Changes the filename of a file.
FileConfig	findByFullPath(SessionConfig sessionConfig, String fullPath, ITransaction transaction) Finds the FileConfig by the full path.
FileConfig	get(SessionConfig sessionConfig, String fileId, ITransaction transaction) Returns the FileConfig for a file with the given fileId.
File	getFile(SessionConfig sessionConfig, FileConfig fileConfig, ITransaction transaction) Deprecated.
Collection<FileConfig>	getFileConfigsByFilesId(SessionConfig sessionConfig, String filesId, ITransaction transaction) Returns a collection of FileConfig of file entries belonging to the files with the given id.
Collection<FileConfig>	getFileConfigsByServiceInstanceId(String serviceInstanceId, ITransaction transaction) Returns all file configs by a given service instance id.
IServiceInterfaceUrl	getFileHref(SessionConfig sessionConfig, String fileId, ITransaction transaction) Returns the href that is used to access the specified file.
FilesConfig	getFilesConfig(SessionConfig sessionConfig, String filesId, ITransaction transaction) Returns the FilesConfig for a files with the given filesId.
FileMimeTypeConfig	getMimeType(SessionConfig sessionConfig, String fileMimeType, ITransaction transaction) Returns a mime type information.
int	getNumberOfServiceInstanceFiles(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) Returns the number of files for a service instance.
IFile	getPortalFile(SessionConfig sessionConfig, FileConfig fileConfig, ITransaction transaction) Returns the File object for accessing the corresponding file in the portal filesystem.
void	moveFile(FileConfig file, IWebRootPortalBaseFolder oldWebRoot, IWebRootPortalBaseFolder newWebRoot) Moves the given file from one web root to another.
void	publicServiceInstanceFiles(SessionConfig sessionConfig, String serviceInstanceId, boolean filesArePublic, ITransaction transaction) Creates or deletes the public copy of the files of a service instance.
void	removeStoredFile(SessionConfig sessionConfig, String fileId, ITransaction transaction) Removes the specified file.
void	removeStoredFiles(SessionConfig sessionConfig, String filesId, ITransaction transaction) Removes the files associated with the filesId given.
void	setFileContentLocaleId(String fileId, String contentLocaleId) Sets the given content locale identifier in the file with the given identifier.
void	updateMetadata(String fileId, ITransaction transaction) Updates metadata information from a given file

Methods inherited from class java.lang.Object

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

Constructor Detail

FileManager

public FileManager()

Method Detail

get

public FileConfig get(SessionConfig sessionConfig,
                      String fileId,
                      ITransaction transaction)
               throws PortalException

Description copied from interface: IFileManager

Returns the FileConfig for a file with the given fileId.

Specified by:

get in interface IFileManager

Parameters:

sessionConfig - identifier for the session.

fileId - the id of the file.

transaction - the transaction for persistence access.

Returns:

the FileConfig for the file, or null if it is not found.

Throws:

PortalException

findByFullPath

public FileConfig findByFullPath(SessionConfig sessionConfig,
                                 String fullPath,
                                 ITransaction transaction)
                          throws PortalException

Finds the FileConfig by the full path.

Parameters:

sessionConfig - identifier for the session.

fullPath - the full path.

transaction - the transaction for persistence access.

Returns:

the FileConfig for the file, or null if it is not found.

Throws:

PortalException

Since:

6.0.0

getFilesConfig

public FilesConfig getFilesConfig(SessionConfig sessionConfig,
                                  String filesId,
                                  ITransaction transaction)
                           throws PortalException

Description copied from interface: IFileManager

Returns the FilesConfig for a files with the given filesId.

Specified by:

getFilesConfig in interface IFileManager

Parameters:

sessionConfig - identifier for the session.

filesId - the id of the files.

transaction - the transaction for persistence access.

Returns:

the FilesConfig for the files, or null if it is not found.

Throws:

PortalException

getFileConfigsByFilesId

public Collection<FileConfig> getFileConfigsByFilesId(SessionConfig sessionConfig,
                                                      String filesId,
                                                      ITransaction transaction)
                                               throws PortalException

Description copied from interface: IFileManager

Returns a collection of FileConfig of file entries belonging to the files with the given id.

Specified by:

getFileConfigsByFilesId in interface IFileManager

Parameters:

sessionConfig - identifier for the session.

filesId - id of the files entry.

transaction - the transaction for persistence access.

Returns:

the collection contaning the FileConfig instances, or an empty collection if none is found.

Throws:

PortalException

removeStoredFile

public void removeStoredFile(SessionConfig sessionConfig,
                             String fileId,
                             ITransaction transaction)
                      throws PortalException

Description copied from interface: IFileManager

Removes the specified file. The file entry from database is removed and the corresponding file in the filesystem is deleted.

Specified by:

removeStoredFile in interface IFileManager

Parameters:

sessionConfig - identifier for the session.

fileId - the file id.

transaction - the transaction for persistence access.

Throws:

PortalException

removeStoredFiles

public void removeStoredFiles(SessionConfig sessionConfig,
                              String filesId,
                              ITransaction transaction)
                       throws PortalException

Description copied from interface: IFileManager

Removes the files associated with the filesId given.

Specified by:

removeStoredFiles in interface IFileManager

Parameters:

sessionConfig - identifier for the session.

filesId - the filesId.

transaction - the transaction for persistence access.

Throws:

PortalException

add

public FileConfig add(SessionConfig sessionConfig,
                      String name,
                      File file,
                      String contentType,
                      String serviceInstanceId,
                      ITransaction transaction)
               throws PortalException

Description copied from interface: IFileManager

Persists a file.

Specified by:

add in interface IFileManager

Parameters:

sessionConfig - The session information.

name - The name of the file.

file - The file to be added.

contentType - The contentType of the file.

serviceInstanceId - The ID of the service instance used to add this file.

transaction - The transaction used for the persistence

Returns:

an instance of FileConfig holding the information of the file.

Throws:

PortalException - If any error occurs

FileUploadDeniedException - if the file was not added because it did not comply with portal file upload restrictions configuration.

add

public FileConfig add(SessionConfig sessionConfig,
                      String fileId,
                      String fileRelativePath,
                      String name,
                      File file,
                      String serviceInstanceId,
                      ITransaction transaction)
               throws PortalException

Description copied from interface: IFileManager

Persists a file. Calculates the file's content type automatically.

Specified by:

add in interface IFileManager

Parameters:

sessionConfig - The session information.

fileId - Identifier of the file

fileRelativePath - path of the file starting at the files directory

name - The name of the file.

file - The file to be added.

serviceInstanceId - The ID of the service instance used to add this file.

transaction - The transaction used for the persistence

Returns:

an instance of FileConfig holding the information of the file.

Throws:

PortalException - If any error occurs

FileUploadDeniedException - if the file was not added because it did not comply with portal file upload restrictions configuration.

add

public FileConfig add(SessionConfig sessionConfig,
                      String fileId,
                      String fileRelativePath,
                      String name,
                      File file,
                      String contentType,
                      String serviceInstanceId,
                      ITransaction transaction)
               throws PortalException

Description copied from interface: IFileManager

Persists a file.

Specified by:

add in interface IFileManager

Parameters:

sessionConfig - The session information.

fileId - Identifier of the file

fileRelativePath - path of the file starting at the files directory

name - The name of the file.

file - The file to be added.

contentType - The contentType of the file.

serviceInstanceId - The ID of the service instance used to add this file.

transaction - The transaction used for the persistence

Returns:

an instance of FileConfig holding the information of the file.

Throws:

PortalException - If any error occurs

FileUploadDeniedException - if the file was not added because it did not comply with portal file upload restrictions configuration.

add

@Deprecated
public FileConfig add(SessionConfig sessionConfig,
                                  FileConfig fileConfig,
                                  ITransaction transaction)
                           throws PortalException

Deprecated.

Description copied from interface: IFileManager

Adds a file. The file must be available until the transaction is committed.

Specified by:

add in interface IFileManager

Parameters:

sessionConfig - identifier for the session.

fileConfig - file config of the file to be added.

transaction - the transaction for persistence access.

Returns:

the FileConfig for the file added.

Throws:

FileUploadDeniedException - if the file was not added because it did not comply with portal file upload restrictions configuration.

PortalException

getFile

@Deprecated
public File getFile(SessionConfig sessionConfig,
                                FileConfig fileConfig,
                                ITransaction transaction)
                         throws PortalException

Deprecated.

Description copied from interface: IFileManager

Returns the File object for accessing the corresponding file in the filesystem.

Specified by:

getFile in interface IFileManager

Parameters:

sessionConfig - identifier for the session.

fileConfig - the fileConfig of the asked file.

transaction - the transaction for persistence access.

Returns:

the File object for accessing the corresponding file in the filesystem.

Throws:

PortalException

getPortalFile

public IFile getPortalFile(SessionConfig sessionConfig,
                           FileConfig fileConfig,
                           ITransaction transaction)
                    throws PortalException

Description copied from interface: IFileManager

Returns the File object for accessing the corresponding file in the portal filesystem.

Specified by:

getPortalFile in interface IFileManager

Parameters:

sessionConfig - identifier for the session.

fileConfig - the fileConfig of the asked file.

transaction - the transaction for persistence access.

Returns:

the File object for accessing the corresponding file in the portal filesystem.

Throws:

PortalException

changeFilename

public void changeFilename(SessionConfig sessionConfig,
                           String fileId,
                           String newFilename,
                           ITransaction transaction)
                    throws PortalException

Description copied from interface: IFileManager

Changes the filename of a file.

Specified by:

changeFilename in interface IFileManager

Parameters:

sessionConfig - identifier for the session.

fileId - the file id.

newFilename - the new filename for the file.

transaction - the transaction for persistence access.

Throws:

PortalException

getFileHref

public IServiceInterfaceUrl getFileHref(SessionConfig sessionConfig,
                                        String fileId,
                                        ITransaction transaction)
                                 throws PortalException

Description copied from interface: IFileManager

Returns the href that is used to access the specified file.

Specified by:

getFileHref in interface IFileManager

Parameters:

sessionConfig - identifier for the session.

fileId - the file id.

transaction - the transaction for persistence access.

Throws:

PortalException

publicServiceInstanceFiles

public void publicServiceInstanceFiles(SessionConfig sessionConfig,
                                       String serviceInstanceId,
                                       boolean filesArePublic,
                                       ITransaction transaction)
                                throws PortalException

Description copied from interface: IFileManager

Creates or deletes the public copy of the files of a service instance.

Specified by:

publicServiceInstanceFiles in interface IFileManager

Parameters:

sessionConfig - the user session information.

serviceInstanceId - the service instance id.

filesArePublic - if true the files are copied to the public area, if false the files are deleted from the public area.

transaction - the transaction for persistence access.

Throws:

PortalException

getMimeType

public FileMimeTypeConfig getMimeType(SessionConfig sessionConfig,
                                      String fileMimeType,
                                      ITransaction transaction)
                               throws PortalException

Description copied from interface: IFileManager

Returns a mime type information.

Specified by:

getMimeType in interface IFileManager

Parameters:

sessionConfig - the user session information.

fileMimeType - the mime type.

transaction - the transaction for persistence access.

Returns:

the mime type information.

Throws:

PortalException

updateMetadata

public void updateMetadata(String fileId,
                           ITransaction transaction)
                    throws PortalException

Updates metadata information from a given file

Parameters:

fileId - file that the metadata information will be updated

transaction - the transaction for persistence access.

Throws:

PortalException - if any error updating occurs

Since:

6.0.0

getNumberOfServiceInstanceFiles

public int getNumberOfServiceInstanceFiles(SessionConfig sessionConfig,
                                           String serviceInstanceId,
                                           ITransaction transaction)
                                    throws PortalException

Description copied from interface: IFileManager

Returns the number of files for a service instance.

Specified by:

getNumberOfServiceInstanceFiles in interface IFileManager

Parameters:

sessionConfig - the user session information.

serviceInstanceId - the service instance identifier.

transaction - the transaction for persistence access.

Returns:

the number of files for the specified service instance.

Throws:

PortalException

getFileConfigsByServiceInstanceId

public Collection<FileConfig> getFileConfigsByServiceInstanceId(String serviceInstanceId,
                                                                ITransaction transaction)
                                                         throws PortalException

Returns all file configs by a given service instance id.

Parameters:

serviceInstanceId - the wished service instance id

transaction - the current transaction

Returns:

the file configs for the given service instance

Throws:

PortalException

Since:

6.1.0

moveFile

public void moveFile(FileConfig file,
                     IWebRootPortalBaseFolder oldWebRoot,
                     IWebRootPortalBaseFolder newWebRoot)
              throws PortalException

Moves the given file from one web root to another. The actual move operation will occur after the current transaction commits.

This method also moves all transformed files derived from the given file.

Note: this method does not validates whether the file is public or if it should be in the specified web root. This method is just a low-level movement operation.

Parameters:

file - the file to be moved.

oldWebRoot - the web root base folder the file will be moved from. May be null if the file is not in any web root.

newWebRoot - the web root base folder the file will be moved to. May be null if the file will not be in any web root.

Throws:

PortalException

Since:

6.2.0

setFileContentLocaleId

public void setFileContentLocaleId(String fileId,
                                   String contentLocaleId)
                            throws PortalException

Description copied from interface: IFileManager

Sets the given content locale identifier in the file with the given identifier. If no file config is found with the given file identifier, nothing will be performed.

Specified by:

setFileContentLocaleId in interface IFileManager

Parameters:

fileId - the file identifier.

contentLocaleId - the content locale identifier.

Throws:

PortalException