Package ghidra.framework.store.remote

Class RemoteFileSystem

java.lang.Object

ghidra.framework.store.remote.RemoteFileSystem

All Implemented Interfaces:

RemoteAdapterListener, FileSystem

public class RemoteFileSystem
extends java.lang.Object
implements FileSystem, RemoteAdapterListener

RemoteFileSystem provides access to versioned FolderItem's which exist within a Repository-based directory structure. FolderItem caching is provided by the remote implementation which is intended to be shared across multiple clients.

FolderItem's must be checked-out to create new versions.

FileSystemListener's will be notified of all changes made within the Repository.

Field Summary

Fields inherited from interface ghidra.framework.store.FileSystem

SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor	Description
RemoteFileSystem(RepositoryAdapter repository)	Construct a new remote file system which corresponds to a remote repository.

Method Summary

Modifier and Type	Method	Description
void	addFileSystemListener(FileSystemListener listener)	Adds the given listener to be notified of file system changes.
void	connectionStateChanged(java.lang.Object adapter)	Callback notification indicating the remote object connection state has changed.
DatabaseItem	createDatabase(java.lang.String parentPath, java.lang.String name, java.lang.String fileID, BufferFile bufferFile, java.lang.String comment, java.lang.String contentType, boolean resetDatabaseId, TaskMonitor monitor, java.lang.String user)	Create a new database item within the specified parent folder using the contents of the specified BufferFile.
ManagedBufferFile	createDatabase(java.lang.String parentPath, java.lang.String name, java.lang.String fileID, java.lang.String contentType, int bufferSize, java.lang.String user, java.lang.String projectPath)	Create a new empty database item within the specified parent folder.
DataFileItem	createDataFile(java.lang.String parentPath, java.lang.String name, java.io.InputStream istream, java.lang.String comment, java.lang.String contentType, TaskMonitor monitor)	Creates a new empty data file within the specified parent folder.
FolderItem	createFile(java.lang.String parentPath, java.lang.String name, java.io.File packedFile, TaskMonitor monitor, java.lang.String user)	Creates a new file item from a packed file.
void	createFolder(java.lang.String parentPath, java.lang.String folderName)	Creates a new subfolder within the specified parent folder.
void	deleteFolder(java.lang.String folderPath)	Delete the specified folder.
void	dispose()	Cleanup & release resources
boolean	fileExists(java.lang.String folderPath, java.lang.String itemName)	Returns true if the file exists
boolean	folderExists(java.lang.String folderPath)	Returns true if the folder specified by the path exists.
java.lang.String[]	getFolderNames(java.lang.String parentPath)	Return a list of subfolders (by name) that are stored within the specified folder path.
FolderItem	getItem(java.lang.String fileID)	Returns the FolderItem specified by its unique File-ID
FolderItem	getItem(java.lang.String folderPath, java.lang.String name)	Returns the FolderItem in the given folder with the given name
int	getItemCount()	Returns the number of folder items contained within this file-system.
java.lang.String[]	getItemNames(java.lang.String folderPath)	Returns a list of the folder item names contained in the given folder.
java.lang.String	getUserName()	Get user name associated with this filesystem.
boolean	isOnline()	Returns true if file-system is on-line.
boolean	isReadOnly()	Returns true if file-system is read-only.
boolean	isShared()	Returns true if this file system is shared
boolean	isVersioned()	Returns true if the file-system requires check-outs when modifying folder items.
void	moveFolder(java.lang.String parentPath, java.lang.String folderName, java.lang.String newParentPath)	Move the specified folder to the path specified by newFolderPath.
void	moveItem(java.lang.String parentPath, java.lang.String name, java.lang.String newParentPath, java.lang.String newName)	Moves the specified item to a new folder.
void	removeFileSystemListener(FileSystemListener listener)	Removes the listener from being notified of file system changes.
void	renameFolder(java.lang.String parentPath, java.lang.String folderName, java.lang.String newFolderName)	Renames the specified folder to a new name.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteFileSystem

public RemoteFileSystem(RepositoryAdapter repository)

Construct a new remote file system which corresponds to a remote repository.

Parameters:

repository - remote Repository

Throws:

java.io.IOException

Method Detail

getUserName

public java.lang.String getUserName()

Description copied from interface: FileSystem

Get user name associated with this filesystem. In the case of a remote filesystem this will correspond to the name used during login/authentication. A null value may be returned if user name unknown.

Specified by:

getUserName in interface FileSystem

addFileSystemListener

public void addFileSystemListener(FileSystemListener listener)

Description copied from interface: FileSystem

Adds the given listener to be notified of file system changes.

Specified by:

addFileSystemListener in interface FileSystem

Parameters:

listener - the listener to be added.

removeFileSystemListener

public void removeFileSystemListener(FileSystemListener listener)

Description copied from interface: FileSystem

Removes the listener from being notified of file system changes.

Specified by:

removeFileSystemListener in interface FileSystem

isVersioned

public boolean isVersioned()

Description copied from interface: FileSystem

Returns true if the file-system requires check-outs when modifying folder items.

Specified by:

isVersioned in interface FileSystem

isOnline

public boolean isOnline()

Description copied from interface: FileSystem

Returns true if file-system is on-line.

Specified by:

isOnline in interface FileSystem

isReadOnly

public boolean isReadOnly()
                   throws java.io.IOException

Description copied from interface: FileSystem

Returns true if file-system is read-only.

Specified by:

isReadOnly in interface FileSystem

Throws:

java.io.IOException

isShared

public boolean isShared()

Description copied from interface: FileSystem

Returns true if this file system is shared

Specified by:

isShared in interface FileSystem

getItemCount

public int getItemCount()
                 throws java.io.IOException,
                        java.lang.UnsupportedOperationException

Description copied from interface: FileSystem

Returns the number of folder items contained within this file-system.

Specified by:

getItemCount in interface FileSystem

Throws:

java.io.IOException

java.lang.UnsupportedOperationException - if file-system does not support this operation

getItemNames

public java.lang.String[] getItemNames(java.lang.String folderPath)
                                throws java.io.IOException

Description copied from interface: FileSystem

Returns a list of the folder item names contained in the given folder.

Specified by:

getItemNames in interface FileSystem

Parameters:

folderPath - the path of the folder.

Returns:

a list of folder item names.

Throws:

java.io.IOException

getItem

public FolderItem getItem(java.lang.String folderPath,
                          java.lang.String name)
                   throws java.io.IOException

Description copied from interface: FileSystem

Returns the FolderItem in the given folder with the given name

Specified by:

getItem in interface FileSystem

Parameters:

folderPath - the folder path containing the item.

name - the name of the item.

Returns:

the FolderItem with the given folderPath and name, or null if it doesn't exist.

Throws:

java.io.IOException - if IO error occurs.

getItem

public FolderItem getItem(java.lang.String fileID)
                   throws java.io.IOException,
                          java.lang.UnsupportedOperationException

Description copied from interface: FileSystem

Returns the FolderItem specified by its unique File-ID

Specified by:

getItem in interface FileSystem

Parameters:

fileID - the items unique file ID

Returns:

the FolderItem with the given folderPath and name, or null if it doesn't exist.

Throws:

java.io.IOException - if IO error occurs.

java.lang.UnsupportedOperationException - if file-system does not support this operation

getFolderNames

public java.lang.String[] getFolderNames(java.lang.String parentPath)
                                  throws java.io.IOException

Description copied from interface: FileSystem

Return a list of subfolders (by name) that are stored within the specified folder path.

Specified by:

getFolderNames in interface FileSystem

Throws:

java.io.FileNotFoundException - if folder path does not exist.

java.io.IOException - if IO error occurs.

createFolder

public void createFolder(java.lang.String parentPath,
                         java.lang.String folderName)

Description copied from interface: FileSystem

Creates a new subfolder within the specified parent folder.

Specified by:

createFolder in interface FileSystem

Parameters:

parentPath - folder path of parent

folderName - name of new subfolder

createDatabase

public ManagedBufferFile createDatabase(java.lang.String parentPath,
                                        java.lang.String name,
                                        java.lang.String fileID,
                                        java.lang.String contentType,
                                        int bufferSize,
                                        java.lang.String user,
                                        java.lang.String projectPath)
                                 throws InvalidNameException,
                                        java.io.IOException

Description copied from interface: FileSystem

Create a new empty database item within the specified parent folder. If this is a versioned file-system, the associated item is checked-out. The resulting checkoutId can be obtained from the returned buffer file.

Specified by:

createDatabase in interface FileSystem

Parameters:

parentPath - folder path of parent

name - new database name

fileID - file ID to be associated with new database or null

contentType - application defined content type

bufferSize - buffer size. If copying an existing BufferFile, the buffer size must be the same as the source file.

user - name of user creating item (required for versioned item)

projectPath - path of project in which database is checked-out (required for versioned item)

Returns:

an empty BufferFile open for read-write.

Throws:

InvalidNameException - if the name does not have all alphanumerics

java.io.FileNotFoundException - thrown if parent folder does not exist.

DuplicateFileException - if a folder item exists with this name

java.io.IOException - if an IO error occurs.

createDatabase

public DatabaseItem createDatabase(java.lang.String parentPath,
                                   java.lang.String name,
                                   java.lang.String fileID,
                                   BufferFile bufferFile,
                                   java.lang.String comment,
                                   java.lang.String contentType,
                                   boolean resetDatabaseId,
                                   TaskMonitor monitor,
                                   java.lang.String user)
                            throws InvalidNameException,
                                   java.io.IOException,
                                   CancelledException

Description copied from interface: FileSystem

Create a new database item within the specified parent folder using the contents of the specified BufferFile.

Specified by:

createDatabase in interface FileSystem

Parameters:

parentPath - folder path of parent

name - new database name

fileID - file ID to be associated with new database or null

bufferFile - data source

comment - version comment (used for versioned file system only)

contentType - application defined content type

resetDatabaseId - if true database ID will be reset for new Database

monitor - allows the database copy to be monitored and cancelled.

user - name of user creating item (required for versioned item)

Returns:

new DatabaseItem

Throws:

InvalidNameException - if the name does not have all alphanumerics

java.io.FileNotFoundException - thrown if parent folder does not exist.

DuplicateFileException - if a folder item exists with this name

java.io.IOException - if an IO error occurs.

CancelledException - if cancelled by monitor

createDataFile

public DataFileItem createDataFile(java.lang.String parentPath,
                                   java.lang.String name,
                                   java.io.InputStream istream,
                                   java.lang.String comment,
                                   java.lang.String contentType,
                                   TaskMonitor monitor)
                            throws InvalidNameException,
                                   java.io.IOException,
                                   CancelledException

Description copied from interface: FileSystem

Creates a new empty data file within the specified parent folder.

Specified by:

createDataFile in interface FileSystem

Parameters:

parentPath - folder path of parent

name - new data file name

comment - version comment (used for versioned file system only)

contentType - application defined content type

monitor - progress monitor (used for cancel support, progress not used since length of input stream is unknown)

Returns:

new data file

Throws:

InvalidNameException - if the name has illegal characters. all alphanumerics

DuplicateFileException - Thrown if a folderItem with that name already exists.

java.io.IOException - if an IO error occurs.

CancelledException - if cancelled by monitor

createFile

public FolderItem createFile(java.lang.String parentPath,
                             java.lang.String name,
                             java.io.File packedFile,
                             TaskMonitor monitor,
                             java.lang.String user)
                      throws InvalidNameException,
                             java.io.IOException,
                             CancelledException

Description copied from interface: FileSystem

Creates a new file item from a packed file. The content/item type must be determined from the input stream.

Specified by:

createFile in interface FileSystem

Parameters:

parentPath - folder path of parent

name - new data file name

packedFile - packed file data

monitor - progress monitor (used for cancel support, progress not used since length of input stream is unknown)

user - name of user creating item (required for versioned item)

Returns:

new item

Throws:

InvalidNameException - if the name has illegal characters. all alphanumerics

java.io.IOException - if an IO error occurs.

CancelledException - if cancelled by monitor

deleteFolder

public void deleteFolder(java.lang.String folderPath)
                  throws java.io.IOException

Description copied from interface: FileSystem

Delete the specified folder.

Specified by:

deleteFolder in interface FileSystem

Parameters:

folderPath - path of folder to be deleted

Throws:

FolderNotEmptyException - Thrown if the folder is not empty.

java.io.FileNotFoundException - if there is no folder with the given path name.

java.io.IOException - if error occured during delete.

moveFolder

public void moveFolder(java.lang.String parentPath,
                       java.lang.String folderName,
                       java.lang.String newParentPath)
                throws InvalidNameException,
                       java.io.IOException

Description copied from interface: FileSystem

Move the specified folder to the path specified by newFolderPath. The moved folder must not be an ancestor of the new Parent.

Specified by:

moveFolder in interface FileSystem

Parameters:

parentPath - path of parent folder that the moving folder currently resides in.

folderName - name of the folder within the parentPath to be moved.

newParentPath - path to where the folder is to be moved.

Throws:

InvalidNameException - if the new FolderPath contains an illegal file name.

java.io.FileNotFoundException - if the moved folder does not exist.

DuplicateFileException - if folder with the same name exists within the new parent folder

FileInUseException - if any file within this folder or its decendents are in-use or checked-out

java.io.IOException - if an IO error occurs.

renameFolder

public void renameFolder(java.lang.String parentPath,
                         java.lang.String folderName,
                         java.lang.String newFolderName)
                  throws InvalidNameException,
                         java.io.IOException

Description copied from interface: FileSystem

Renames the specified folder to a new name.

Specified by:

renameFolder in interface FileSystem

Parameters:

parentPath - the parent folder of the folder to be renamed.

folderName - the current name of the folder to be renamed.

newFolderName - the name the folder to be renamed to.

Throws:

InvalidNameException - if the new FolderName contains an illegal file name.

java.io.FileNotFoundException - if the folder to be renamed does not exist.

DuplicateFileException - if folder with the new name already exists.

FileInUseException - if any file within this folder or its decendents are in-use or checked-out

java.io.IOException - if an IO error occurs.

moveItem

public void moveItem(java.lang.String parentPath,
                     java.lang.String name,
                     java.lang.String newParentPath,
                     java.lang.String newName)
              throws InvalidNameException,
                     java.io.IOException

Description copied from interface: FileSystem

Moves the specified item to a new folder.

Specified by:

moveItem in interface FileSystem

Parameters:

parentPath - path of folder containing the item.

name - name of the item to be moved.

newParentPath - path of folder where item is to be moved.

Throws:

InvalidNameException - if the newName is invalid

java.io.FileNotFoundException - if the item does not exist.

DuplicateFileException - if item with the same name exists within the new parent folder.

FileInUseException - if the item is in-use or checked-out

java.io.IOException - if an IO error occurs.

folderExists

public boolean folderExists(java.lang.String folderPath)
                     throws java.io.IOException

Description copied from interface: FileSystem

Returns true if the folder specified by the path exists.

Specified by:

folderExists in interface FileSystem

Parameters:

folderPath - the name of the folder to check for existence.

Returns:

true if the folder exists.

Throws:

java.io.IOException - if an IO error occurs.

fileExists

public boolean fileExists(java.lang.String folderPath,
                          java.lang.String itemName)
                   throws java.io.IOException

Description copied from interface: FileSystem

Returns true if the file exists

Specified by:

fileExists in interface FileSystem

Parameters:

folderPath - the folderPath of the folder that may contain the file.

itemName - the name of the file to check for existence.

Throws:

java.io.IOException - if an IO error occurs.

connectionStateChanged

public void connectionStateChanged(java.lang.Object adapter)

Description copied from interface: RemoteAdapterListener

Callback notification indicating the remote object connection state has changed.

Specified by:

connectionStateChanged in interface RemoteAdapterListener

Parameters:

adapter - remote interface adapter (e.g., RepositoryServerAdapter).

dispose

public void dispose()

Description copied from interface: FileSystem

Cleanup & release resources

Specified by:

dispose in interface FileSystem