FileFlows.ServerShared
A logger that outputs to the console
Logs an information message
Any arguments for the log message
Logs an debug message
Any arguments for the log message
Logs an warning message
Any arguments for the log message
Logs an error message
Any arguments for the log message
Gets a tail of the log
NOTE: NOT IMPLEMENTED
The number of lines to fetch
NOT IMPLEMENTED
Gets the instance of the ILogger being used
A Logger that writes its output to file
Creates a file logger
The path where to save the log file to
The prefix to use for the log file name
Logs an information message
Any arguments for the log message
Logs an debug message
Any arguments for the log message
Logs an warning message
Any arguments for the log message
Logs an error message
Any arguments for the log message
Gets an isntance of the ILogger being used
Gets a tail of the log
NOTE: NOT IMPLEMENTED
The number of lines to fetch
NOT IMPLEMENTED
Globals variables
Gets the version of FileFlows
Gets if this is running on Windows
Gets if this is running on linux
Gets if this is running on Mac
Gets or sets if this node is running inside a docker container
A helper class to manage the directories used by FileFlows Server and Node
Gets if this is a Docker instance or not
Gets if this is a Node or Server
Initializes the Directory Helper
True if running inside a docker
True if running on a node
Gets the base directory of FileFlows
eg %appdata%\FileFlows
Inits the logging directory and moves any files if they need to be moved
Inits the data directory and moves any files if they need to be moved
Gets the logging directory
Gets the directory where library file logs are stored
Gets the data directory
Gets the directory the database is saved in
Gets the flow runner directory
Gets the logging directory
Gets the location of the encryption key file
Gets the location of the node configuration file
A helper for interacting with files
Removes illegal file/path characters from a string
the string to clean
the original string with all illegal characters removed
Calculates a fingerprint for a file
The filename
The fingerprint
Helper used for UI Forms
Gets the form fields of a give type of object
The type of object to load the form fields of
The model used to bind to the form fields
A list of all form fields
This class will allow hot reloading of an plugin assembly so they can be update
This class should return nothing from a Plugin assembly and just common C# objects
Gets a list of all the plugins directories
a list of all the plugins directories
This needs to return an instance so the FlowExecutor can use it...
The flow part
an instance of the plugin node
The time helper provides help methods regarding scheduling
Gets the integer index of the current time quarter
A time quarter is a 15minute block, starting on Sunday at midnight.
The integer index of the current time quater
Checks if the current time is in the supplied schedule
The schedule to check
true if the current time is within the schedule
A logger that outputs to the console
Logs an information message
Any arguments for the log message
Logs an debug message
Any arguments for the log message
Logs an warning message
Any arguments for the log message
Logs an error message
Any arguments for the log message
Gets a tail of the log
NOTE: NOT IMPLEMENTED
The number of lines to fetch
NOT IMPLEMENTED
Gets the instance of the ILogger being used
The registration model data used when registering a node with the FileFlows server
Gets or sets the address (hostname or IP aaddres) of the node
Gets or sets the temporary path used by this node
Gets or sets the number of flow runners this node can run
Gets or sets if this node is enabled
Gets or sets any mappings this node uses
Mappings allow a file or folder local to the Server to be mapped to a location local to the Node
Gets or sets the type of operating system this node is running on
Gets or sets the version of this node
Mapping for server files and folders to files and folders local to a node
Gets or sets the address on the server to map
Gets or sets the local equivalent path on the node
Interface for a Flow Runner, which is responsible for executing a flow and processing files
Called when a flow execution starts
The information about the flow execution
The updated information
Called when the flow execution has completed
The information about the flow execution
a completed task
Called to update the status of the flow execution on the server
The information about the flow execution
a completed task
A flow runner which is responsible for executing a flow and processing files
Gets or sets the function that will load the flow runner when Load is called
This is used in unit testing to mock this runner
Loads a Flow Runner instance and returns it
a flow runner instance
Called when a flow execution starts
The information about the flow execution
The updated information
Called when the flow execution has completed
The information about the flow execution
a completed task
Called to update the status of the flow execution on the server
The information about the flow execution
a completed task
Interface for communicating with FileFlows server for flows
Gets a flow by its UID
The UID of the flow
An instance of the flow if found, otherwise null
Gets the Failure Flow for a specific library
This is the flow that is called if the flow fails
The UID of the library
An instance of the Failure Flow if found
Service for communicating with FileFlows server for flows
Gets or sets the function used to load an instance of the IFlowService
Loads an instance of the IFlowService
an instance of the IFlowService
Gets a flow by its UID
The UID of the flow
An instance of the flow if found, otherwise null
Gets the Failure Flow for a specific library
This is the flow that is called if the flow fails
The UID of the library
An instance of the Failure Flow if found
Interface for communicating with FileFlows server for library files
Gets the next library file queued for processing
The name of the node requesting a library file
The UID of the node
The UID of the worker on the node
If found, the next library file to process, otherwise null
Gets a library file by its UID
The UID of the library file
The library file if found, otherwise null
Deletes a library file
The UID of the library file
a completed task
Updates a library file
The library file to update
The newly updated library file
Saves the full library file log
The UID of the library file
The full plain text log to save
If it was successfully saved or not
Tests if a library file exists on server.
This is used to test if a mapping issue exists on the node, and will be called if a Node cannot find the library file
The UID of the library file
True if it exists on the server, otherwise false
Service for communicating with FileFlows server for library files
Gets or sets a function to load an instance of ILibraryFileService by the Load function
Loads an instance of the ILibraryFileService
an instance of the ILibraryFileService
Deletes a library file
The UID of the library file
a completed task
Tests if a library file exists on server.
This is used to test if a mapping issue exists on the node, and will be called if a Node cannot find the library file
The UID of the library file
True if it exists on the server, otherwise false
Gets a library file by its UID
The UID of the library file
The library file if found, otherwise null
Gets the next library file queued for processing
The name of the node requesting a library file
The UID of the node
The UID of the worker on the node
If found, the next library file to process, otherwise null
Saves the full library file log
The UID of the library file
The full plain text log to save
If it was successfully saved or not
Updates a library file
The library file to update
The newly updated library file
Interface for communicating with FileFlows server for libraries
Gets a library by its UID
The UID of the library
An instance of the library if found
Service for communicating with FileFlows server for libraries
Gets or sets a function to load an instance of a ILibraryService
Loads an instance of the library service
an instance of the library service
Gets a library by its UID
The UID of the library
An instance of the library if found
An interface for communicating with the server for all Processing Node related actions
Gets a processing node by its physical address
The address (hostname or IP address) of the node
An instance of the processing node
Gets an instance of the internal processing node
an instance of the internal processing node
Gets a tool path by name
The name of the tool
a tool path
Clears all workers on the node.
This is called when a node first starts up, if a node crashed when workers were running this will reset them
The UID of the node
a completed task
An Service for communicating with the server for all Processing Node related actions
Gets or sets a function used to load new instances of the service
Loads an instance of the node service
an instance of the node service
Clears all workers on the node.
This is called when a node first starts up, if a node crashed when workers were running this will reset them
The UID of the node
a completed task
Gets an instance of the internal processing node
an instance of the internal processing node
Gets a tool path by name
The name of the tool
a tool path
Gets a processing node by its physical address
The address (hostname or IP address) of the node
An instance of the processing node
Registers a node with FileFlows
The URL of the FileFlows Server
The address (Hostname or IP Address) of the node
The temporary path location of the node
The amount of flow runners this node can execute
If this node is enabled or not
Any mappings for the node
An instance of the registered node
If fails to register, an exception will be thrown
Plugin Service interface
Get all plugin infos
all plugin infos
Updates plugin info
the plugin info
the updated plugininfo
Download a plugin
the plugin to download
the byte data of the plugin
Gets the settings json for a plugin
the name of the plugin package
the settings json
Plugin service
Gets or sets a function used to load new instances of the service
Loads an instance of the plugin service
an instance of the plugin service
Download a plugin
the plugin to download
the byte data of the plugin
Get all plugin infos
all plugin infos
Gets the settings json for a plugin
the name of the plugin package
the settings json
Updates plugin info
the plugin info
the updated plugininfo
This not yet implemented
A service lets you communicate with the FileFLows server
Gets or sets the Base URL of the FileFlows server
Interface for the Settings service which allows accessing of all the system settings
Gets the system settings
the system settings
An instance of the Settings Service which allows accessing of the system settings
A loader to load an instance of the Settings
Loads an instance of the settings service
an instance of the settings service
Gets the system settings
the system settings
An interface of the System Service
Gets the version from the server
the server version
Gets the node updater binary
the node updater binary
Gets an node update available
the current version of the node
if there is a node update available, returns the update
A System Service
Gets or sets the loader for SystemService
Loads an instance of SystemService
an instance of SystemService
Gets the version from the server
the server version
Gets the node updater binary
the node updater binary
Gets an node update available
the current version of the node
if there is a node update available, returns the update
Worker that will automatically update the system
Gets if there is an updated pending installation
Constructs an instance of a Update Worker
The script to execute in the upgrade zip file
how many minute between checks
Gets if the update can run
Quits the current application
Runs a check for update and if found will download it
A update has been downloaded
Prepares the application to be shutdown
Called after the update has been downloaded, but before it has run
Downloads an update
The update file
Gets if auto updates are enabled
if auto updates are enabled
Downloads a file and saves it
The url of the file to download
the location to save the file
throws if the file fails to download
A worker that will run at a set schedule
Available schedule types
Gets or sets the amount seconds between each execution of this worker
Gets or sets the schedule of this worker
Creates an instance of a worker
the type of schedule this worker runs at
the interval of this worker
Start the worker
Stop the worker
A manager for the workers that run in the system
Starts a list of workers and keeps track of them
A list of workers to start
Stops all the currently running workers