mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-25 18:05:33 +02:00
Code Issues Wiki Activity

[224671][api] Fix non-API leakage of ISystemResourceConstants

Browse source
This commit is contained in:
Martin Oberhuber 2008-03-28 16:29:36 +00:00
parent e6d64d4104
commit 4e9af07bbc
1 changed files with 224 additions and 219 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

443
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/SystemResourceManager.java
View file

@ -1,26 +1,27 @@
/********************************************************************************
* Copyright (c) 2006, 2007 IBM Corporation and others. All rights reserved.
* Copyright (c) 2006, 2008 IBM Corporation and others. All rights reserved.
* This program and the accompanying materials are made available under the terms
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html
*
* Initial Contributors:
* The following IBM employees contributed to the Remote System Explorer
* component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* component that contains this file: David McKnight, Kushal Munir,
* Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson,
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* Contributors:
* Dave McKnight (IBM) - [177155] Move from rse.ui/systems/org.eclipse.rse.core
* David McKnight (IBM) - [177155] Move from rse.ui/systems/org.eclipse.rse.core
* Martin Oberhuber (Wind River) - Re-add missing methods for user actions
* David Dykstal (IBM) - [189858] delayed the creation of the remote systems project
* removed unneeded first time logic and flags
* renamed createRemoteSystemsProjectInternal to ensureRemoteSystemsProject
* made ensureRemoteSystemsProject private instead of protected
* made ensureRemoteSystemsProject private instead of protected
* David Dykstal (IBM) - [186589] move user types, user actions, and compile commands
* API to the user actions plugin
* David Dykstal (IBM) - [191130] remove getRemoteSystemsProject() and getProfileFolder()
* as part of the work to removed the exception printed at startup.
* Martin Oberhuber (Wind River) - [224671] Fix non-API leakage of ISystemResourceConstants
********************************************************************************/
package org.eclipse.rse.core;
@ -46,22 +47,26 @@ import org.eclipse.rse.internal.core.SystemResourceConstants;
/**
* 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.
* 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.
* <p>
* <b>Assumptions</b>
* <ul>
* <li>Each SystemConnectionPool object manages the connections for a given system profile
* <li>Each SystemFilterPoolManager object manages the filter pools for a given subsystem factory,
* for a given system profile!
* <li>Each SystemFilterPool object is an arbitrary named collection of filters all stored
* in one folder on disk with the same name as the pool.
* <li>Each SystemConnectionPool object manages the connections for a given
* system profile
* <li>Each SystemFilterPoolManager object manages the filter pools for a given
* subsystem factory, for a given system profile!
* <li>Each SystemFilterPool object is an arbitrary named collection of filters
* all stored in one folder on disk with the same name as the pool.
* </ul>
* <p>
*
* @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);
}
}