+ * The original remote system's exception message is always embedded and + * retrievable via getRemoteException(). + * + * @since 3.0 + */ +public class SystemOperationFailedException extends SystemRemoteMessageException { + /** + * A serialVersionUID is recommended for all serializable classes. This + * trait is inherited from Throwable. This should be updated if there is a + * schema change for this class. + */ + private static final long serialVersionUID = 1L; + + /** + * Default Constructor. + * Clients are encouraged to use the more specific constructor with pluginId and operationPerformed instead of this one. + * + * @param remoteException the initial cause of this exception + */ + public SystemOperationFailedException(Exception remoteException) { + super(getMyMessage(Activator.PLUGIN_ID, null, remoteException), remoteException); + } + + /** + * Constructor with plugin ID. + * Clients are encouraged to use the more specific constructor with pluginId and operationPerformed instead of this one. + * + * @param remoteException the initial cause of this exception + */ + public SystemOperationFailedException(String pluginId, Exception remoteException) { + super(getMyMessage(pluginId, null, remoteException), remoteException); + } + + /** + * Constructor with plugin ID and operation being performed. + * + * @param remoteException the initial cause of this exception + */ + public SystemOperationFailedException(String pluginId, String operationPerformed, Exception remoteException) { + super(getMyMessage(pluginId, operationPerformed, remoteException), remoteException); + } + + private static SystemMessage getMyMessage(String pluginId, String operationPerformed, Exception remoteException) { + + String message = remoteException.getMessage(); + if (message == null) { + message = remoteException.getClass().getName(); + } + String msgTxt = NLS.bind(CommonMessages.MSG_OPERATION_FAILED, message); + + String secondLevel = null; + Throwable cause = remoteException.getCause(); + if (cause != null) { + secondLevel = cause.getMessage(); + if (secondLevel == null) { + secondLevel = cause.getClass().getName(); + if (secondLevel.equals(message)) { + secondLevel = null; + } + } + } + if (operationPerformed != null) { + // FIXME Use Java MessageFormat for better formatting + secondLevel = (secondLevel != null) ? operationPerformed + " : " + secondLevel : operationPerformed; //$NON-NLS-1$ + } + SystemMessage msg = new SimpleSystemMessage(pluginId, ICommonMessageIds.MSG_OPERATION_FAILED, + IStatus.ERROR, msgTxt, secondLevel); + return msg; + } + +} diff --git a/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/SystemRemoteMessageException.java b/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/SystemRemoteMessageException.java new file mode 100644 index 00000000000..fde810e4cee --- /dev/null +++ b/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/SystemRemoteMessageException.java @@ -0,0 +1,74 @@ +/******************************************************************************* + * Copyright (c) 2000, 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 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, + * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. + * + * Contributors: + * Martin Oberhuber (Wind River) - [226374] [api] Derived from RemoteFileException + *******************************************************************************/ + +package org.eclipse.rse.services.clientserver.messages; + + +/** + * Base class for remote system exceptions. + *
+ * All remote system exceptions are guaranteed to have a translated message + * retrievable via getMessage(), to make it easy to display to the user. + *
+ * All child exceptions potentially contain an embedded exception that is the + * original exception from the remote system. + *
+ * Use {#link getRemoteException()} to retrieve that wrapped exception, if any. + * + * @since 3.0 + */ +public class SystemRemoteMessageException extends SystemMessageException { + + /** + * A serialVersionUID is recommended for all serializable classes. This + * trait is inherited from Throwable. This should be updated if there is a + * schema change for this class. + */ + private static final long serialVersionUID = 1L; + private Exception wrappedException = null; + + /** + * Constructor with an error message for getMessage() to return, and a + * wrapped exception to contain. It is accessed via getRemoteException(). + * + * @param msg The fully resolved message + * @param remoteException The exception to contain within this exception + */ + public SystemRemoteMessageException(SystemMessage msg, Exception remoteException) { + super(msg); + wrappedException = remoteException; + } + + /** + * Constructor with a plain text message, and a wrapped exception. + * + * @param msg The fully resolved message + * @param remoteException The exception to contain within this exception + */ + public SystemRemoteMessageException(String msg, Exception remoteException) { + super(msg); + wrappedException = remoteException; + } + + /** + * @return the original remote exception + */ + public Exception getRemoteException() { + return wrappedException; + } + +} diff --git a/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/SystemRemoteSecurityException.java b/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/SystemRemoteSecurityException.java new file mode 100644 index 00000000000..9c627e7f844 --- /dev/null +++ b/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/SystemRemoteSecurityException.java @@ -0,0 +1,80 @@ +/******************************************************************************* + * Copyright (c) 2000, 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 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, + * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. + * + * Contributors: + * David McKnight (IBM) - [216252] [api][nls] Resource Strings specific to subsystems should be moved from rse.ui into files.ui / shells.ui / processes.ui where possible + * David McKnight (IBM) - [220547] [api][breaking] SimpleSystemMessage needs to specify a message id and some messages should be shared + * Martin Oberhuber (Wind River) - [226374] Derived from RemoteFileSecurityException + *******************************************************************************/ + +package org.eclipse.rse.services.clientserver.messages; + +import org.eclipse.core.runtime.IStatus; +import org.eclipse.osgi.util.NLS; + +/** + * Exception thrown when attempting an operation and it fails for security + * reasons. The original remote system's security message is always embedded and + * retrievable via getRemoteException(). + * + * @since 3.0 + */ +public class SystemRemoteSecurityException extends SystemRemoteMessageException { + /** + * A serialVersionUID is recommended for all serializable classes. This + * trait is inherited from Throwable. This should be updated if there is a + * schema change for this class. + */ + private static final long serialVersionUID = 1L; + + /** + * Constructor with plugin ID and operation being performed. + * + * @param pluginId ID of the plugin which detected the security violation + * @param operationPerformed element or operation which could not be + * accessed due to security restriction + * @param remoteException the initial cause of this exception + */ + public SystemRemoteSecurityException(String pluginId, String operationPerformed, Exception remoteException) { + super(getMyMessage(pluginId, operationPerformed, remoteException), remoteException); + } + + private static SystemMessage getMyMessage(String pluginId, String operationPerformed, Exception remoteException) { + + String msgTxt = NLS.bind(CommonMessages.MSG_OPERATION_FAILED, operationPerformed); + + String detailMessage = remoteException.getMessage(); + if (detailMessage == null) { + detailMessage = remoteException.getClass().getName(); + } + String secondLevel = null; + Throwable cause = remoteException.getCause(); + if (cause != null) { + secondLevel = cause.getMessage(); + if (secondLevel == null) { + secondLevel = cause.getClass().getName(); + if (secondLevel.equals(detailMessage)) { + secondLevel = null; + } + } + } + if (secondLevel != null) { + // FIXME Use MessageFormat + detailMessage = detailMessage + " : " + secondLevel; //$NON-NLS-1$ + } + SystemMessage msg = new SimpleSystemMessage(pluginId, ICommonMessageIds.MSG_OPERATION_SECURITY_VIOLATION, IStatus.ERROR, msgTxt, secondLevel); + return msg; + } + + +} diff --git a/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/SystemUnsupportedOperationException.java b/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/SystemUnsupportedOperationException.java new file mode 100644 index 00000000000..370ed3dd2ea --- /dev/null +++ b/rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/SystemUnsupportedOperationException.java @@ -0,0 +1,49 @@ +/******************************************************************************* + * Copyright (c) 2008 Wind River Systems, Inc. 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 available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Martin Oberhuber (Wind River) - initial API and implementation + *******************************************************************************/ + +package org.eclipse.rse.services.clientserver.messages; + +import org.eclipse.core.runtime.IStatus; +import org.eclipse.osgi.util.NLS; + +/** + * Exception thrown when an operation is requested from a Service that is not + * supported by that service. + * + * @since 3.0 + */ +public class SystemUnsupportedOperationException extends SystemMessageException { + + /** + * A serialVersionUID is recommended for all serializable classes. This + * trait is inherited from Throwable. This should be updated if there is a + * schema change for this class. + */ + private static final long serialVersionUID = 1L; + + /** + * Constructor. + * + * @param pluginId ID of the plugin not supporting requested operation. + * @param operation The operation being requested + */ + public SystemUnsupportedOperationException(String pluginId, String operation) { + super(getMyMessage(pluginId, operation)); + } + + private static SystemMessage getMyMessage(String pluginId, String operation) { + + String msgTxt = NLS.bind(CommonMessages.MSG_OPERATION_UNSUPPORTED, operation); + SystemMessage msg = new SimpleSystemMessage(pluginId, ICommonMessageIds.MSG_OPERATION_UNSUPPORTED, IStatus.ERROR, msgTxt); + return msg; + } + +} diff --git a/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/RemoteFileCancelledException.java b/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/RemoteFileCancelledException.java index ae19dfd9d11..49c44ab507d 100644 --- a/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/RemoteFileCancelledException.java +++ b/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/RemoteFileCancelledException.java @@ -15,47 +15,33 @@ * Martin Oberhuber (Wind River) - [216351] Improve cancellation of SystemFetchOperation for files * David McKnight (IBM) - [216252] [api][nls] Resource Strings specific to subsystems should be moved from rse.ui into files.ui / shells.ui / processes.ui where possible * David McKnight (IBM) - [220547] [api][breaking] SimpleSystemMessage needs to specify a message id and some messages should be shared + * Martin Oberhuber (Wind River) - [226374] [api] Need default SystemMessageException specialisations *******************************************************************************/ package org.eclipse.rse.services.files; -import org.eclipse.core.runtime.IStatus; - -import org.eclipse.rse.internal.services.Activator; -import org.eclipse.rse.services.clientserver.messages.CommonMessages; -import org.eclipse.rse.services.clientserver.messages.ICommonMessageIds; -import org.eclipse.rse.services.clientserver.messages.SimpleSystemMessage; -import org.eclipse.rse.services.clientserver.messages.SystemMessage; +import org.eclipse.rse.services.clientserver.messages.SystemOperationCancelledException; /** * Exception thrown when attempting a file operation and the user cancelled it - * before it could be completed. + * before it could be completed. Used to extend RemoteFileException before 3.0 + * + * @deprecated use SystemOperationCancelledException + * @since 3.0 */ -public class RemoteFileCancelledException extends RemoteFileException { +public class RemoteFileCancelledException extends SystemOperationCancelledException { /** - * A serialVersionUID is recommended for all serializable classes. - * This trait is inherited from Throwable. - * This should be updated if there is a schema change for this class. + * A serialVersionUID is recommended for all serializable classes. This + * trait is inherited from Throwable. This should be updated if there is a + * schema change for this class. */ private static final long serialVersionUID = 1L; - private static SystemMessage myMessage = null; /** * Constructor */ public RemoteFileCancelledException() { - super(getMyMessage()); + super(); } - - private static SystemMessage getMyMessage() { - String msgTxt = CommonMessages.MSG_OPERATION_CANCELLED; - - myMessage = new SimpleSystemMessage(Activator.PLUGIN_ID, - ICommonMessageIds.MSG_OPERATION_CANCELLED, - IStatus.ERROR, msgTxt); - - return myMessage; - } - } diff --git a/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/RemoteFileException.java b/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/RemoteFileException.java index b058fe13b98..94ff44ee342 100644 --- a/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/RemoteFileException.java +++ b/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/RemoteFileException.java @@ -12,14 +12,14 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * Martin Oberhuber (Wind River) - [226374] [api] Need default SystemMessageException specialisations *******************************************************************************/ package org.eclipse.rse.services.files; import java.util.ResourceBundle; import org.eclipse.rse.services.clientserver.messages.SystemMessage; -import org.eclipse.rse.services.clientserver.messages.SystemMessageException; +import org.eclipse.rse.services.clientserver.messages.SystemRemoteMessageException; /** @@ -32,8 +32,11 @@ import org.eclipse.rse.services.clientserver.messages.SystemMessageException; * original exception from the remote system. *
* Use {#link getRemoteException()} to retrieve that wrapped exception, if any. + * Extends SystemRemoteMessageException since 3.0 + * + * @since 3.0 */ -public class RemoteFileException extends SystemMessageException +public class RemoteFileException extends SystemRemoteMessageException { /** * A serialVersionUID is recommended for all serializable classes. @@ -41,7 +44,6 @@ public class RemoteFileException extends SystemMessageException * This should be updated if there is a schema change for this class. */ private static final long serialVersionUID = 1L; - private Exception wrappedException = null; /** * Constructor for RemoteFileException with an error message for getMessage() to return. @@ -79,8 +81,7 @@ public class RemoteFileException extends SystemMessageException */ public RemoteFileException(String msg, Exception remoteException) { - super(msg); - wrappedException = remoteException; + super(msg, remoteException); } /** @@ -99,17 +100,8 @@ public class RemoteFileException extends SystemMessageException */ public RemoteFileException(SystemMessage msg, Exception remoteException) { - super(msg); - wrappedException = remoteException; + super(msg, remoteException); } - /** - * @return the original remote exception - */ - public Exception getRemoteException() - { - return wrappedException; - } - private static String getString(ResourceBundle bundle, String key) { diff --git a/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/RemoteFileSecurityException.java b/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/RemoteFileSecurityException.java index 76b73a6da5b..0b44e86e52d 100644 --- a/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/RemoteFileSecurityException.java +++ b/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/RemoteFileSecurityException.java @@ -7,13 +7,14 @@ * * 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: * David McKnight (IBM) - [216252] [api][nls] Resource Strings specific to subsystems should be moved from rse.ui into files.ui / shells.ui / processes.ui where possible * David McKnight (IBM) - [220547] [api][breaking] SimpleSystemMessage needs to specify a message id and some messages should be shared + * Martin Oberhuber (Wind River) - [226374] [api] Need default SystemMessageException specialisations *******************************************************************************/ package org.eclipse.rse.services.files; @@ -27,9 +28,11 @@ import org.eclipse.rse.services.clientserver.messages.SimpleSystemMessage; import org.eclipse.rse.services.clientserver.messages.SystemMessage; /** - * Exception thrown when attempting an operation and it fails for security reasons. - * The original remote system's security message is always embedded and retrievable - * via getRemoteException(). + * Exception thrown when attempting an operation and it fails for security + * reasons. The original remote system's security message is always embedded and + * retrievable via getRemoteException(). + * + * @deprecated Use SystemRemoteSecurityException */ public class RemoteFileSecurityException extends RemoteFileException { @@ -42,7 +45,7 @@ public class RemoteFileSecurityException extends RemoteFileException { private static SystemMessage myMessage = null; /** - * Constructor + * Constructor * @param remoteException the original cause of this exception. */ public RemoteFileSecurityException(Exception remoteException) { @@ -56,11 +59,11 @@ public class RemoteFileSecurityException extends RemoteFileException { if (secondLevel == null) { secondLevel = remoteException.getClass().getName(); } - + String msgTxt = RSEServicesMessages.FILEMSG_SECURITY_VIOLATION; String msgDetails = NLS.bind(RSEServicesMessages.FILEMSG_SECURITY_VIOLATION_DETAILS, secondLevel); - - myMessage = new SimpleSystemMessage(Activator.PLUGIN_ID, + + myMessage = new SimpleSystemMessage(Activator.PLUGIN_ID, "RSEF1001", //$NON-NLS-1$ IStatus.ERROR, msgTxt, msgDetails); }