com.powsybl.afs

Class AppData

java.lang.Object

com.powsybl.afs.AppData

All Implemented Interfaces:

java.lang.AutoCloseable

public class AppData
extends java.lang.Object
implements java.lang.AutoCloseable

An instance of AppData is the root of an application file system. Usually, an application will only have one instance of AppData. It is the first entrypoint of AFS, through which you can access to individual AppFileSystem objects.

   //Get AppData instance.
   AppData appData = ...

   //Print file system names to console
   appData.getFileSystems().stream().map(AppFileSystem::getName).forEach(System.out::println);

   //Get file system with name "fs1"
   AppFileSystem fs1 = appData.getFileSystem("fs1");

   //Get root folder of "fs1"
   Folder root = fs1.getRootFolder();

   //Get the node of type Project at /folder1/folder2/my_project, if it exists.
   Optional<Project> project = root.getChild(Project.class, "folder1", "folder2", "my_project");

   ...

 

Constructor Summary

Constructors

Constructor and Description
AppData(ComputationManager shortTimeExecutionComputationManager, ComputationManager longTimeExecutionComputationManager)
AppData(ComputationManager shortTimeExecutionComputationManager, ComputationManager longTimeExecutionComputationManager, java.util.List<AppFileSystemProvider> fileSystemProviders)
AppData(ComputationManager shortTimeExecutionComputationManager, ComputationManager longTimeExecutionComputationManager, java.util.List<AppFileSystemProvider> fileSystemProviders, java.util.List<FileExtension> fileExtensions, java.util.List<ProjectFileExtension> projectFileExtensions, java.util.List<ServiceExtension> serviceExtensions)

Method Summary

Modifier and Type	Method and Description
void	addFileSystem(AppFileSystem fileSystem)
void	close() Closes any resources used by underlying file systems.
AppFileSystem	getFileSystem(java.lang.String name) Gets a file system by its name.
java.util.Collection<AppFileSystem>	getFileSystems() The list of available file systems.
ComputationManager	getLongTimeExecutionComputationManager()
java.util.Optional<Node>	getNode(java.lang.String pathStr)
java.util.Set<java.lang.Class<? extends ProjectFile>>	getProjectFileClasses()
java.util.List<java.lang.String>	getRemotelyAccessibleFileSystemNames() Gets the list of remotely accessible file systems.
ListenableAppStorage	getRemotelyAccessibleStorage(java.lang.String fileSystemName) Gets low level storage interface for remotely accessible file systems.
ComputationManager	getShortTimeExecutionComputationManager()
void	setTokenProvider(SecurityTokenProvider tokenProvider)

Methods inherited from class java.lang.Object

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

Constructor Detail

AppData

public AppData(ComputationManager shortTimeExecutionComputationManager,
               ComputationManager longTimeExecutionComputationManager)

AppData

public AppData(ComputationManager shortTimeExecutionComputationManager,
               ComputationManager longTimeExecutionComputationManager,
               java.util.List<AppFileSystemProvider> fileSystemProviders)

AppData

public AppData(ComputationManager shortTimeExecutionComputationManager,
               ComputationManager longTimeExecutionComputationManager,
               java.util.List<AppFileSystemProvider> fileSystemProviders,
               java.util.List<FileExtension> fileExtensions,
               java.util.List<ProjectFileExtension> projectFileExtensions,
               java.util.List<ServiceExtension> serviceExtensions)

Method Detail

addFileSystem

public void addFileSystem(AppFileSystem fileSystem)

getFileSystems

public java.util.Collection<AppFileSystem> getFileSystems()

The list of available file systems.

getFileSystem

public AppFileSystem getFileSystem(java.lang.String name)

Gets a file system by its name.

setTokenProvider

public void setTokenProvider(SecurityTokenProvider tokenProvider)

getNode

public java.util.Optional<Node> getNode(java.lang.String pathStr)

getProjectFileClasses

public java.util.Set<java.lang.Class<? extends ProjectFile>> getProjectFileClasses()

getShortTimeExecutionComputationManager

public ComputationManager getShortTimeExecutionComputationManager()

getLongTimeExecutionComputationManager

public ComputationManager getLongTimeExecutionComputationManager()

getRemotelyAccessibleFileSystemNames

public java.util.List<java.lang.String> getRemotelyAccessibleFileSystemNames()

Gets the list of remotely accessible file systems. Should not be used by the AFS API users.

getRemotelyAccessibleStorage

public ListenableAppStorage getRemotelyAccessibleStorage(java.lang.String fileSystemName)

Gets low level storage interface for remotely accessible file systems. Should not be used by the AFS API users.

close

public void close()

Closes any resources used by underlying file systems.

Specified by:

close in interface java.lang.AutoCloseable