Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

RSE
Release 3.0

org.eclipse.rse.services.clientserver.messages
Class SimpleSystemMessage

java.lang.Object
  extended by 

org.eclipse.rse.services.clientserver.messages.SystemMessage
      extended by 
org.eclipse.rse.services.clientserver.messages.SimpleSystemMessage

public class SimpleSystemMessage
extends SystemMessage

An RSE SystemMessage that can be created from Strings (without XML parsing).

Since:
3.0

Field Summary
 
Fields inherited from class org.eclipse.rse.services.clientserver.messages. SystemMessage
COMPLETION, ERROR, INFORMATION, INQUIRY, NESTING_INDENT, UNEXPECTED, WARNING
 
Constructor Summary
SimpleSystemMessage ( String pluginId, int severity, String msg)
          Creates a String based System Message with a severity and plug-in ID, but no global or plug-in specific message ID or detail message.
SimpleSystemMessage ( String pluginId, int severity, String msg, String msgDetails)
          Creates a String based System Message with a severity and plug-in ID as well as message details, but no global or plug-in specific message ID.
SimpleSystemMessage ( String pluginId, int severity, String msg, Throwable e)
          Creates a String based System Message with a severity and plug-in ID, as well as an exception to convert into message details, but no global or plug-in specific message ID.
SimpleSystemMessage ( String pluginId, String messageId, int severity, String msg)
          Creates a String based System Message with severity and ID, but no message details.
SimpleSystemMessage ( String pluginId, String messageId, int severity, String msg, String msgDetails)
          Creates a String based System Message with severity, ID and String message details.
SimpleSystemMessage ( String pluginId, String messageId, int severity, String msg, Throwable e)
          Creates a String based System Message with severity and ID, and an Exception that will be converted into message details.
 
Method Summary
  String getFullMessageID ()
          Use this method to retrieve the full message ID: Component + SubComponent + Number + indicator
 
Methods inherited from class org.eclipse.rse.services.clientserver.messages. SystemMessage
getIndicator, getLevelOneText, getLevelTwoText, getMessageNumber, getNumSubstitutionVariables, getSubValue, getSubVariables, makeSubstitution, makeSubstitution, makeSubstitution, makeSubstitution, makeSubstitution, setIndicator, setPrefixChar, sub, toString
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SimpleSystemMessage

public SimpleSystemMessage(
String pluginId,
                           
String messageId,
                           int severity,
                           
String msg)
Creates a String based System Message with severity and ID, but no message details. See SimpleSystemMessage(String, String, int, String, String) for a detailed description.

Parameters:
pluginId - the id of the originating plugin
messageId - the RSE-global unique ID or plugin-specific local ID of the message
severity - using IStatus severities
msg - the message text

SimpleSystemMessage

public SimpleSystemMessage(
String pluginId,
                           
String messageId,
                           int severity,
                           
String msg,
                           
String msgDetails)
Creates a String based System Message with severity, ID and String message details. This allows using the RSE Messaging Framework based on simple String messages and IDs, rather than using XML Message files from SystemMessageFile along with the org.eclipse.rse.ui.SystemBasePlugin#loadMessageFile() and org.eclipse.rse.ui.SystemBasePlugin#getMessage() methods. Clients can use either globally unique RSE message IDs or plugin-specific local IDs. RSE-global message IDs are of the form: RSE<subcomponent><number>, where the subcomponent is a single character:
  • "G" for General
  • "O" for Other
  • "F" for Files
  • "C" for Communications
and the number is a four digit number. Some RSE-global message IDs are predefined in ICommonMessageIds. When used in a SimpleSystemMessage, these common message IDs must be used along with the matching message Strings from CommonMessages, in order to be consistent to the user. For example:
 msg = new SimpleSystemMessage(Activator.PLUGIN_ID, ICommonMessageIds.MSG_COMM_AUTH_FAILED, IStatus.ERROR, CommonMessages.MSG_COMM_AUTH_FAILED, NLS.bind(
                CommonMessages.MSG_COMM_AUTH_FAILED_DETAILS, getHost().getAliasName()));
 
Plugin-specific local IDs are totally free to be defined by the plugin that creates a specific message, as long as they are not prefixed by "RSE". It is recommended that plugins define unique IDs for various message situations, because this helps problem determination with end users; but it is not a requirement. Local ID's are specific to the plugin ID: relative IDs are qualified by the specified plugin ID, so they live in the plugin ID namespace.

Parameters:
pluginId - the id of the originating plugin
messageId - the RSE-global unique ID or plugin-specific local ID of the message
severity - using IStatus severities
msg - the message text to be logged or displayed to the user
msgDetails - the message details with additional information to be displayed on request only

SimpleSystemMessage

public SimpleSystemMessage(
String pluginId,
                           
String messageId,
                           int severity,
                           
String msg,
                           
Throwable e)
Creates a String based System Message with severity and ID, and an Exception that will be converted into message details. See SimpleSystemMessage(String, String, int, String, String) for a detailed description.

Parameters:
pluginId - the id of the originating plugin
messageId - the RSE-global unique ID or plugin-specific local ID of the message
severity - using IStatus severities
msg - the message text
e - an exception to convert into details

SimpleSystemMessage

public SimpleSystemMessage(
String pluginId,
                           int severity,
                           
String msg)
Creates a String based System Message with a severity and plug-in ID, but no global or plug-in specific message ID or detail message. This constructor does not supply a message id. It is preferred that a message id is used since it allows easier identification of a unique message. See SimpleSystemMessage(String, String, int, String, String) for a detailed description about messages and ID's.

Parameters:
pluginId - the id of the originating plugin
severity - using IStatus severities
msg - the message text

SimpleSystemMessage

public SimpleSystemMessage(
String pluginId,
                           int severity,
                           
String msg,
                           
String msgDetails)
Creates a String based System Message with a severity and plug-in ID as well as message details, but no global or plug-in specific message ID. This constructor does not supply a message id. It is preferred that a message id is used since it allows easier identification of a unique message. See SimpleSystemMessage(String, String, int, String, String) for a detailed description about messages and ID's.

Parameters:
pluginId - the id of the originating plugin
severity - using IStatus severities
msg - the message text
msgDetails - the message details

SimpleSystemMessage

public SimpleSystemMessage(
String pluginId,
                           int severity,
                           
String msg,
                           
Throwable e)
Creates a String based System Message with a severity and plug-in ID, as well as an exception to convert into message details, but no global or plug-in specific message ID. This constructor does not supply a message id. It is preferred that a message id is used since it allows easier identification of a unique message. See SimpleSystemMessage(String, String, int, String, String) for a detailed description about messages and ID's.

Parameters:
pluginId - the id of the originating plugin
severity - using IStatus severities
msg - the message text
e - an exception to convert into details
Method Detail

getFullMessageID

public 
String getFullMessageID()
Description copied from class: SystemMessage
Use this method to retrieve the full message ID: Component + SubComponent + Number + indicator

Overrides:
getFullMessageID in class SystemMessage
Returns:
String - the full message ID

RSE
Release 3.0

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire