|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectEObjectImpl
com.ibm.etools.systems.subsystems.impl.SubSystemImpl
Nested Class Summary | |
---|---|
class |
SubSystemImpl.ConnectRunnable
Inner class which implements IRunnable to connect this connection on the UI Thread via sync/asyncExec when no Shell is available from the caller |
protected class |
SubSystemImpl.DisplayErrorMessageRunnable
Inner class which implements IRunnable to allow us to show an error message, which is a GUI operation, from a non-GUI thread. |
Field Summary | |
---|---|
protected boolean |
_connectionError
|
protected boolean |
_disconnecting
|
protected ISystem |
_system
|
protected static String |
ADDITIONAL_ATTRIBUTES_EDEFAULT
The default value of the ' Additional Attributes ' attribute |
protected String |
additionalAttributes
|
protected boolean |
additionalAttributesESet
This is true if the Additional Attributes attribute has been set |
protected boolean |
cancelable
|
static String |
copyright
|
static String |
DELIM_VENDOR_ATTR_VALUE
Delimiter string for each vendor attribute, between the name and the value: "===" |
static String |
DELIM_VENDOR_ATTRS
Delimiter string for each vendor attribute: ";;;" |
static String |
DELIM_VENDOR_NAME
Delimiter string for each vendor attribute, between the vendor name and the attribute name: "___" |
protected boolean |
doConnection
|
protected static String |
FACTORY_ID_EDEFAULT
The default value of the ' Factory Id ' attribute |
protected String |
factoryId
|
protected SystemFilterPoolReferenceManager |
filterPoolReferenceManager
|
protected boolean |
hidden
|
protected static boolean |
HIDDEN_EDEFAULT
The default value of the ' Hidden ' attribute |
protected static String |
IBM_ATTRIBUTES_EDEFAULT
The default value of the ' Ibm Attributes ' attribute |
protected String |
ibmAttributes
|
protected boolean |
ibmAttributesESet
This is true if the Ibm Attributes attribute has been set |
protected Hashtable |
ibmAttrs
|
protected IProgressMonitor |
monitor
|
protected String |
name
|
protected static String |
NAME_EDEFAULT
The default value of the ' Name ' attribute |
protected int |
operation
|
protected static int |
OPERATION_CANCEL_SHELL
|
protected static int |
OPERATION_CONNECT
|
protected static int |
OPERATION_DISCONNECT
|
protected static int |
OPERATION_GET_PROPERTIES
|
protected static int |
OPERATION_GET_PROPERTY
|
protected static int |
OPERATION_REMOVE_SHELL
|
protected static int |
OPERATION_RESOLVE_ABSOLUTE
|
protected static int |
OPERATION_RESOLVE_ABSOLUTES
|
protected static int |
OPERATION_RESOLVE_RELATIVE
|
protected static int |
OPERATION_RUN_COMMAND
|
protected static int |
OPERATION_RUN_SHELL
|
protected static int |
OPERATION_SEND_COMMAND_TO_SHELL
|
protected static int |
OPERATION_SET_PROPERTIES
|
protected static int |
OPERATION_SET_PROPERTY
|
protected SystemConnection |
parentConnection
|
protected SubSystemFactory |
parentSubSystemFactory
|
protected ProgressMonitorDialog |
pmDialog
|
protected Integer |
port
|
protected static Integer |
PORT_EDEFAULT
The default value of the ' Port ' attribute |
protected String |
previousUserIdKey
|
protected ServerLauncher |
remoteServerLauncher
The cached value of the ' Remote Server Launcher ' containment reference |
protected Object |
runContext
|
protected Exception |
runException
|
protected String |
runInput
|
protected String |
runInput2
|
protected String[] |
runInputs
|
protected String[] |
runInputs2
|
protected boolean |
runInterpret
|
protected boolean |
runInThread
|
protected Object |
runObject
|
protected Object |
runOutput
|
protected Object[] |
runOutputs
|
protected String |
runOutputString
|
protected String[] |
runOutputStrings
|
protected String |
saveFileName
|
protected Shell |
shell
|
protected boolean |
sortResults
|
protected static String |
SUBSYSTEM_FILE_NAME
|
protected boolean |
supportsConnecting
|
protected static boolean |
USE_SSL_EDEFAULT
The default value of the ' Use SSL ' attribute |
protected static String |
USER_ID_EDEFAULT
The default value of the ' User Id ' attribute |
protected String |
userId
|
protected boolean |
useSSL
|
protected static String |
VENDOR_ATTRIBUTES_EDEFAULT
The default value of the ' Vendor Attributes ' attribute |
protected String |
vendorAttributes
|
protected boolean |
vendorAttributesESet
This is true if the Vendor Attributes attribute has been set |
protected Hashtable |
vendorAttrs
|
Fields inherited from interface com.ibm.etools.systems.subsystems.IRemoteObjectResolver |
---|
Copyright |
Constructor Summary | |
---|---|
protected |
SubSystemImpl()
Constructor. |
Method Summary | |
---|---|
protected void |
addResolvedFilterStringObjects(Vector allChildrenSoFar,
Object[] childrenForThisFilterString,
String[] allFilterStrings,
int currFilterStringIndex)
Overridable extension point for adding the results of a filter string to the overall list of results. |
NotificationChain |
basicSetFilterPoolReferenceManager(SystemFilterPoolReferenceManager newFilterPoolReferenceManager,
NotificationChain msgs)
|
NotificationChain |
basicSetRemoteServerLauncher(ServerLauncher newRemoteServerLauncher,
NotificationChain msgs)
|
void |
cancelShell(Shell shell,
Object commandObject)
Cancel a shell or running command. |
void |
checkIsConnected()
This is a helper method you can call when performing actions that must be certain there is a connection. |
void |
clearLocalUserId()
Called to clear the local user Id such that subsequent requests to getUserId() will return the parent connection's default user Id. |
void |
connect()
Attempt to connect to the remote system when a Shell is not available. |
void |
connect(Shell shell)
Attempt to connect to the remote system. |
void |
connect(Shell shell,
boolean forcePrompt)
Connect to the remote system, optionally forcing a signon prompt even if the password is cached in memory or on disk. |
void |
deletingConnection()
Private method called when the parent connection is being deleted, so the subsystem can do any pre-death cleanup it needs to. |
void |
disconnect(Shell shell)
Disconnect from the remote system You do not need to override this, as it does the progress monitor and error message displaying for you. |
void |
disconnect(Shell shell,
boolean collapseTree)
Disconnect from the remote system You do not need to override this, as it does the progress monitor and error message displaying for you. |
protected void |
displayAsyncMsg(SystemMessageException msg)
Display message on message thread |
boolean |
doesFilterListContentsOf(SystemFilter filter,
String remoteObjectAbsoluteName)
Return true if the given filter lists the contents of the given remote object. |
boolean |
doesFilterMatch(SystemFilter filter,
String remoteObjectAbsoluteName)
Return true if the given remote object name will pass the filtering criteria for any of the filter strings in this filter. |
boolean |
doesFilterStringListContentsOf(SystemFilterString filterString,
String remoteObjectAbsoluteName)
Return true if the given filter string lists the contents of the given remote object. |
boolean |
doesFilterStringMatch(String filterString,
String remoteObjectAbsoluteName,
boolean caseSensitive)
Return true if the given remote object name will pass the filtering criteria for the given filter string. |
protected boolean |
doesFilterTypeMatch(SystemFilter filter,
String remoteObjectAbsoluteName)
Override this method if you support typed filters. |
Object |
eGet(EStructuralFeature eFeature,
boolean resolve)
|
NotificationChain |
eInverseAdd(InternalEObject otherEnd,
int featureID,
Class baseClass,
NotificationChain msgs)
|
NotificationChain |
eInverseRemove(InternalEObject otherEnd,
int featureID,
Class baseClass,
NotificationChain msgs)
|
boolean |
eIsSet(EStructuralFeature eFeature)
Private. |
void |
eSet(EStructuralFeature eFeature,
Object newValue)
Private. |
protected EClass |
eStaticClass()
|
void |
eUnset(EStructuralFeature eFeature)
Private. |
void |
filterEventFilterCreated(Object selectedObject,
SystemFilter newFilter)
A new filter has been created. |
void |
filterEventFilterPoolReferenceCreated(SystemFilterPoolReference newPoolRef)
A new filter pool reference has been created |
void |
filterEventFilterPoolReferenceDeleted(SystemFilterPoolReference filterPoolRef)
A filter pool reference has been deleted |
void |
filterEventFilterPoolReferenceRenamed(SystemFilterPoolReference poolRef,
String oldName)
A filter pool reference has been renamed (ie, its reference filter pool renamed) |
void |
filterEventFilterPoolReferenceReset(SystemFilterPoolReference filterPoolRef)
A single filter pool reference has been reset to reference a new pool |
void |
filterEventFilterPoolReferencesRePositioned(SystemFilterPoolReference[] poolRefs,
int delta)
One or more filter pool references have been re-ordered within their manager |
void |
filterEventFilterPoolReferencesReset()
All filter pool references has been reset. |
void |
filterEventFilterStringCreated(Object selectedObject,
SystemFilterString newFilterString)
A new filter string has been created. |
protected void |
fireEvent(Object[] multiSrc,
int eventId,
Object parent)
|
protected void |
fireEvent(Object[] src,
int eventId,
Object parent,
int position)
|
protected void |
fireEvent(Object src,
int eventId,
Object parent)
|
protected void |
fireEvent(Object src,
int eventId,
Object parent,
Object grandParent)
|
protected void |
fireEvent(SystemResourceChangeEvent event)
|
protected void |
fireEvent(SystemResourceChangeEvent event,
Object grandParent)
|
boolean |
forceUserIdToUpperCase()
Return true if userId and password should be forced to uppercase. |
static Shell |
getActiveWorkbenchShell()
Helper/convenience method. |
static IWorkbenchWindow |
getActiveWorkbenchWindow()
Helper/convenience method. |
Object |
getAdapter(Class adapterType)
This is the method required by the IAdaptable interface. |
String |
getAdditionalAttributes()
Private. |
ICacheManager |
getCacheManager()
Return the CacheManager for this subsystem. |
Object[] |
getChildren()
Return the children of this subsystem, to populate the GUI subtree of this subsystem. |
RemoteCmdSubSystem |
getCommandSubSystem()
Return the associated command subsystem. |
String |
getConnectionOwnedFilterPoolName(String profileName,
String connectionName)
Return the name for the connection-owned filter pool. |
SystemFilterPool |
getConnectionPrivateFilterPool(boolean createIfNotFound)
Find or create a new filter pool, unique to this subsystem's connection. |
String[] |
getExecutedCommands()
Provide list of executed commands on subsystem.This is only applicable if the subsystem factory reports true for supportsCommands(). |
String |
getFactoryId()
Private. |
SystemFilterPoolReferenceManager |
getFilterPoolReferenceManager()
Private. |
protected Object |
getFilterReferenceWithAbsoluteName(String key)
Return the filter reference that corresponds to the specified key. |
protected String |
getFirstParentFilterString(Object parent)
Called by resolveFilterString when given null for the filter string, meaning we defer getting a filter string until later, where we query it from the parent. |
String |
getHostName()
Return the host name for the connection this system's subsystem is associated with |
String |
getIBMAttribute(String attributeName)
For IBM teams defining their own subsystems. |
String |
getIbmAttributes()
Private. |
String |
getLocalUserId()
Alternative to getUserId when we don't want to resolve it from parent connection. |
protected String |
getLocalUserId(String key)
Internal-use method for getting the local user ID, without resolution. |
String |
getName()
Private. |
Object |
getObjectWithAbsoluteName(String key)
For drag and drop, and clipboard, support of remote objects. |
SubSystemFactory |
getParentSubSystemFactory()
Return the parent subsystem factory that owns this subsystem. |
Integer |
getPort()
Private. |
int |
getPortAsInt()
Return the port for this subsystem |
protected String |
getPreferencesKey()
Helper method to compute a unique name for a given subsystem instance |
protected String |
getPreferencesKey(String profileName,
String connectionName)
Helper method to compute a unique name for a given subsystem instance, given a profile and connection name |
protected SystemPreferencesManager |
getPreferencesManager()
Helper method to return preference manager |
SubSystem |
getPrimarySubSystem()
Return the primary subsystem associated with this subsystem's ISystem |
String[] |
getProperties(Object subject,
String[] keys,
Shell shell)
Get a remote property. |
String |
getProperty(Object subject,
String key,
Shell shell)
Get a remote property. |
PropertyPage |
getPropertyPage(Composite parent)
Return the single property page to show in the tabbed notebook for the for SubSystem property of the parent Connection. |
protected static String |
getQueryingMessage()
Helper method to return the message "Querying properties..." |
protected static String |
getQueryingMessage(String key)
Helper method to return the message "Querying &1..." |
ServerLauncher |
getRemoteServerLauncher()
|
protected static String |
getResolvingMessage(String filterString)
Helper method to return the message "Resolving to &1..." |
protected IRunnableContext |
getRunnableContext(Shell rshell)
Get the progress monitor dialog for this operation. |
protected static String |
getRunningMessage(String cmd)
Helper method to return the message "Running command &1..." |
String |
getSaveFileName()
Return the unqualified file name to save this subsystem to. |
protected static String |
getSettingMessage()
Helper method to return the message "Setting properties..." |
protected static String |
getSettingMessage(String key)
Helper method to return the message "Setting &1..." |
protected Shell |
getShell()
Return the shell for the current operation |
ISystem |
getSystem()
Return the ISystem object that represents the live connection for this system.
|
SystemConnection |
getSystemConnection()
Return the connection object this subsystem is associated with. |
String |
getSystemConnectionName()
Return the name of system connection object this subsystem is associated with. |
SystemFilterPoolReferenceManager |
getSystemFilterPoolReferenceManager()
Return the system filter pool reference manager, as per the interface SystemFilterPoolReferenceManagerProvider |
AbstractSystemManager |
getSystemManager()
Return a singleton instance of an AbstractSystemManager subclass that manages
a pool of ISystem objects, one per system connection. |
SystemProfile |
getSystemProfile()
Return the system profile object this subsystem is associated with. |
String |
getSystemProfileName()
Return the name of system profile object this subsystem is associated with. |
String |
getSystemType()
Return the system type for this connection. |
Object |
getTargetForFilter(SystemFilterReference filterRef)
Returns the parent object associated with a filter reference. |
SystemUDActionSubsystem |
getUDActionSubsystem()
Defer to our subsystem factory, the request to get its singleton instance of the user defined action subsystem class. |
SystemFilterPool |
getUniqueOwningSystemFilterPool(boolean createIfNotFound)
Return the owning filter pool that is unique to this provider. |
String |
getUserId()
Returns the value of this subsystem's local user id if it is not null. |
String |
getUserIdGen()
Private. |
String |
getVendorAttribute(String vendorName,
String attributeName)
For business partners defining their own subsystems. |
String |
getVendorAttributes()
Private. |
boolean |
hasChildren()
CHILD CLASSES MAY OVERRIDE THIS. |
protected void |
internalCancelShell(IProgressMonitor monitor,
Object command)
|
protected void |
internalConnect(IProgressMonitor monitor,
String hostName,
int port)
Actually connect to the remote host. |
protected void |
internalDisconnect(IProgressMonitor monitor,
String hostName,
int port)
Actually disconnect from the remote host. |
protected String[] |
internalGetProperties(IProgressMonitor monitor,
Object subject,
String[] keys)
Actually get multiple remote properties. |
protected String |
internalGetProperty(IProgressMonitor monitor,
Object subject,
String key)
Actually get a remote property. |
protected void |
internalRemoveShell(Object command)
|
protected Object[] |
internalResolveFilterString(IProgressMonitor monitor,
Object parent,
String filterString)
Resolve a relative filter string. |
protected Object[] |
internalResolveFilterString(IProgressMonitor monitor,
String filterString)
Resolve an absolute filter string. |
Object[] |
internalResolveFilterStrings(IProgressMonitor monitor,
String[] filterStrings)
Resolve multiple absolute filter strings. |
protected Object[] |
internalRunCommand(IProgressMonitor monitor,
String cmd,
Object context)
Actually run a remote command. |
protected Object[] |
internalRunCommand(IProgressMonitor monitor,
String cmd,
Object context,
boolean interpretOutput)
Actually run a remote command. |
protected IRemoteCommandShell |
internalRunShell(IProgressMonitor monitor,
Object context)
|
protected void |
internalSendCommandToShell(IProgressMonitor monitor,
String cmd,
Object command)
|
protected Object |
internalSetProperties(IProgressMonitor monitor,
Object subject,
String[] keys,
String[] values)
Actually set multiple remote properties. |
protected Object |
internalSetProperty(IProgressMonitor monitor,
Object subject,
String key,
String value)
Actually set a remote property. |
boolean |
isConnected()
Return true if this subsystem is currently connected to its remote system. |
boolean |
isConnectionError()
Return true if the last attempt to connect this subsystem to its remote system failed. |
boolean |
isHidden()
Private. |
boolean |
isOffline()
Returns the offline property for this subsystem's System Connection. |
boolean |
isSetAdditionalAttributes()
Private. |
boolean |
isSetIbmAttributes()
Private. |
boolean |
isSetVendorAttributes()
Private. |
boolean |
isUseSSL()
Private. |
void |
removeShell(Shell shell,
Object commandObject)
Remove and Cancel a shell or running command. |
void |
renamingConnection(String newName)
The connection is being renamed, so we are called to do our thing with any information stored that is keyed by the connection name. |
void |
renamingProfile(String oldName,
String newName)
The profile is being renamed, so we are called to do our thing with any information stored that is keyed by the profile name. |
Object[] |
resolveFilterString(IProgressMonitor monitor,
Object parent,
String filterString)
Modal thread version of resolve filter strings Resolve an absolute filter string. |
Object[] |
resolveFilterString(IProgressMonitor monitor,
String filterString)
Modal thread version of resolve filter strings Resolve an absolute filter string. |
Object[] |
resolveFilterString(Object parent,
String filterString,
Shell shell)
Resolve a relative filter string. |
Object[] |
resolveFilterString(String filterString,
Shell shell)
Resolve an absolute filter string. |
Object[] |
resolveFilterStrings(IProgressMonitor monitor,
String[] filterStrings)
Modal thread version of resolve filter strings Resolve an absolute filter string. |
Object[] |
resolveFilterStrings(String[] filterStrings,
Shell shell)
Resolve multiple absolute filter strings. |
void |
run(IProgressMonitor monitor)
Method required by IRunnableWithProgress interface. |
Object[] |
runCommand(String command,
Shell shell,
Object context)
Execute a remote command. |
Object[] |
runCommand(String command,
Shell shell,
Object context,
boolean interpretOutput)
Execute a remote command. |
IRemoteCommandShell |
runShell(Shell shell,
Object context)
Launch a new command shell. |
protected SubSystem |
selectCommandSubSystem(SubSystem[] allCmdSubSystems)
Internal method to select the appropriate command subsystem when there are multiple defined for this connection. |
void |
sendCommandToShell(String input,
Shell shell,
Object commandObject)
Send a command as input to a running command shell. |
void |
setAdditionalAttributes(String newAdditionalAttributes)
Private. |
void |
setConnectionError(boolean error)
Sets whether the last attempt to connect this subsystem to its remote system failed. |
void |
setFactoryId(String newFactoryId)
Private. |
void |
setFilterPoolReferenceManager(SystemFilterPoolReferenceManager newFilterPoolReferenceManager)
Private. |
void |
setHidden(boolean newHidden)
Private. |
void |
setIBMAttribute(String attributeName,
String attributeValue)
For IBM teams defining their own subsystems. |
void |
setIbmAttributes(String newIbmAttributes)
Private. |
void |
setName(String newName)
Private. |
void |
setParentConnection(SystemConnection conn)
Set the parent connection that owns this subsystem. |
void |
setParentSubSystemFactory(SubSystemFactory ssf)
Return the parent subsystem factory that owns this subsystem. |
void |
setPort(Integer newPort)
Private. |
Object |
setProperties(Object subject,
String[] keys,
String[] values,
Shell shell)
Set multiple remote properties. |
Object |
setProperty(Object subject,
String key,
String value,
Shell shell)
Set a remote property. |
void |
setRemoteServerLauncher(ServerLauncher newRemoteServerLauncher)
|
void |
setSaveFileName(String name)
Set the unqualified file name to save this subsystem to. |
void |
setUserId(String newId)
Sets the local userId for this subsystem. |
void |
setUserIdGen(String newUserId)
Private. |
void |
setUseSSL(boolean newUseSSL)
Private. |
void |
setVendorAttribute(String vendorName,
String attributeName,
String attributeValue)
For business partners defining their own subsystems. |
void |
setVendorAttributes(String newVendorAttributes)
Private. |
protected void |
showConnectCancelledMessage(Shell shell,
String hostName,
int port)
Show an error message when the user cancels the connection. |
protected void |
showConnectErrorMessage(Shell shell,
String hostName,
int port,
Throwable exc)
Show an error message when the connection fails. |
protected void |
showDisconnectCancelledMessage(Shell shell,
String hostName,
int port)
Show an error message when the user cancels the disconnection. |
protected void |
showDisconnectErrorMessage(Shell shell,
String hostName,
int port,
Exception exc)
Show an error message when the disconnection fails. |
protected void |
showOperationCancelledMessage(Shell shell)
Show an error message when the user cancels the operation. |
protected void |
showOperationErrorMessage(Shell shell,
Throwable exc)
Show an error message when the operation fails. |
protected void |
showOperationMessage(Exception exc,
Shell shell)
|
protected Object[] |
sortResolvedFilterStringObjects(Object[] input)
Sort the concatenated list of all objects returned by resolving one or more filter strings. |
boolean |
supportsCaching()
Check if the SubSystem supports caching. |
String |
toString()
|
void |
unsetAdditionalAttributes()
Private. |
void |
unsetIbmAttributes()
Private. |
void |
unsetVendorAttributes()
Private. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected static final String NAME_EDEFAULT
Name
' attribute.
getName()
public static final String copyright
protected static final String SUBSYSTEM_FILE_NAME
protected static final int OPERATION_RESOLVE_ABSOLUTE
protected static final int OPERATION_RESOLVE_ABSOLUTES
protected static final int OPERATION_RESOLVE_RELATIVE
protected static final int OPERATION_RUN_COMMAND
protected static final int OPERATION_GET_PROPERTY
protected static final int OPERATION_SET_PROPERTY
protected static final int OPERATION_GET_PROPERTIES
protected static final int OPERATION_SET_PROPERTIES
protected static final int OPERATION_CONNECT
protected static final int OPERATION_DISCONNECT
protected static final int OPERATION_RUN_SHELL
protected static final int OPERATION_SEND_COMMAND_TO_SHELL
protected static final int OPERATION_CANCEL_SHELL
protected static final int OPERATION_REMOVE_SHELL
public static final String DELIM_VENDOR_ATTRS
public static final String DELIM_VENDOR_ATTR_VALUE
public static final String DELIM_VENDOR_NAME
protected SubSystemFactory parentSubSystemFactory
protected SystemConnection parentConnection
protected String previousUserIdKey
protected int operation
protected String runInput
protected String runInput2
protected Object runObject
protected String[] runInputs
protected String[] runInputs2
protected Object runOutput
protected String runOutputString
protected Object[] runOutputs
protected String[] runOutputStrings
protected Object runContext
protected boolean runInterpret
protected Exception runException
protected Shell shell
protected boolean supportsConnecting
protected boolean sortResults
protected boolean runInThread
protected boolean cancelable
protected boolean doConnection
protected ProgressMonitorDialog pmDialog
protected Hashtable vendorAttrs
protected Hashtable ibmAttrs
protected IProgressMonitor monitor
protected String saveFileName
protected ISystem _system
protected boolean _connectionError
protected boolean _disconnecting
protected String name
protected static final String USER_ID_EDEFAULT
User Id
' attribute.
getUserId()
protected String userId
protected static final Integer PORT_EDEFAULT
Port
' attribute.
getPort()
protected Integer port
protected static final String FACTORY_ID_EDEFAULT
Factory Id
' attribute.
getFactoryId()
protected String factoryId
protected static final boolean HIDDEN_EDEFAULT
Hidden
' attribute.
isHidden()
,
Constant Field Valuesprotected boolean hidden
protected static final boolean USE_SSL_EDEFAULT
Use SSL
' attribute.
isUseSSL()
,
Constant Field Valuesprotected boolean useSSL
protected static final String VENDOR_ATTRIBUTES_EDEFAULT
Vendor Attributes
' attribute.
getVendorAttributes()
protected String vendorAttributes
protected boolean vendorAttributesESet
protected static final String ADDITIONAL_ATTRIBUTES_EDEFAULT
Additional Attributes
' attribute.
getAdditionalAttributes()
protected String additionalAttributes
protected boolean additionalAttributesESet
protected static final String IBM_ATTRIBUTES_EDEFAULT
Ibm Attributes
' attribute.
getIbmAttributes()
protected String ibmAttributes
protected boolean ibmAttributesESet
protected SystemFilterPoolReferenceManager filterPoolReferenceManager
protected ServerLauncher remoteServerLauncher
Remote Server Launcher
' containment reference.
getRemoteServerLauncher()
Constructor Detail |
protected SubSystemImpl()
Method Detail |
protected EClass eStaticClass()
public RemoteCmdSubSystem getCommandSubSystem()
getCommandSubSystem
in interface SubSystem
protected SubSystem selectCommandSubSystem(SubSystem[] allCmdSubSystems)
public SubSystemFactory getParentSubSystemFactory()
getParentSubSystemFactory
in interface SubSystem
public void setParentSubSystemFactory(SubSystemFactory ssf)
setParentSubSystemFactory
in interface SubSystem
public void setParentConnection(SystemConnection conn)
setParentConnection
in interface SubSystem
public boolean forceUserIdToUpperCase()
forceUserIdToUpperCase
in interface SubSystem
public void renamingProfile(String oldName, String newName)
This is called AFTER the profile is renamed!
renamingProfile
in interface SubSystem
public void renamingConnection(String newName)
renamingConnection
in interface SubSystem
public void deletingConnection()
What we need to do is delete our entry in the preference store for our userId.
deletingConnection
in interface SubSystem
public String getUserId()
In fact, we now don't store the user Id in the subsystem object itself, but rather store it in the user preferences, so that such things are not shared among the team on a synchronize operation. This is transparent to callers of this method however, as this method resolves from the preferences.
getUserId
in interface SubSystem
SystemConnection.getDefaultUserId()
,
setUserId(String)
,
getLocalUserId()
,
clearLocalUserId()
public void setUserId(String newId)
Behind the scenes, the user Id is in fact not stored in this subsystem object. Rather, it is
stored in the user's preferences and the key value for that preference value is stored in the
subsystem object. The methods getUserId()
and getLocalUserId()
will take care
of resolving from the user preferences and returning the resolved value.
We store the userId in the user preferences to they are not shared among the team when the remote systems project is synchronized with a repository.
NOTE: YOU SHOULD USUALLY NOT CALL THIS. RATHER YOU SHOULD USUALLY CALL:
SubSystemFactory.updateSubSystem(Shell,SubSystem,boolean,String,boolean,Integer)
.
setUserId
in interface SubSystem
newId
- The new value of the UserId attribute. If it is null, then this is the same as
calling SubSystem.clearLocalUserId()
.protected SystemPreferencesManager getPreferencesManager()
protected String getPreferencesKey()
protected String getPreferencesKey(String profileName, String connectionName)
protected String getLocalUserId(String key)
public String getLocalUserId()
Unlike getUserId() this one does not defer to the connection's default user Id if the subsystem's userId attribute is null.
To set the local user Id, simply call setUserId(String id). To clear it, call
clearLocalUserId()
.
getLocalUserId
in interface SubSystem
SystemConnection.getDefaultUserId()
,
clearLocalUserId()
,
getUserId()
,
setUserId(String)
public void clearLocalUserId()
clearLocalUserId
in interface SubSystem
SystemConnection.getDefaultUserId()
,
getUserId()
,
getLocalUserId()
,
setUserId(String)
public int getPortAsInt()
getPortAsInt
in interface SubSystem
public void checkIsConnected() throws SystemMessageException
checkIsConnected
in interface SubSystem
SystemMessageException
public Object getAdapter(Class adapterType)
By default this returns Platform.getAdapterManager().getAdapter(this, adapterType); This in turn results in the default subsystem adapter SystemViewSubSystemAdapter, in package com.ibm.etools.systems.core.ui.view.
getAdapter
in interface IAdaptable
public SystemProfile getSystemProfile()
getSystemProfile
in interface SubSystem
SubSystem.getName()
public String getSystemProfileName()
getSystemProfileName
in interface SubSystem
public SystemConnection getSystemConnection()
getSystemConnection
in interface SubSystem
public String getSystemConnectionName()
getSystemConnectionName
in interface SubSystem
public SystemFilterPool getUniqueOwningSystemFilterPool(boolean createIfNotFound)
getConnectionPrivateFilterPool(boolean)
.
getUniqueOwningSystemFilterPool
in interface SystemFilterPoolReferenceManagerProvider
public SystemFilterPool getConnectionPrivateFilterPool(boolean createIfNotFound)
createIfNotFound
- - true to create the pool if it doesn't existpublic String getConnectionOwnedFilterPoolName(String profileName, String connectionName)
protected boolean doesFilterTypeMatch(SystemFilter filter, String remoteObjectAbsoluteName)
public boolean doesFilterListContentsOf(SystemFilter filter, String remoteObjectAbsoluteName)
Subclasses do not need to override this method. Rather, this method walks each filter string and calls doesFilterStringListContentsOf(...), and that is the method that child classes must override.
doesFilterListContentsOf
in interface SubSystem
public boolean doesFilterStringListContentsOf(SystemFilterString filterString, String remoteObjectAbsoluteName)
This should only return true if the filter string directly lists the contents of the given object, versus indirectly.
Subclasses should override this.
doesFilterStringListContentsOf
in interface SubSystem
public boolean doesFilterMatch(SystemFilter filter, String remoteObjectAbsoluteName)
Subclasses do not need to override this method. Rather, this method walks each filter string and calls doesFilterStringMatch(...), and that is the method that child classes must override.
doesFilterMatch
in interface SubSystem
public boolean doesFilterStringMatch(String filterString, String remoteObjectAbsoluteName, boolean caseSensitive)
Subclasses need to override this. If in doubt, return true.
doesFilterStringMatch
in interface SubSystem
public PropertyPage getPropertyPage(Composite parent)
getPropertyPage
in interface SubSystem
public Object getObjectWithAbsoluteName(String key) throws Exception
Return the object within the subsystem that corresponds to the specified unique ID. Because each subsystem maintains it's own objects, it's the responsability of the subsystem to determine how an ID (or key) for a given object maps to the real object. By default this returns null.
This is the functional opposite of ISystemRemoteElementAdapter.getAbsoluteName(Object)
.
getObjectWithAbsoluteName
in interface IRemoteObjectResolver
Exception
protected Object getFilterReferenceWithAbsoluteName(String key)
key
- the absolute name for an object.
public void setVendorAttribute(String vendorName, String attributeName, String attributeValue)
This method allows an attribute to be persisted in this subsystem, given the following information:
setVendorAttribute
in interface SubSystem
public String getVendorAttribute(String vendorName, String attributeName)
This method allows retrieval of a persisted attribute in this subsystem, given the following information:
getVendorAttribute
in interface SubSystem
public void setIBMAttribute(String attributeName, String attributeValue)
public String getIBMAttribute(String attributeName)
public String getSystemType()
public String getHostName()
protected void displayAsyncMsg(SystemMessageException msg)
public SystemFilterPoolReferenceManager getSystemFilterPoolReferenceManager()
getSystemFilterPoolReferenceManager
in interface SystemFilterPoolReferenceManagerProvider
protected void fireEvent(SystemResourceChangeEvent event)
protected void fireEvent(SystemResourceChangeEvent event, Object grandParent)
protected void fireEvent(Object src, int eventId, Object parent)
protected void fireEvent(Object[] multiSrc, int eventId, Object parent)
protected void fireEvent(Object[] src, int eventId, Object parent, int position)
protected void fireEvent(Object src, int eventId, Object parent, Object grandParent)
public void filterEventFilterPoolReferenceCreated(SystemFilterPoolReference newPoolRef)
filterEventFilterPoolReferenceCreated
in interface SystemFilterPoolReferenceManagerProvider
public void filterEventFilterPoolReferenceDeleted(SystemFilterPoolReference filterPoolRef)
filterEventFilterPoolReferenceDeleted
in interface SystemFilterPoolReferenceManagerProvider
public void filterEventFilterPoolReferenceReset(SystemFilterPoolReference filterPoolRef)
filterEventFilterPoolReferenceReset
in interface SystemFilterPoolReferenceManagerProvider
public void filterEventFilterPoolReferencesReset()
filterEventFilterPoolReferencesReset
in interface SystemFilterPoolReferenceManagerProvider
public void filterEventFilterPoolReferenceRenamed(SystemFilterPoolReference poolRef, String oldName)
filterEventFilterPoolReferenceRenamed
in interface SystemFilterPoolReferenceManagerProvider
public void filterEventFilterPoolReferencesRePositioned(SystemFilterPoolReference[] poolRefs, int delta)
filterEventFilterPoolReferencesRePositioned
in interface SystemFilterPoolReferenceManagerProvider
public void filterEventFilterCreated(Object selectedObject, SystemFilter newFilter)
Only the selected node should be expanded if not already. All other references to this pool will already have been informed of the new addition, and will have refreshed their children but not expanded them.
filterEventFilterCreated
in interface SystemFilterPoolReferenceManagerProvider
public void filterEventFilterStringCreated(Object selectedObject, SystemFilterString newFilterString)
Only the selected node should be expanded if not already. All other references to this filter will already have been informed of the new addition, and will have refreshed their children but not expanded them.
filterEventFilterStringCreated
in interface SystemFilterPoolReferenceManagerProvider
public void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException
InvocationTargetException
InterruptedException
protected void showOperationMessage(Exception exc, Shell shell)
protected void showConnectErrorMessage(Shell shell, String hostName, int port, Throwable exc)
protected void showConnectCancelledMessage(Shell shell, String hostName, int port)
protected void showDisconnectErrorMessage(Shell shell, String hostName, int port, Exception exc)
protected void showDisconnectCancelledMessage(Shell shell, String hostName, int port)
protected static String getResolvingMessage(String filterString)
protected static String getRunningMessage(String cmd)
protected static String getQueryingMessage(String key)
protected static String getSettingMessage(String key)
protected static String getQueryingMessage()
protected static String getSettingMessage()
protected void showOperationErrorMessage(Shell shell, Throwable exc)
protected void showOperationCancelledMessage(Shell shell)
public boolean isConnected()
isConnected
in interface SubSystem
public boolean isOffline()
isOffline
in interface SubSystem
public boolean hasChildren()
hasChildren
in interface SubSystem
public Object[] getChildren()
getChildren
in interface SubSystem
public Object[] resolveFilterString(String filterString, Shell shell) throws Exception
SubSystemFactoryImpl.supportsFilters()
,
which is the default. Otherwise, getChildren()
is called when the subsystem itself is expanded.
When a user expands a filter this method is invoked for each filter string and the
results are concatenated and displayed to the user. You can affect the post-concatenated
result by overriding sortResolvedFilterStringObjects(Object[])
if you desire to
sort the result, say, or pick our redundancies.
The resulting objects are displayed in the tree in the Remote System view
.
There are two requirements on the returned objects:
IAdaptable
.
remote-adapter
registered
for the object's class or interface type. Further, if this subsystem is visible
in the RSE, which is the default, then there must also be an RSE GUI-adapter
registered
with the platform. The base class implementation of this interface is AbstractSystemViewAdapter
.
A good place to start with your remote-resource classes to subclasss AbstractResource
, as it
already implements IAdaptable, and maintains a reference to this owning subsystem, which helps when
implementing the remote-adapter
.
Be sure to register your adapter factory in your plugin's startup method.
You do not need to override this, as it does the progress monitor and error message displaying for you. Just override internalResolveFilterString.
resolveFilterString
in interface SubSystem
filterString
- filter pattern for objects to return.
Exception
public Object[] resolveFilterStrings(String[] filterStrings, Shell shell) throws Exception
This is the same as resolveFilterString(String,Shell)
but takes an array of
filter strings versus a single filter string.
The default implementation of this simply calls resolveFilterString(String,Shell)
once for each filter string, and concatenates the result. The method sortResolvedFilterStringObject
is called on the concatenated result, given subclasses an opportunity to sort the result.
After successful resolve, the sort method is called to sort the concatenated results before returning them.
resolveFilterStrings
in interface SubSystem
filterStrings
- array of filter patterns for objects to return.
Exception
protected Object[] sortResolvedFilterStringObjects(Object[] input)
public Object[] resolveFilterString(IProgressMonitor monitor, String filterString) throws Exception
When a user expands a filter containing filter strings, this method is invoked for each filter string.
The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.
You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.
resolveFilterString
in interface SubSystem
monitor
- the process monitor associated with this operationfilterString
- filter pattern for objects to return.
Exception
public Object[] resolveFilterStrings(IProgressMonitor monitor, String[] filterStrings) throws Exception
When a user expands a filter containing filter strings, this method is invoked for each filter string.
The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.
You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.
resolveFilterStrings
in interface SubSystem
monitor
- the process monitor associated with this operationfilterStrings
- filter patterns for objects to return.
Exception
public Object[] resolveFilterString(IProgressMonitor monitor, Object parent, String filterString) throws Exception
When a user expands a filter containing filter strings, this method is invoked for each filter string.
The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.
You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.
resolveFilterString
in interface SubSystem
monitor
- the process monitor associated with this operationparent
- the object to queryfilterString
- filter pattern for objects to return.
Exception
public Object[] resolveFilterString(Object parent, String filterString, Shell shell) throws Exception
When a user expands a remote resource this method is invoked and the
results are potentially sorted and displayed to the user. You can affect the sorting
behaviour by overriding sortResolvedFilterStringObjects(Object[])
if you desire to
sort the result, say, or pick our redundancies.
The resulting objects are displayed in the tree in the Remote System view
.
There are two requirements on the returned objects:
IAdaptable
.
remote-adapter
registered
for the object's class or interface type. Further, if this subsystem is visible
in the RSE, which is the default, then there must also be an RSE GUI-adapter
registered
with the platform. The base class implementation of this interface is AbstractSystemViewAdapter
.
A good place to start with your remote-resource classes to subclasss AbstractResource
, as it
already implements IAdaptable, and maintains a reference to this owning subsystem, which helps when
implementing the remote-adapter
.
Be sure to register your adapter factory in your plugin's startup method.
You do not need to override this, as it does the progress monitor and error message displaying for you. Override internalResolveFilterString instead.
resolveFilterString
in interface SubSystem
parent
- Object that is being expanded.filterString
- filter pattern for children of parent. Typically just "*".
Exception
public Object[] runCommand(String command, Shell shell, Object context) throws Exception
command
- Command to be executed remotely.
Exception
public Object[] runCommand(String command, Shell shell, Object context, boolean interpretOutput) throws Exception
command
- Command to be executed remotely.interpretOutput
- indicates whether or not to interpret the output
Exception
public void sendCommandToShell(String input, Shell shell, Object commandObject) throws Exception
Exception
public void cancelShell(Shell shell, Object commandObject) throws Exception
Exception
public void removeShell(Shell shell, Object commandObject) throws Exception
Exception
public IRemoteCommandShell runShell(Shell shell, Object context) throws Exception
Exception
public String[] getExecutedCommands()
public Object setProperty(Object subject, String key, String value, Shell shell) throws Exception
setProperty
in interface SubSystem
subject
- Identifies which object to get the properties ofkey
- Identifies property to setvalue
- Value to set property to
Exception
public String getProperty(Object subject, String key, Shell shell) throws Exception
getProperty
in interface SubSystem
subject
- Identifies which object to get the properties ofkey
- Identifies property to get value of
Exception
public Object setProperties(Object subject, String[] keys, String[] values, Shell shell) throws Exception
setProperties
in interface SubSystem
subject
- Identifies which object to get the properties of
Exception
public void connect(Shell shell, boolean forcePrompt) throws Exception
Override internalConnect if you want, but by default it calls getSystem().connect(IProgressMonitor).
connect
in interface SubSystem
forcePrompt
- Forces the signon prompt to be displayed even if a valid password in cached in memory
or saved on disk.
Exception
public void connect(Shell shell) throws Exception
Override internalConnect if you want, but by default it calls getSystem().connect(IProgressMonitor).
connect
in interface SubSystem
Exception
public void connect() throws Exception
Override internalConnect if you want, but by default it calls getSystem().connect(IProgressMonitor).
connect
in interface SubSystem
Exception
public void disconnect(Shell shell) throws Exception
Override internalDisconnect if you want, but by default it calls getSystem().disconnect(IProgressMonitor).
disconnect
in interface SubSystem
Exception
public void disconnect(Shell shell, boolean collapseTree) throws Exception
Override internalDisconnect if you want, but by default it calls getSystem().disconnect(IProgressMonitor).
disconnect
in interface SubSystem
collapseTree
- collapse the tree in the system view
Exception
public boolean isConnectionError()
SubSystem
isConnectionError
in interface SubSystem
public void setConnectionError(boolean error)
SubSystem
setConnectionError
in interface SubSystem
public String[] getProperties(Object subject, String[] keys, Shell shell) throws Exception
getProperties
in interface SubSystem
subject
- Identifies which object to get the properties of
Exception
public ISystem getSystem()
ISystem
object that represents the live connection for this system.
This must return an object that implements ISystem. A good starting point for that
is the base class AbstractSystem
.
If you only have a single subsystem class, you may override this method to return the
ISystem object that manages the connect/disconnect actions. If, on the other hand,
you have multiple subsystem classes that desire to share a single ISystem connection,
(ie, share the same communications pipe) then do not override this. By default, this
calls getSystemManager() which returns an AbstractSystemManager
object that manages maintaining a singleton
ISystem object per system connection. You should subclass AbstractSystemManager,
and override getSystemManager() to return a singleton instance of that subclass.
Default implementation:
return getSystemManager().getSystemObject(this);
We recommending using a subclass of AbstractSystemManager
even for single
subsystems, because it doesn't hurt and allows easy growth if new subsystems
are added in the future.
getSystem
in interface SubSystem
public AbstractSystemManager getSystemManager()
AbstractSystemManager
subclass that manages
a pool of ISystem objects, one per system connection. By default, getSystem()
calls this, unless you override getSystem().
By default, this returns null so must be overridden if getSystem is not.
getSystemManager
in interface SubSystem
public boolean supportsCaching()
supportsCaching
in interface SubSystem
public ICacheManager getCacheManager()
getCacheManager
in interface SubSystem
supportsCaching()
protected void internalConnect(IProgressMonitor monitor, String hostName, int port) throws InvocationTargetException, InterruptedException
You DO NOT OVERRIDE THIS typically. Rather, this calls connect(IProgressMonitor) in your ISystem class that is returned from getSystem(). That is where your code to connect should go!
Your connect method in your ISystem class must follow these IRunnableWithProgress rules:
InvocationTargetException
InterruptedException
protected void internalDisconnect(IProgressMonitor monitor, String hostName, int port) throws InvocationTargetException, InterruptedException
You DO NOT OVERRIDE THIS typically. Rather, this calls connect(IProgressMonitor) in your ISystem class that is returned from getSystem(). That is where your code to disconnect should go!
Your connect method in your ISystem class must follow these IRunnableWithProgress rules:
InvocationTargetException
InterruptedException
protected Object[] internalResolveFilterString(IProgressMonitor monitor, String filterString) throws InvocationTargetException, InterruptedException
SubSystemFactoryImpl.supportsFilters()
,
which is the default. Otherwise, getChildren()
is called when the subsystem itself is expanded.
When a user expands a filter this method is invoked for each filter string and the
results are concatenated and displayed to the user. You can affect the post-concatenated
result by overriding sortResolvedFilterStringObjects(Object[])
if you desire to
sort the result, say, or pick our redundancies.
The resulting objects are displayed in the tree in the Remote System view
.
There are two requirements on the returned objects:
IAdaptable
.
remote-adapter
registered
for the object's class or interface type. Further, if this subsystem is visible
in the RSE, which is the default, then there must also be an RSE GUI-adapter
registered
with the platform. The base class implementation of this interface is AbstractSystemViewAdapter
.
A good place to start with your remote-resource classes to subclasss AbstractResource
, as it
already implements IAdaptable, and maintains a reference to this owning subsystem, which helps when
implementing the remote-adapter
.
Be sure to register your adapter factory in your plugin's startup method.
Actually resolve an absolute filter string. This is called by the run(IProgressMonitor monitor) method, which in turn is called by resolveFilterString.
As per IRunnableWithProgress rules:
InvocationTargetException
InterruptedException
public Object[] internalResolveFilterStrings(IProgressMonitor monitor, String[] filterStrings) throws InvocationTargetException, InterruptedException
This is the same as resolveFilterString(String,Shell)
but takes an array of
filter strings versus a single filter string.
The default implementation of this simply calls resolveFilterString(String,Shell)
once for each filter string, and concatenates the result. The method sortResolvedFilterStringObject
is called on the concatenated result, given subclasses an opportunity to sort the result.
After successful resolve, the sort method is called to sort the concatenated results before returning them.
monitor
- the progress monitor we are running underfilterStrings
- array of filter patterns for objects to return.
InvocationTargetException
InterruptedException
protected void addResolvedFilterStringObjects(Vector allChildrenSoFar, Object[] childrenForThisFilterString, String[] allFilterStrings, int currFilterStringIndex)
Can be used to filter out redundant entries in the concatenated list, if this is desired.
protected Object[] internalResolveFilterString(IProgressMonitor monitor, Object parent, String filterString) throws InvocationTargetException, InterruptedException
When a user expands a remote resource this method is invoked and the
results are potentially sorted and displayed to the user. You can affect the sorting
behaviour by overriding sortResolvedFilterStringObjects(Object[])
if you desire to
sort the result, say, or pick our redundancies.
The resulting objects are displayed in the tree in the Remote System view
.
There are two requirements on the returned objects:
IAdaptable
.
remote-adapter
registered
for the object's class or interface type. Further, if this subsystem is visible
in the RSE, which is the default, then there must also be an RSE GUI-adapter
registered
with the platform. The base class implementation of this interface is AbstractSystemViewAdapter
.
A good place to start with your remote-resource classes to subclasss AbstractResource
, as it
already implements IAdaptable, and maintains a reference to this owning subsystem, which helps when
implementing the remote-adapter
.
Be sure to register your adapter factory in your plugin's startup method.
This is called by the run(IProgressMonitor monitor) method, which in turn is called by resolveFilterString.
As per IRunnableWithProgress rules:
InvocationTargetException
InterruptedException
protected String getFirstParentFilterString(Object parent)
protected Object[] internalRunCommand(IProgressMonitor monitor, String cmd, Object context) throws InvocationTargetException, InterruptedException, SystemMessageException
As per IRunnableWithProgress rules:
InvocationTargetException
InterruptedException
SystemMessageException
protected Object[] internalRunCommand(IProgressMonitor monitor, String cmd, Object context, boolean interpretOutput) throws InvocationTargetException, InterruptedException, SystemMessageException
As per IRunnableWithProgress rules:
InvocationTargetException
InterruptedException
SystemMessageException
protected IRemoteCommandShell internalRunShell(IProgressMonitor monitor, Object context) throws InvocationTargetException, InterruptedException, SystemMessageException
InvocationTargetException
InterruptedException
SystemMessageException
protected void internalCancelShell(IProgressMonitor monitor, Object command) throws InvocationTargetException, InterruptedException
InvocationTargetException
InterruptedException
protected void internalRemoveShell(Object command) throws InvocationTargetException, InterruptedException
InvocationTargetException
InterruptedException
protected void internalSendCommandToShell(IProgressMonitor monitor, String cmd, Object command) throws InvocationTargetException, InterruptedException
InvocationTargetException
InterruptedException
protected String internalGetProperty(IProgressMonitor monitor, Object subject, String key) throws InvocationTargetException, InterruptedException
As per IRunnableWithProgress rules:
InvocationTargetException
InterruptedException
protected Object internalSetProperty(IProgressMonitor monitor, Object subject, String key, String value) throws InvocationTargetException, InterruptedException
As per IRunnableWithProgress rules:
InvocationTargetException
InterruptedException
protected String[] internalGetProperties(IProgressMonitor monitor, Object subject, String[] keys) throws InvocationTargetException, InterruptedException
As per IRunnableWithProgress rules:
InvocationTargetException
InterruptedException
protected Object internalSetProperties(IProgressMonitor monitor, Object subject, String[] keys, String[] values) throws InvocationTargetException, InterruptedException
As per IRunnableWithProgress rules:
InvocationTargetException
InterruptedException
public void setSaveFileName(String name)
It is important the name end with "_subsystem", so we can deduce it is a subsystem file, so this will be appended if not found.
setSaveFileName
in interface SubSystem
public String getSaveFileName()
In release 1.0, returned getName(). However, this is a translated name hence caused problems in a multi-linqual team environment.
As of release 2.0, this now returns the last part of the id of the parent factory, plus "_subsystem". For example, for "ibm.filesLocal" it returns "filesLocal_subsystem".
This can be overridden by calling setSaveFileName.
getSaveFileName
in interface SubSystem
public SystemUDActionSubsystem getUDActionSubsystem()
getUDActionSubsystem
in interface SubSystem
protected IRunnableContext getRunnableContext(Shell rshell)
protected Shell getShell()
public static Shell getActiveWorkbenchShell()
public static IWorkbenchWindow getActiveWorkbenchWindow()
public String getName()
getName
in interface SubSystem
public void setName(String newName)
setName
in interface SubSystem
newName
- The new value of the Name attributepublic Integer getPort()
getPort
in interface SubSystem
public void setPort(Integer newPort)
NOTE: YOU SHOULD USUALLY NOT CALL THIS. RATHER YOU SHOULD USUALLY CALL:
SubSystemFactory.updateSubSystem(Shell,SubSystem,boolean,String,boolean,Integer)
.
setPort
in interface SubSystem
newPort
- The new value of the Port attributepublic String getFactoryId()
getFactoryId
in interface SubSystem
public void setFactoryId(String newFactoryId)
setFactoryId
in interface SubSystem
newFactoryId
- The new value of the FactoryId attributepublic boolean isHidden()
isHidden
in interface SubSystem
public void setHidden(boolean newHidden)
setHidden
in interface SubSystem
newHidden
- The new value of the Hidden attributepublic SystemFilterPoolReferenceManager getFilterPoolReferenceManager()
getFilterPoolReferenceManager
in interface SubSystem
public NotificationChain basicSetFilterPoolReferenceManager(SystemFilterPoolReferenceManager newFilterPoolReferenceManager, NotificationChain msgs)
public void setFilterPoolReferenceManager(SystemFilterPoolReferenceManager newFilterPoolReferenceManager)
setFilterPoolReferenceManager
in interface SubSystem
public NotificationChain eInverseRemove(InternalEObject otherEnd, int featureID, Class baseClass, NotificationChain msgs)
public Object eGet(EStructuralFeature eFeature, boolean resolve)
public boolean eIsSet(EStructuralFeature eFeature)
public void eSet(EStructuralFeature eFeature, Object newValue)
public void eUnset(EStructuralFeature eFeature)
public String toString()
public String getUserIdGen()
public void setUserIdGen(String newUserId)
public String getVendorAttributes()
getVendorAttribute(String,String)
getVendorAttributes
in interface SubSystem
public void setVendorAttributes(String newVendorAttributes)
setVendorAttribute(String,String,String)
setVendorAttributes
in interface SubSystem
newVendorAttributes
- The new value of the VendorAttributes attributepublic void unsetVendorAttributes()
unsetVendorAttributes
in interface SubSystem
public boolean isSetVendorAttributes()
isSetVendorAttributes
in interface SubSystem
public String getAdditionalAttributes()
getAdditionalAttributes
in interface SubSystem
public void setAdditionalAttributes(String newAdditionalAttributes)
setAdditionalAttributes
in interface SubSystem
newAdditionalAttributes
- The new value of the AdditionalAttributes attributepublic void unsetAdditionalAttributes()
unsetAdditionalAttributes
in interface SubSystem
public boolean isSetAdditionalAttributes()
isSetAdditionalAttributes
in interface SubSystem
public boolean isUseSSL()
isUseSSL
in interface SubSystem
public SubSystem getPrimarySubSystem()
SubSystem
getPrimarySubSystem
in interface SubSystem
public void setUseSSL(boolean newUseSSL)
setUseSSL
in interface SubSystem
newUseSSL
- The new value of the UseSSL attributepublic String getIbmAttributes()
getIBMAttribute(String)
getIbmAttributes
in interface SubSystem
public void setIbmAttributes(String newIbmAttributes)
setIBMAttribute(String,String)
setIbmAttributes
in interface SubSystem
newIbmAttributes
- The new value of the IbmAttributes attributepublic void unsetIbmAttributes()
unsetIbmAttributes
in interface SubSystem
public boolean isSetIbmAttributes()
isSetIbmAttributes
in interface SubSystem
public ServerLauncher getRemoteServerLauncher()
getRemoteServerLauncher
in interface SubSystem
SubSystem.setRemoteServerLauncher(ServerLauncher)
,
SubsystemsPackage.getSubSystem_RemoteServerLauncher()
,
ServerLauncher.getParentSubSystem()
public NotificationChain basicSetRemoteServerLauncher(ServerLauncher newRemoteServerLauncher, NotificationChain msgs)
public void setRemoteServerLauncher(ServerLauncher newRemoteServerLauncher)
setRemoteServerLauncher
in interface SubSystem
newRemoteServerLauncher
- the new value of the 'Remote Server Launcher' containment reference.SubSystem.getRemoteServerLauncher()
public NotificationChain eInverseAdd(InternalEObject otherEnd, int featureID, Class baseClass, NotificationChain msgs)
public Object getTargetForFilter(SystemFilterReference filterRef)
SubSystem
getTargetForFilter
in interface SubSystem
filterRef
- the filter reference to determine a target object from.
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |