|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.systems.core.SystemResourceManager
Static methods that manage the workbench resource tree for the remote systems project. All code in the framework uses this to access the file system for save/restore purposes. By limiting all access to one place, we simply changes should we decide to change the underlying file system map.
Assumptions
The following maps the file system folders to the methods to retrieve them...
FOLDER METHOD TO RETRIEVE HANDLE
============================ ===================================================
-RemoteSystemsConnections - getRemoteSystemsProject()
| - getProfileFolders() to get all subfolders
|
.--- TypeFilters (folder) - getTypeFiltersFolder()
| |
| .--- SubSystemFactoryID1 (folder) - getTypeFiltersFolder(SubSystemFactory)
| | .--- typefilters.xmi (file)
| .--- SubSystemFactoryID2 (folder)
| .--- typefilters.xmi (file)
|
.--- Team (folder) - getProfileFolder(SystemProfile/"team")
| |
| |--- profile.xmi(file)
| |
| |--- Connections (folder) - getConnectionsFolder(SystemProfile/SystemConnectionPool/"team")
| | | - deduceConnectionNames(SystemProfile/SystemConnectionPool/"team") to get list of subfolder names
| | | or getConnectionFolders(SystemProfile/SystemConnectionPool/"team") to get list of subfolder objects
| | |--- conn1 (folder) - getConnectionFolder(SystemProfile/SystemConnectionPool/"team", SystemConnection/"conn1")
| | | |---connection.xmi (file)
| | | | - getSubSystemsFolders(SystemConnection conn1) to get all subfolders
| | | .---SubSystemFactoryID1 (folder) - getSubSystemsFolder(SystemConnection conn1, SubSystemFactory/"SubSystemFactoryID1")
| | | - deduceSubSystemFileNames(SystemConnection conn1, SubSystemFactory) to get list of file names
| | | |---subsystem1.xmi (file)
| | | .---subsystem2.xmi (file)
| | | .---SubSystemFactoryID2 (folder) - getSubSystemsFolder(SystemConnection conn2, SubSystemFactory/"SubSystemFactoryID2")
| | | |---subsystem1.xmi (file)
| | | .---subsystem2.xmi (file)
| | .--- conn2 (folder) - getConnectionFolder(SystemProfile/SystemConnectionPool/"team", SystemConnection/"conn2")
| | |---connection.xmi (file)
| | .---SubSystemFactoryID1 (folder) - getSubSystemsFolder(SystemConnection conn1, SubSystemFactory/"SubSystemFactoryID1")
| | |---subsystem1.xmi (file)
| | .---subsystem2.xmi (file)
| | .---SubSystemFactoryID2 (folder) - getSubSystemsFolder(SystemConnection conn2, SubSystemFactory/"SubSystemFactoryID2")
| | |---subsystem1.xmi (file)
| | .---subsystem2.xmi (file)
| |
| .--- Filters (folder) - getFiltersFolder(SystemProfile/"team")
| | | - getFiltersFolders(SystemProfile/"team") to get all subfolders
| | |--- SubSystemFactoryID1 (folder) - getFilterPoolsFolder(SystemProfile/"team", SubSystemFactory)
| | | | - getFilterPoolsFolders(SystemProfile/"team", SubSystemFactory) to get all subfolders
| | | |--- FilterPool1 (folder) - getFilterPoolFolder(SystemProfile/"team", SubSystemFactory, SystemFilterPool/"FilterPool1")
| | | | |--- filter1.xmi (file)
| | | | .--- filter2.xmi (file)
| | | .--- FilterPool2 (folder) - getFilterPoolFolder(SystemProfile/"team", SubSystemFactory, SystemFilterPool/"FilterPool2")
| | | |--- filter1.xmi (file)
| | | .--- filter2.xmi (file)
| | |
| | .--- SubSystemFactoryID2 (folder) - getFilterPoolsFolder(SystemProfile/"team", SubSystemFactory)
| | | - getFilterPoolsFolders(SystemProfile/"team", SubSystemFactory) to get all subfolders
| | |--- FilterPool1 (folder) - getFilterPoolFolder(SystemProfile/"team", SubSystemFactory, SystemFilterPool/"FilterPool1")
| | | |--- filter1.xmi (file)
| | | .--- filter2.xmi (file)
| | .--- FilterPool2 (folder) - getFilterPoolFolder(SystemProfile/"team", SubSystemFactory, SystemFilterPool/"FilterPool2")
| | |--- filter1.xmi (file)
| | .--- filter2.xmi (file)
| |
| .--- UserActions (folder) - getUserActionsFolder(SystemProfile/"team")
| |
| .--- SubSystemFactoryID1 (folder) - getUserActionsFolder(SystemProfile/"team", SubSystemFactory)
| | .--- actions.xml (file)
| .--- SubSystemFactoryID2 (folder)
| .--- actions.xml (file)
| .--- CompileCommands (folder) - getCompileCommandsFolder(SystemProfile/"team")
| |
| .--- SubSystemFactoryID1 (folder) - getCompileCommandsFolder(SystemProfile/"team", SubSystemFactory)
| | .--- compileCommands.xml (file)
| .--- SubSystemFactoryID2 (folder)
| .--- compileCommands.xml (file)
|
|
|
.--- Private (folder) - getProfileFolder(SystemProfile/"private")
| ...repeat...
| |
| |--- Connections (folder) - getConnectionsFolder(SystemProfile/SystemConnectionPool/"private")
| |
| .--- Filters (folder) - getFiltersFolder(SystemProfile/SystemFilterPoolManager/"private")
| | - getFiltersFolders(SystemProfile/SystemFilterPoolManager/"private") to get all subfolders
...
Field Summary | |
---|---|
static String |
copyright
|
Fields inherited from interface com.ibm.etools.systems.core.SystemResourceConstants |
---|
RESOURCE_COMPILECOMMANDS_FOLDER_NAME, RESOURCE_CONNECTIONS_FOLDER_NAME, RESOURCE_FILTERS_FOLDER_NAME, RESOURCE_PRIVATEPROFILE_NAME, RESOURCE_PROJECT_NAME, RESOURCE_TEAMPROFILE_NAME, RESOURCE_TEMPFILES_PROJECT_NAME, RESOURCE_TYPE_FILTERS_FOLDER_NAME, RESOURCE_USERACTIONS_FOLDER_NAME |
Constructor Summary | |
---|---|
SystemResourceManager()
|
Method Summary | |
---|---|
static String |
addPathTerminator(String path)
Ensure given path ends with path separator. |
static void |
addResourceChangeListener(IResourceChangeListener l)
Register a listener for resource change events on objects in our remote system project. |
protected static IProject |
createRemoteSystemsProjectInternal(IProject proj)
Create a remote systems project, plus the core subfolders required. |
static String[] |
deduceConnectionNames(String profileName)
Return a guess at the names of all connections given a profile name. |
static String[] |
deduceConnectionNames(SystemConnectionPool pool)
Return a guess at the names of all connections given a connnection pool. |
static String[] |
deduceConnectionNames(SystemProfile profile)
Return a guess at the names of all connections given a profile. |
static String[] |
deduceProfileNames()
Guess the profile names by itemizing all the root folders, and assuming any such folder that has a file in it named "profile.xmi" is indeed a profile whose name equals the folder name. |
static String[] |
deduceSubSystemsNames(SystemConnection conn,
SubSystemFactory ssFactory)
Return the names of the files in the folder for a particular subsystem factory for a particular connection. |
static void |
deleteFile(IFolder folder,
String fileName)
Delete a file |
static void |
deleteFolder(IFolder folder)
Delete a folder |
static void |
endResourceEventListening()
End event listening. |
static void |
ensureOnResourceEventListening()
Ensure event listening is on. |
protected static IFolder |
getCompileCommandsFolder(String profileName)
Get compile commands root folder given a system profile name |
static IFolder |
getCompileCommandsFolder(String profileName,
String factoryId)
Get compile commands root folder given a system profile name and subsystem factory Id. |
static IFolder |
getCompileCommandsFolder(String profileName,
SubSystemFactory ssFactory)
Get compile commands root folder given a system profile name and subsystem factory |
static IFolder |
getCompileCommandsFolder(SystemProfile profile,
SubSystemFactory ssFactory)
Get compile commands root folder given a system profile object and subsystem factory |
static IFolder |
getConnectionFolder(String profileName,
String connectionName)
Get connection folder for a given profile name for a given connection name |
static IFolder |
getConnectionFolder(SystemConnectionPool pool,
String connectionName)
Get connection folder for a given connection pool for a given connection name |
static IFolder |
getConnectionFolder(SystemConnectionPool pool,
SystemConnection connection)
Get connection folder for a given connection pool for a given connection object |
static IFolder |
getConnectionFolder(SystemProfile profile,
String connectionName)
Get connection folder for a given profile for a given connection name |
static IFolder |
getConnectionFolder(SystemProfile profile,
SystemConnection connection)
Get connection folder for a given profile for a given connection object |
protected static IFolder[] |
getConnectionFolders(IFolder parentFolder)
Each root folder of the profile folder is assumed to be a connection, if it has a file named connection.xmi |
static IFolder |
getConnectionsFolder(String profileName)
Get connections folder for a given profile name |
static IFolder |
getConnectionsFolder(SystemConnectionPool pool)
Get connections folder for a given connection pool |
static IFolder |
getConnectionsFolder(SystemProfile profile)
Get connections folder for a given profile |
static IFolder |
getFilterPoolFolder(String profileName,
SubSystemFactory ssFactory,
String poolFolderName)
Get a folder pool folder that holds filter pools, given a profile name and a subsystem factory and filter pool's folder name |
static IFolder |
getFilterPoolFolder(String profileName,
SubSystemFactory ssFactory,
SystemFilterPool pool)
Get a folder pool folder that holds filter pools, given a profile name and a subsystem factory and filter pool |
static IFolder |
getFilterPoolFolder(SystemProfile profile,
SubSystemFactory ssFactory,
String poolFolderName)
Get a folder pool folder that holds filter pools, given a profile and a subsystem factory and filter pool's folder name |
static IFolder |
getFilterPoolFolder(SystemProfile profile,
SubSystemFactory ssFactory,
SystemFilterPool pool)
Get a filter pool folder that holds filters, given a profile and a subsystem factory and filter pool |
static IFolder |
getFilterPoolsFolder(String profileName,
SubSystemFactory ssFactory)
Get filter pools folder for a given profile name and factory |
static IFolder |
getFilterPoolsFolder(SystemProfile profile,
SubSystemFactory ssFactory)
Get filter pools folder for a given profile and factory |
static IFolder[] |
getFilterPoolsFolders(String profileName,
SubSystemFactory ssFactory)
Get all subfolders of the filters folder for a given profile name and subsystem factory. |
static IFolder[] |
getFilterPoolsFolders(SystemProfile profile,
SubSystemFactory ssFactory)
Get all subfolders in a filters folder for a given profile and subsystem factory Each folder represents a filter pool. |
static IFolder |
getFiltersFolder(String profileName)
Get filters folder for a given profile name |
static IFolder |
getFiltersFolder(SystemProfile profile)
Get filters folder for a given profile |
static IFolder[] |
getFiltersFolders(String profileName)
Get all subfolders of the filters folder for a given profile name. |
static IFolder[] |
getFiltersFolders(SystemProfile profile)
Get all subfolders of the filters folder for a given profile. |
static String |
getFolderName(SubSystemFactory ssFactory)
Map a subsystem factory object to a folder name |
static String |
getFolderName(SystemConnection conn)
Map a system connection object to a folder name |
static String |
getFolderName(SystemFilterPool pool)
Map a filter pool name to a folder name Current algorith is that pool name equals folder name, but we use this method to allow flexibility in the future. |
static String |
getFolderPath(IFolder folder)
Given any folder, return its path as a string. |
static String |
getFolderPathWithTerminator(IFolder folder)
Given any folder, return its path as a string, and an ending '\' |
static IFolder |
getProfileFolder(String profileName)
Get profiles folder for a given profile name |
static IFolder |
getProfileFolder(SystemProfile profile)
Get profiles folder for a given profile |
static IFolder[] |
getProfileFolders()
Each root folder of the project is assumed to be a profile, if it has a file named profile.xmi |
static String |
getProfileName(SystemConnectionPool pool)
Map a connection pool name to a profile name. |
static String |
getProfileName(SystemFilterPoolManager mgr)
Map a filter pool manager name to a profile name Current algorith is that manager name equals profile name, but we use this method to allow flexibility in the future. |
static IProject |
getRemoteSystemsProject()
Get the default remote systems project. |
static IProject |
getRemoteSystemsTempFilesProject()
Get the default remote systems temp files project. |
protected static SystemResourceHelpers |
getResourceHelpers()
Return singleton of resource helpers object |
static IFolder |
getSubSystemsFolder(SystemConnection conn,
String factoryFolderName)
Return the folder containing subsystem objects for a given connection and given subsystem factory folder name |
static IFolder |
getSubSystemsFolder(SystemConnection conn,
SubSystemFactory ssFactory)
Return the folder containing subsystem objects for a given connection and given subsystem factory. |
static IFolder[] |
getSubSystemsFolders(SystemConnection conn)
Get the folders inside a connection object folder. |
static IFolder |
getTypeFiltersFolder()
Get the typeFilters root folder |
static IFolder |
getTypeFiltersFolder(String ssFactoryId)
Get the typeFilters sub-folder per subsystem factory id |
static IFolder |
getTypeFiltersFolder(SubSystemFactory ssFactory)
Get the typeFilters sub-folder per subsystem factory object |
protected static IFolder |
getUserActionsFolder(String profileName)
Get user defined actions root folder given a system profile name |
static IFolder |
getUserActionsFolder(String profileName,
String factoryId)
Get user defined actions root folder given a system profile name and subsystem factory Id. |
static IFolder |
getUserActionsFolder(String profileName,
SubSystemFactory ssFactory)
Get user defined actions root folder given a system profile name and subsystem factory |
static IFolder |
getUserActionsFolder(SystemProfile profile,
SubSystemFactory ssFactory)
Get user defined actions root folder given a system profile object and subsystem factory |
static boolean |
isFirstTime()
Return true if we just created the remote systems project for the first time. |
static void |
removeResourceChangeListener(IResourceChangeListener l)
Remove a listener for resource change events on an object in our remote system project. |
static void |
renameFile(IFolder folder,
String oldName,
String newName)
Rename a file |
static void |
renameFolder(IFolder folder,
String newName)
Rename a folder |
static void |
startResourceEventListening()
Start event listening. |
static boolean |
testIfResourceInUse(IResource resource)
Test if a resource is in use, prior to attempting to rename or delete it. |
static boolean |
testUserActionsFolder(String profileName,
SubSystemFactory ssFactory)
Test for existence of user defined actions root folder given a system profile name and subsystem factory |
static void |
turnOffResourceEventListening()
Turn off event listening. |
static void |
turnOnResourceEventListening()
Turn off event listening. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String copyright
Constructor Detail |
public SystemResourceManager()
Method Detail |
public static void turnOffResourceEventListening()
public static void turnOnResourceEventListening()
public static void ensureOnResourceEventListening()
public static void startResourceEventListening()
public static void endResourceEventListening()
public static void addResourceChangeListener(IResourceChangeListener l)
However, the event will only be fired if a change is made to that resource outside of the normal activities of the Remote Systems Framework, and only for resources within the Remote Systems Connection project.
public static void removeResourceChangeListener(IResourceChangeListener l)
public static IProject getRemoteSystemsProject()
public static IProject getRemoteSystemsTempFilesProject()
protected static IProject createRemoteSystemsProjectInternal(IProject proj)
public static boolean isFirstTime()
public static IFolder[] getProfileFolders()
public static String[] deduceProfileNames()
public static IFolder getProfileFolder(SystemProfile profile)
public static IFolder getProfileFolder(String profileName)
public static IFolder getConnectionsFolder(SystemProfile profile)
public static IFolder getConnectionsFolder(String profileName)
public static IFolder getConnectionsFolder(SystemConnectionPool pool)
public static IFolder getConnectionFolder(String profileName, String connectionName)
public static IFolder getConnectionFolder(SystemProfile profile, String connectionName)
public static IFolder getConnectionFolder(SystemProfile profile, SystemConnection connection)
public static IFolder getConnectionFolder(SystemConnectionPool pool, String connectionName)
public static IFolder getConnectionFolder(SystemConnectionPool pool, SystemConnection connection)
public static IFolder[] getSubSystemsFolders(SystemConnection conn)
public static IFolder getSubSystemsFolder(SystemConnection conn, SubSystemFactory ssFactory)
public static IFolder getSubSystemsFolder(SystemConnection conn, String factoryFolderName)
public static String[] deduceSubSystemsNames(SystemConnection conn, SubSystemFactory ssFactory)
public static String[] deduceConnectionNames(SystemProfile profile)
public static String[] deduceConnectionNames(SystemConnectionPool pool)
public static String[] deduceConnectionNames(String profileName)
protected static IFolder[] getConnectionFolders(IFolder parentFolder)
public static IFolder getFiltersFolder(SystemProfile profile)
public static IFolder getFiltersFolder(String profileName)
public static IFolder[] getFiltersFolders(SystemProfile profile)
public static IFolder[] getFiltersFolders(String profileName)
public static IFolder getFilterPoolsFolder(SystemProfile profile, SubSystemFactory ssFactory)
public static IFolder getFilterPoolsFolder(String profileName, SubSystemFactory ssFactory)
public static IFolder[] getFilterPoolsFolders(SystemProfile profile, SubSystemFactory ssFactory)
public static IFolder[] getFilterPoolsFolders(String profileName, SubSystemFactory ssFactory)
public static IFolder getFilterPoolFolder(SystemProfile profile, SubSystemFactory ssFactory, SystemFilterPool pool)
public static IFolder getFilterPoolFolder(String profileName, SubSystemFactory ssFactory, SystemFilterPool pool)
public static IFolder getFilterPoolFolder(SystemProfile profile, SubSystemFactory ssFactory, String poolFolderName)
public static IFolder getFilterPoolFolder(String profileName, SubSystemFactory ssFactory, String poolFolderName)
public static IFolder getTypeFiltersFolder()
public static IFolder getTypeFiltersFolder(SubSystemFactory ssFactory)
public static IFolder getTypeFiltersFolder(String ssFactoryId)
protected static IFolder getUserActionsFolder(String profileName)
public static IFolder getUserActionsFolder(SystemProfile profile, SubSystemFactory ssFactory)
public static IFolder getUserActionsFolder(String profileName, SubSystemFactory ssFactory)
public static boolean testUserActionsFolder(String profileName, SubSystemFactory ssFactory)
public static IFolder getUserActionsFolder(String profileName, String factoryId)
protected static IFolder getCompileCommandsFolder(String profileName)
public static IFolder getCompileCommandsFolder(SystemProfile profile, SubSystemFactory ssFactory)
public static IFolder getCompileCommandsFolder(String profileName, SubSystemFactory ssFactory)
public static IFolder getCompileCommandsFolder(String profileName, String factoryId)
public static void renameFolder(IFolder folder, String newName)
public static void deleteFolder(IFolder folder)
public static void renameFile(IFolder folder, String oldName, String newName)
public static void deleteFile(IFolder folder, String fileName)
public static String getProfileName(SystemConnectionPool pool)
public static String getProfileName(SystemFilterPoolManager mgr)
public static String getFolderName(SystemFilterPool pool)
public static String getFolderName(SystemConnection conn)
public static String getFolderName(SubSystemFactory ssFactory)
public static String getFolderPath(IFolder folder)
public static String getFolderPathWithTerminator(IFolder folder)
protected static SystemResourceHelpers getResourceHelpers()
public static String addPathTerminator(String path)
public static boolean testIfResourceInUse(IResource resource)
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |