* Assumptions *
+ * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ -public class SystemResourceManager implements SystemResourceConstants +public class SystemResourceManager { private static IProject remoteSystemsProject = null; @@ -71,61 +76,61 @@ public class SystemResourceManager implements SystemResourceConstants private static ISystemResourceListener _listener = null; /** - * Turn off event listening. Please call this before do anything that modifies resources and - * turn it on again after. - */ - public static void turnOffResourceEventListening() - { - if (_listener != null) - _listener.turnOffResourceEventListening(); - } + * Turn off event listening. Please call this before do anything that modifies resources and + * turn it on again after. + */ + public static void turnOffResourceEventListening() + { + if (_listener != null) + _listener.turnOffResourceEventListening(); + } - /** - * Turn off event listening. Please call this after modifying resources. - */ - public static void turnOnResourceEventListening() - { - if (_listener != null) - _listener.turnOnResourceEventListening(); - } - /** - * Ensure event listening is on. Called at start of team synch action to be safe. - */ - public static void ensureOnResourceEventListening() - { - if (_listener != null) - _listener.ensureOnResourceEventListening(); - } + /** + * Turn off event listening. Please call this after modifying resources. + */ + public static void turnOnResourceEventListening() + { + if (_listener != null) + _listener.turnOnResourceEventListening(); + } + /** + * Ensure event listening is on. Called at start of team synch action to be safe. + */ + public static void ensureOnResourceEventListening() + { + if (_listener != null) + _listener.ensureOnResourceEventListening(); + } - /** - * Start event listening. Requests to turn on and off are ignored until this is called, - * which is at the appropriate point in the startup sequence. - */ - public static void startResourceEventListening(ISystemResourceListener listener) - { - _listener = listener; - listener.turnOnResourceEventListening(); - - - IWorkspace ws = remoteSystemsProject.getWorkspace(); - int eventMask = IResourceChangeEvent.POST_CHANGE; - - // add listener for global events ; - ws.addResourceChangeListener(listener, eventMask); - } - /** - * End event listening. Requests to turn on and off are ignored after this is called, - * which is at the appropriate point in the shutdown sequence. - */ - public static void endResourceEventListening() - { - if (_listener != null) - { - IWorkspace ws = remoteSystemsProject.getWorkspace(); - ws.removeResourceChangeListener(_listener); - _listener = null; - } - } + /** + * Start event listening. Requests to turn on and off are ignored until this is called, + * which is at the appropriate point in the startup sequence. + */ + public static void startResourceEventListening(ISystemResourceListener listener) + { + _listener = listener; + listener.turnOnResourceEventListening(); + + + IWorkspace ws = remoteSystemsProject.getWorkspace(); + int eventMask = IResourceChangeEvent.POST_CHANGE; + + // add listener for global events ; + ws.addResourceChangeListener(listener, eventMask); + } + /** + * End event listening. Requests to turn on and off are ignored after this is called, + * which is at the appropriate point in the shutdown sequence. + */ + public static void endResourceEventListening() + { + if (_listener != null) + { + IWorkspace ws = remoteSystemsProject.getWorkspace(); + ws.removeResourceChangeListener(_listener); + _listener = null; + } + } /** * Register a listener for resource change events on objects in our remote system project. @@ -139,7 +144,7 @@ public class SystemResourceManager implements SystemResourceConstants public static void addResourceChangeListener(IResourceChangeListener l) { if (_listener != null) - _listener.addResourceChangeListener(l); + _listener.addResourceChangeListener(l); } /** * Remove a listener for resource change events on an object in our remote system project. @@ -147,20 +152,20 @@ public class SystemResourceManager implements SystemResourceConstants public static void removeResourceChangeListener(IResourceChangeListener l) { if (_listener != null) - _listener.removeResourceChangeListener(l); + _listener.removeResourceChangeListener(l); } - + /** * Get the default remote systems project. * If found but closed, this will open the project. * @param force if true force the creation of the project if not found. * In any case, returns handle to the project. - * @return IProject handle of the project. Clients should use + * @return IProject handle of the project. Clients should use * exists() or isAccessible() to test existence. */ public static IProject getRemoteSystemsProject(boolean force) { if (remoteSystemsProject == null) { - remoteSystemsProject = ResourcesPlugin.getWorkspace().getRoot().getProject(RESOURCE_PROJECT_NAME); + remoteSystemsProject = ResourcesPlugin.getWorkspace().getRoot().getProject(SystemResourceConstants.RESOURCE_PROJECT_NAME); } if ((!remoteSystemsProject.exists() && force) || (remoteSystemsProject.exists() && !remoteSystemsProject.isOpen())) { ensureRemoteSystemsProject(remoteSystemsProject); @@ -168,7 +173,7 @@ public class SystemResourceManager implements SystemResourceConstants return remoteSystemsProject; } - /** + /** * Get the default remote systems temp files project. * @return IProject handle of the project. Use exists() to test existence. */ @@ -176,17 +181,17 @@ public class SystemResourceManager implements SystemResourceConstants { if (remoteSystemsTempFilesProject == null) { - remoteSystemsTempFilesProject = ResourcesPlugin.getWorkspace().getRoot().getProject(RESOURCE_TEMPFILES_PROJECT_NAME); + remoteSystemsTempFilesProject = ResourcesPlugin.getWorkspace().getRoot().getProject(SystemResourceConstants.RESOURCE_TEMPFILES_PROJECT_NAME); } return remoteSystemsTempFilesProject; } - /** - * Create a remote systems project, plus the core subfolders required. - * @param proj the handle for the remote systems project - * @return the IProject handle of the project (the argument) - */ - private static IProject ensureRemoteSystemsProject(IProject proj) - { + /** + * Create a remote systems project, plus the core subfolders required. + * @param proj the handle for the remote systems project + * @return the IProject handle of the project (the argument) + */ + private static IProject ensureRemoteSystemsProject(IProject proj) + { // Check first for the project to be closed. If yes, try to open it and if this fails, // try to delete if first before failing here. The case is that the user removed the // directory in the workspace and we must be able to recover from it. @@ -219,146 +224,146 @@ public class SystemResourceManager implements SystemResourceConstants return proj; } - // ------------------- - // FOLDER ACTIONS... - // ------------------- + // ------------------- + // FOLDER ACTIONS... + // ------------------- - /** - * Rename a folder - */ - public static void renameFolder(IFolder folder, String newName) - { - getResourceHelpers().renameResource(folder, newName); - } - /** - * Delete a folder - */ - public static void deleteFolder(IFolder folder) - { - getResourceHelpers().deleteResource(folder); - } + /** + * Rename a folder + */ + public static void renameFolder(IFolder folder, String newName) + { + getResourceHelpers().renameResource(folder, newName); + } + /** + * Delete a folder + */ + public static void deleteFolder(IFolder folder) + { + getResourceHelpers().deleteResource(folder); + } - // ------------------- - // FILE ACTIONS... - // ------------------- + // ------------------- + // FILE ACTIONS... + // ------------------- - /** - * Rename a file - */ - public static void renameFile(IFolder folder, String oldName, String newName) - { - getResourceHelpers().renameResource( - getResourceHelpers().getFile(folder,oldName), newName); - } - /** - * Delete a file - */ - public static void deleteFile(IFolder folder, String fileName) - { - getResourceHelpers().deleteResource( - getResourceHelpers().getFile(folder, fileName)); - } - - - // ------------------- - // GENERIC HELPERS... - // ------------------- - - /** - * Map a connection pool name to a profile name. - * Current algorith is that pool name equals profile name, but we use - * this method to allow flexibility in the future. - */ - public static String getProfileName(ISystemHostPool pool) - { - return pool.getName(); - } - - /** - * 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. - */ - public static String getProfileName(ISystemFilterPoolManager mgr) - { - return mgr.getName(); - } - - /** - * 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. - */ - public static String getFolderName(ISystemFilterPool pool) - { - return pool.getName(); - } - - /** - * Map a system connection object to a folder name - */ - public static String getFolderName(IHost conn) - { - return conn.getAliasName(); - } - - /** - * Map a subsystem factory object to a folder name - */ - public static String getFolderName(ISubSystemConfiguration ssFactory) - { - return ssFactory.getId(); // Should we use name instead?? Can we assume the name is unique? - } - - /** - * Given any folder, return its path as a string. - */ - public static String getFolderPath(IFolder folder) - { - return getResourceHelpers().getFolderPath(folder); - } - - /** - * Given any folder, return its path as a string, and an ending '\' - */ - public static String getFolderPathWithTerminator(IFolder folder) - { - return addPathTerminator(getResourceHelpers().getFolderPath(folder)); - } + /** + * Rename a file + */ + public static void renameFile(IFolder folder, String oldName, String newName) + { + getResourceHelpers().renameResource( + getResourceHelpers().getFile(folder,oldName), newName); + } + /** + * Delete a file + */ + public static void deleteFile(IFolder folder, String fileName) + { + getResourceHelpers().deleteResource( + getResourceHelpers().getFile(folder, fileName)); + } - /** - * Return singleton of resource helpers object - */ - protected static SystemResourceHelpers getResourceHelpers() - { - if (helpers == null) - { - helpers = SystemResourceHelpers.getResourceHelpers(); - //helpers.setLogFile(RSEUIPlugin.getDefault().getLogFile()); - } - return helpers; - } + // ------------------- + // GENERIC HELPERS... + // ------------------- + + /** + * Map a connection pool name to a profile name. + * Current algorith is that pool name equals profile name, but we use + * this method to allow flexibility in the future. + */ + public static String getProfileName(ISystemHostPool pool) + { + return pool.getName(); + } + + /** + * 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. + */ + public static String getProfileName(ISystemFilterPoolManager mgr) + { + return mgr.getName(); + } + + /** + * 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. + */ + public static String getFolderName(ISystemFilterPool pool) + { + return pool.getName(); + } + + /** + * Map a system connection object to a folder name + */ + public static String getFolderName(IHost conn) + { + return conn.getAliasName(); + } + + /** + * Map a subsystem factory object to a folder name + */ + public static String getFolderName(ISubSystemConfiguration ssFactory) + { + return ssFactory.getId(); // Should we use name instead?? Can we assume the name is unique? + } + + /** + * Given any folder, return its path as a string. + */ + public static String getFolderPath(IFolder folder) + { + return getResourceHelpers().getFolderPath(folder); + } + + /** + * Given any folder, return its path as a string, and an ending '\' + */ + public static String getFolderPathWithTerminator(IFolder folder) + { + return addPathTerminator(getResourceHelpers().getFolderPath(folder)); + } + + + /** + * Return singleton of resource helpers object + */ + protected static SystemResourceHelpers getResourceHelpers() + { + if (helpers == null) + { + helpers = SystemResourceHelpers.getResourceHelpers(); + //helpers.setLogFile(RSEUIPlugin.getDefault().getLogFile()); + } + return helpers; + } + + /** + * Ensure given path ends with path separator. + */ + public static String addPathTerminator(String path) + { + if (!path.endsWith(File.separator)) + path = path + File.separatorChar; + //else + // path = path; + return path; + } + + /** + * Test if a resource is in use, prior to attempting to rename or delete it. + * @return true if it is in use or read only, false if it is not. + */ + public static boolean testIfResourceInUse(IResource resource) + { + return SystemResourceHelpers.testIfResourceInUse(resource); + } - /** - * Ensure given path ends with path separator. - */ - public static String addPathTerminator(String path) - { - if (!path.endsWith(File.separator)) - path = path + File.separatorChar; - //else - // path = path; - return path; - } - - /** - * Test if a resource is in use, prior to attempting to rename or delete it. - * @return true if it is in use or read only, false if it is not. - */ - public static boolean testIfResourceInUse(IResource resource) - { - return SystemResourceHelpers.testIfResourceInUse(resource); - } - } \ No newline at end of file