Remote Systems
v6.4.1

com.ibm.etools.systems.localfilesubsys.impl
Class LocalSystem

java.lang.Object
  extended bycom.ibm.etools.systems.subsystems.impl.AbstractSystem
      extended bycom.ibm.etools.systems.localfilesubsys.impl.LocalSystem
All Implemented Interfaces:
ISystem, ISystemUserIdConstants

public class LocalSystem
extends AbstractSystem

System class required by the remote systems framework. This represents the live connection at tool runtime. Since we don't really have such a thing for local files, this is pretty well empty.


Field Summary
static String copyright
           
 
Fields inherited from class com.ibm.etools.systems.subsystems.impl.AbstractSystem
connectResult, launchResult, shell
 
Fields inherited from interface com.ibm.etools.systems.core.ISystemUserIdConstants
USERID_LOCATION_CONNECTION, USERID_LOCATION_DEFAULT_OVERALL, USERID_LOCATION_DEFAULT_SYSTEMTYPE, USERID_LOCATION_NOTSET, USERID_LOCATION_SUBSYSTEM
 
Constructor Summary
  LocalSystem()
          Constructor when we don't have a subsystem yet.
protected LocalSystem(SubSystem subsystem)
          Constructor
 
Method Summary
 void connect(IProgressMonitor monitor)
          Abstract - you must override, unless subsystem.getParentSubSystemFactory().supportsServerLaunchProperties returns true Attempt to connect to the remote system.
 void disconnect()
          Abstract - you must override, unless subsystem.getParentSubSystemFactory().supportsServerLaunchProperties returns true Disconnect from the remote system.
 String getHomeDirectory()
          Return the home directory of the operating system for the current user, if available.
 String getTempDirectory()
          Return the temp directory of the operating system for the current user, if available.
 String getVersionReleaseModification()
          Return the version, release, modification of the operating system.
 boolean isConnected()
          Abstract - you must override unless subsystem.getParentSubSystemFactory().supportsServerLaunchProperties returns true Return true if currently connected.
 
Methods inherited from class com.ibm.etools.systems.subsystems.impl.AbstractSystem
addCommunicationsListener, clearCommunicationListeners, clearPasswordCache, clearPasswordCache, clearPasswordForOtherSystemsInConnection, clearUserIdCache, enableServerLaunchType, fireCommunicationsEvent, forcePasswordToUpperCase, getCommunicationListenerCount, getConnectPort, getHostName, getLocalUserId, getPasswordInformation, getPasswordPromptDialog, getPasswordValidator, getPort, getPrimarySubSystem, getRemoteServerLauncher, getSignonValidator, getSubSystem, getSystemType, getUserId, getUserIdValidator, inheritConnectionUserPassword, isEnabledServerLaunchType, isPasswordCached, isPasswordCached, isSuppressSignonPrompt, notifyConnection, notifyDisconnection, notifyError, promptForPassword, removeCommunicationsListener, reset, setPassword, setPassword, setPasswordInformation, setSubSystem, setSuppressSignonPrompt, shareUserPasswordWithConnection, updatePasswordForOtherSystemsInConnection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Constructor Detail

LocalSystem

public LocalSystem()
Constructor when we don't have a subsystem yet. Call setSubSystem after.


LocalSystem

protected LocalSystem(SubSystem subsystem)
Constructor

Method Detail

disconnect

public void disconnect()
                throws Exception
Description copied from class: AbstractSystem
Abstract - you must override, unless subsystem.getParentSubSystemFactory().supportsServerLaunchProperties returns true

Disconnect from the remote system.
If the subsystem supports server launch, the default behaviour here is to use the same remote server launcher created in connect(), and call IServerLauncher.disconnect().

This is called, by default, from the disConnect(..) method of the subsystem.

Specified by:
disconnect in interface ISystem
Overrides:
disconnect in class AbstractSystem
Throws:
Exception
See Also:
AbstractSystem.disconnect()

connect

public void connect(IProgressMonitor monitor)
             throws Exception
Description copied from class: AbstractSystem
Abstract - you must override, unless subsystem.getParentSubSystemFactory().supportsServerLaunchProperties returns true

Attempt to connect to the remote system.
If the subsystem supports server launch, the default behaviour here is to get the remote server launcher via AbstractSystem.getRemoteServerLauncher(), and if IServerLauncher.isLaunched() returns false, to call IServerLauncher.launch(IProgressMonitor).

This is called, by default, from the connect(...) methods of the subsystem.

Specified by:
connect in interface ISystem
Overrides:
connect in class AbstractSystem
Throws:
Exception
See Also:
ISystem.connect(IProgressMonitor)

isConnected

public boolean isConnected()
Description copied from class: AbstractSystem
Abstract - you must override unless subsystem.getParentSubSystemFactory().supportsServerLaunchProperties returns true

Return true if currently connected.
If the subsystem supports server launch, the default behaviour here is to see if there is a server launcher created in a previous call to connect, and if so, to test it by calling IServerLauncher.isConnected().

This is called, by default, from the isConnected method of the subsystem.

Specified by:
isConnected in interface ISystem
Overrides:
isConnected in class AbstractSystem
See Also:
ISystem.isConnected()

getVersionReleaseModification

public String getVersionReleaseModification()
Return the version, release, modification of the operating system.

Returns System.getProperty("os.version")

Specified by:
getVersionReleaseModification in interface ISystem
Overrides:
getVersionReleaseModification in class AbstractSystem

getHomeDirectory

public String getHomeDirectory()
Return the home directory of the operating system for the current user, if available.

Returns System.getProperty("user.home")

Specified by:
getHomeDirectory in interface ISystem
Overrides:
getHomeDirectory in class AbstractSystem

getTempDirectory

public String getTempDirectory()
Return the temp directory of the operating system for the current user, if available.

Returns System.getProperty("java.io.tmpdir")

Specified by:
getTempDirectory in interface ISystem
Overrides:
getTempDirectory in class AbstractSystem

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.