Uses of Class
lumis.portal.filesystem.IFile

Packages that use IFile

Package	Description
lumis.portal.bigdata.elasticsearch	lumis.portal.bigdata implementation for using Elasticsearch.
lumis.portal.bigdata.spi	Interfaces that may be implemented to integrate the portal with a custom big data repository.
lumis.portal.deployment	Provides the API for LumisXP module deployment.
lumis.portal.deployment.process
lumis.portal.file
lumis.portal.file.transformation	Provides the file transformations.
lumis.portal.filesystem	LumisXP provides a comprehensive file system API to abstract a virtual file system available on all portal servers on the same cluster.
lumis.portal.filesystem.event	Contains events raised by the file system package.
lumis.portal.filesystem.impl
lumis.portal.healthmonitor
lumis.portal.structure.sync	Structure synchronization implementation.
lumis.portal.theme	Contains the portal themes feature implementation.
lumis.portal.user	Defines classes and interfaces for the portal's user.
lumis.portal.webfilereplication	Contains the classes for web file replication feature.
lumis.service.portalmanagement.deployment
lumis.service.portalmanagement.deployment.moduleeditor
lumis.service.tagmanager.util
lumis.service.websitefiles
lumis.util

Uses of IFile in lumis.portal.bigdata.elasticsearch

Methods in lumis.portal.bigdata.elasticsearch that return types with arguments of type IFile

Modifier and Type	Method	Description
java.util.Map<java.util.Locale,IFile>	ElasticsearchRepository.getSynonymsFiles()

Uses of IFile in lumis.portal.bigdata.spi

Methods in lumis.portal.bigdata.spi that return types with arguments of type IFile

Modifier and Type	Method	Description
java.util.Map<java.util.Locale,IFile>	IBigDataRepositorySPI.getSynonymsFiles()	Return a map with all files that the portal need to create based the Locales of synonyms and Locales of portal.

Uses of IFile in lumis.portal.deployment

Methods in lumis.portal.deployment with parameters of type IFile

Modifier and Type	Method	Description
static void	DeploymentUtil.copyJarsInPackageToDeploymentFolder(IFile rootFile)	Copy recursively the files stored on the temp folder to the deployment final folder.
static void	DeploymentUtil.copyModuleToDeploymentFolder(IFile moduleFile, java.lang.String moduleId, ModuleDiff diff)	Copy recursively the files stored on the temp folder to the deployment final folder.
static void	DeploymentUtil.createChannelComponent(java.lang.String name, java.lang.String channelId, java.lang.String exportToPath, IModule module, IFile componentDefinitionFile, ITransaction transaction)
IDeploymentExecutionPlan	DeploymentManager.createModuleDeploymentExecutionPlan(IFile moduleFolder, boolean forceReprocess, boolean syncStructure)
IDeploymentExecutionPlan	DeploymentManager.createModuleDeploymentExecutionPlan(IFile moduleFolder, boolean forceReprocess, boolean syncStructure, boolean wasClosedModule)
IDeploymentExecutionPlan	IDeploymentManagerSPI.createModuleDeploymentExecutionPlan(IFile moduleFolder, boolean forceReprocess, boolean syncStructure)	Creates, validates and returns a module deployment execution plan.
IDeploymentExecutionPlan	IDeploymentManagerSPI.createModuleDeploymentExecutionPlan(IFile moduleFolder, boolean forceReprocess, boolean syncStructure, boolean wasClosedModule)	Creates, validates and returns a module deployment execution plan.
void	DeploymentManager.deployModuleSource(IFile moduleFolder)	Deploys the module referenced in the File parameter
void	DeploymentManager.deployModuleSource(IFile moduleFolder, boolean syncStructure)	Deploys the module referenced in the File parameter
void	IDeploymentManagerSPI.deployModuleSource(IFile moduleSourceFolder)	Deploys the module source folder.
void	IDeploymentManagerSPI.deployModuleSource(IFile moduleSourceFolder, boolean syncStructure)	Deploys the module source folder.

Uses of IFile in lumis.portal.deployment.process

Methods in lumis.portal.deployment.process with parameters of type IFile

Modifier and Type	Method	Description
static ModuleObject	ModuleProcessor.preProcess(IFile moduleFile, boolean forceUseFileContentsForChecksum)	Extracts metadata from the given module file or folder.

Uses of IFile in lumis.portal.file

Methods in lumis.portal.file that return IFile

Modifier and Type	Method	Description
IFile	FileManager.getPortalFile(SessionConfig sessionConfig, FileConfig fileConfig, ITransaction transaction)
IFile	IFileManager.getPortalFile(SessionConfig sessionConfig, FileConfig fileConfig, ITransaction transaction)	Returns the File object for accessing the corresponding file in the portal filesystem.

Methods in lumis.portal.file with parameters of type IFile

Modifier and Type	Method	Description
static void	FileUtil.deletePortalFile(IFile portalFile)	Deletes portal file and all empty ancestor folders.
static java.lang.String	FileUtil.getContentType(IFile file)	Gets content type based on the given file.

Uses of IFile in lumis.portal.file.transformation

Methods in lumis.portal.file.transformation that return IFile

Modifier and Type	Method	Description
IFile	FileTransformationManager.getPortalFile(SessionConfig sessionConfig, TransformedFileConfig transformedFileConfig, ITransaction transaction)
IFile	IFileTransformationManagerSPI.getPortalFile(SessionConfig sessionConfig, TransformedFileConfig transformedFileConfig, ITransaction transaction)	Returns the IFile related to the given TransformedFileConfig.

Uses of IFile in lumis.portal.filesystem

Methods in lumis.portal.filesystem that return IFile

Modifier and Type	Method	Description
IFile	FileSystemManager.getFile(PortalFilePath portalFilePath)
IFile	IFileSystem.getFile(PortalFilePath portalFilePath)	Returns a portal file to be manipulated for a given portal file path. Implementations must not return null. The portal file path parameter will never be null.
IFile	IFileSystemManager.getFile(PortalFilePath portalFilePath)	Returns the IFile to perform operations in portal known files.
IFile	IFile.getParent()	Returns the parent directory.
IFile	IFile.getRoot()	Returns the root folder of this file.
abstract IFile[]	IFile.listFiles()	Lists all immediate sub files and directories of this directory (the files and directories whose getParent() is equal to this).
IFile[]	IFile.listFiles(IFileFilter fileFilter)	Lists all immediate sub files and directories of this directory (the files and directories whose getParent() is equal to this), respecting a given file filter.
IFile	IFile.resolve(java.lang.String relativePath)	Resolves the given path against this file.
IFile	PortalFilePath.toFile()	Returns an IFile constructed with this PortalFilePath.

Methods in lumis.portal.filesystem with parameters of type IFile

Modifier and Type	Method	Description
boolean	IFileFilter.accept(IFile file)	Returns whether the given file should be accepted by the file listing.
protected void	IFile.copyRegularFileTo(IFile dest)	Copies this file, assuming it is a regular file, to the specified destination.
void	IFile.copyTo(IFile dest)	Copies the file denoted by this logical filesystem object.
boolean	IFile.isDescendentOf(IFile file)	Returns whether this file is descendent of the given file.
java.lang.String	IFile.relativize(IFile other)	Relativizes the given file against this file.
void	IFile.renameTo(IFile dest)	Renames the file denoted by this logical filesystem object.

Uses of IFile in lumis.portal.filesystem.event

Methods in lumis.portal.filesystem.event that return IFile

Modifier and Type	Method	Description
IFile	FileSystemEvent.getPortalFile()	Returns the affected file or folder.

Constructors in lumis.portal.filesystem.event with parameters of type IFile

Constructor	Description
ClusterFileSystemAddEvent(IFile file)	Creates a new cluster add filesystem event.
ClusterFileSystemDeleteEvent(IFile file)	Creates a new cluster delete filesystem event.
ClusterFileSystemUpdateEvent(IFile file)	Creates a new cluster update filesystem event.
FileSystemAddEvent(IFile file)	Deprecated. Creates a new filesystem add event.
FileSystemDeleteEvent(IFile file)	Deprecated. Creates a new filesystem delete event.
FileSystemEvent(IFile file)	Creates a new filesystem event.
FileSystemUpdateEvent(IFile file)	Deprecated. Creates a new filesystem update event.

Uses of IFile in lumis.portal.filesystem.impl

Subclasses of IFile in lumis.portal.filesystem.impl

Modifier and Type	Class	Description
class	ClusterMirroredLocalDataFile	A local data file that has its changes replicated over the cluster.
class	LocalDataFile	Local data file.

Methods in lumis.portal.filesystem.impl that return IFile

Modifier and Type	Method	Description
IFile	ClusterMirroredFileSystem.getFile(PortalFilePath portalFilePath)
IFile	SingleCopyFileSystem.getFile(PortalFilePath portalFilePath)

Methods in lumis.portal.filesystem.impl with parameters of type IFile

Modifier and Type	Method	Description
static java.io.File	FileSystemInternalUtil.getSingleCopyFileFile(IFile file)	Returns the related file of the given IFile if it is an instance of SingleCopyFile.

Uses of IFile in lumis.portal.healthmonitor

Methods in lumis.portal.healthmonitor with parameters of type IFile

Modifier and Type	Method	Description
protected Tuple2<byte[],java.lang.Long>	HealthCheckGeneral.readFileOnDisk(IFile file)	Method to read a file from disk.
protected long	HealthCheckGeneral.writeFileOnDisk(IFile file, byte[] input)	Method to write a file with the given input array as the content.

Uses of IFile in lumis.portal.structure.sync

Methods in lumis.portal.structure.sync that return IFile

Modifier and Type	Method	Description
IFile	StructureSyncManager.getDefaultStructureRoot()
IFile	SyncInSelectedElement.getFile()	Returns this element's serialized file or folder.

Methods in lumis.portal.structure.sync with parameters of type IFile

Modifier and Type	Method	Description
static <T extends IFileElement> T	SyncUtil.read(java.lang.Class<T> clazz, IFile file, ChannelResume currentChannel)	Reads a structure file.
void	IStructureSyncManager.syncIn(java.lang.String rootChannelId, java.util.Set<java.lang.String> selectedElements, java.lang.String processId, IFile structureRoot, boolean clearHtmlCache)	Synchronizes a structure from the file system to the portal database.
void	IStructureSyncManager.syncIn(java.lang.String rootChannelId, java.util.Set<java.lang.String> selectedElements, java.lang.String processId, IFile structureRoot, boolean clearHtmlCache, java.util.Collection<IComponent> removedComponents)	Synchronizes a structure from the file system to the portal database.
void	StructureSyncManager.syncIn(java.lang.String rootChannelId, java.util.Set<java.lang.String> selectedElements, java.lang.String processId, IFile structureRoot, boolean clearHtmlCache)
void	StructureSyncManager.syncIn(java.lang.String rootChannelId, java.util.Set<java.lang.String> selectedElements, java.lang.String processId, IFile structureRoot, boolean clearHtmlCache, java.util.Collection<IComponent> removedComponents)
lumis.portal.structure.sync.ChannelHierarchy	SyncOutProcessor.syncOut(java.lang.String rootChannelId, IFile rootDir, java.lang.String processId, java.util.Set<java.lang.String> globalGroupsToBeExported, boolean isSyncOut)	Synchronizes the structure of a channel hierarchy from the portal to the file system.
static void	SyncUtil.writeIfModified(IFileElement obj, IFile file, ChannelResume currentChannel)	Writes a structure file, only if the semantics in the object is different.

Constructors in lumis.portal.structure.sync with parameters of type IFile

Constructor	Description
SyncInSelectedElement(IFile structureRoot, java.lang.String path)

Uses of IFile in lumis.portal.theme

Methods in lumis.portal.theme that return IFile

Modifier and Type	Method	Description
static IFile	ThemeUtil.getThemeRootDir(java.lang.String themePath)

Uses of IFile in lumis.portal.user

Methods in lumis.portal.user that return IFile

Modifier and Type	Method	Description
IFile	IUserManagerSPI.getUserProfileImageContentTypeFile(java.lang.String userId)	Returns the user's profile image content type file.
IFile	UserManager.getUserProfileImageContentTypeFile(java.lang.String userId)
IFile	IUserManagerSPI.getUserProfileImageFile(java.lang.String userId)	Returns the user's profile image file.
IFile	UserManager.getUserProfileImageFile(java.lang.String userId)

Uses of IFile in lumis.portal.webfilereplication

Methods in lumis.portal.webfilereplication with parameters of type IFile

Modifier and Type	Method	Description
void	FTPFileReplicator.delete(IFile file)
void	IFileReplicator.delete(IFile file)	Removes a file or directory from the replication destination.
void	LocalFileReplicator.delete(IFile file)
void	FTPFileReplicator.write(IFile file)
void	IFileReplicator.write(IFile file)	Writes a file or directory on the replication destination.
void	LocalFileReplicator.write(IFile file)

Uses of IFile in lumis.service.portalmanagement.deployment

Methods in lumis.service.portalmanagement.deployment with parameters of type IFile

Modifier and Type	Method	Description
protected void	DeploymentProcessActionHandler.generateEclipseIntegrationFiles(java.lang.String modulePath, IFile moduleAbsolutePath, java.lang.String moduleName)
protected void	DeploymentProcessActionHandler.generateModuleMavenFiles(java.lang.String modulePath, IFile moduleAbsolutePath, java.lang.String moduleName, java.lang.String moduleId)

Uses of IFile in lumis.service.portalmanagement.deployment.moduleeditor

Methods in lumis.service.portalmanagement.deployment.moduleeditor that return IFile

Modifier and Type	Method	Description
protected IFile	ModuleEditorResource.getModuleDir(java.lang.String moduleId)

Uses of IFile in lumis.service.tagmanager.util

Methods in lumis.service.tagmanager.util that return IFile

Modifier and Type	Method	Description
static IFile	TagManagerUtil.getFirstScriptFile(ServiceInstanceConfig serviceInstanceConfig)	Returns the ltm.js file.
static IFile	TagManagerUtil.getSecondScriptFile(ServiceInstanceConfig serviceInstanceConfig)	Returns the ltmimpl.js file.

Uses of IFile in lumis.service.websitefiles

Methods in lumis.service.websitefiles that return IFile

Modifier and Type	Method	Description
protected IFile	WebsiteFilesResource.getWebsiteFilesDir(java.lang.String websiteFilesId)	Returns a file object that represents website files root folder.

Uses of IFile in lumis.util

Methods in lumis.util with parameters of type IFile

Modifier and Type	Method	Description
static void	FileUtil.extractZip(java.io.InputStream inputStream, IFile destDir)	Extracts an input stream in ZIP format to the file system.
static org.w3c.dom.Document	XmlUtil.getDocument(IFile xmlFile)	Returns the Document associated with the given file.
static void	FileUtil.zipDir(IFile dirToZip, java.lang.String dirZipRelativePath, java.util.zip.ZipOutputStream zos)	Zips a directory recursively into the given zip output stream.
static void	FileUtil.zipDir(IFile dirToZip, java.util.zip.ZipOutputStream zos)	Zips a directory recursively into the given zip output stream.