Remote Systems
v6.4.1

com.ibm.etools.systems.model
Interface SystemConnection

All Known Implementing Classes:
SystemConnectionImpl

public interface SystemConnection


Field Summary
static String copyright
           
 
Method Summary
 void clearLocalDefaultUserId()
          Clear the local default user Id so next query will return the value from the preference store.
 boolean compareUserIds(String userId1, String userId2)
          Call this to compare two userIds taking case sensitivity
 void deletingConnection()
          Private method called when this connection is being deleted, so we can do any pre-death cleanup we need.
 String getAliasName()
           
 RemoteCmdSubSystem getCmdSubSystem()
          Return the pre-supplied subsystem for command shell access.
 SystemConnectionPool getConnectionPool()
          Set the parent connection pool this is owned by.
 String getDefaultUserId()
          We return the default user Id.
 String getDescription()
           
 RemoteFileSubSystem getFileSubSystem()
          Return the pre-supplied subsystem for file system access.
 boolean getForceUserIdToUpperCase()
          Call this to query whether the default userId is to be uppercased.
 String getHostName()
           
 String getLocalDefaultUserId()
          Return the local default user Id without resolving up the food chain.
 SubSystem[] getSubSystems()
          Return the subsystem instances under this connection.
 SystemProfile getSystemProfile()
          Return the system profile that owns this connection
 String getSystemProfileName()
          Return the name of the system profile that owns this connection
 String getSystemType()
           
 boolean isOffline()
          Returns the value of the 'Offline' attribute
 boolean isPromptable()
           
 void renamingSystemProfile(String oldName, String newName)
          Private method called when this connection's profile is being rename, so we can do any pre-death cleanup we need.
 void setAliasName(String value)
           
 void setConnectionPool(SystemConnectionPool pool)
          Set the parent connection pool this is owned by.
 void setDefaultUserId(String value)
          Intercept of setDefaultUserId so we can force it to uppercase.
 void setDescription(String value)
           
 void setHostName(String value)
           
 void setOffline(boolean value)
          Sets the value of the 'Offline' attribute
 void setPromptable(boolean value)
           
 void setSystemType(String value)
           
 

Field Detail

copyright

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

getSystemProfile

public SystemProfile getSystemProfile()
Return the system profile that owns this connection


getSystemProfileName

public String getSystemProfileName()
Return the name of the system profile that owns this connection


setConnectionPool

public void setConnectionPool(SystemConnectionPool pool)
Set the parent connection pool this is owned by. Connection pools are internal management objects, one per profile.


getConnectionPool

public SystemConnectionPool getConnectionPool()
Set the parent connection pool this is owned by. Connection pools are internal management objects, one per profile.


getSubSystems

public SubSystem[] getSubSystems()
Return the subsystem instances under this connection. Just a shortcut to SystemRegistry.getSubSystems(SystemConnection)


getFileSubSystem

public RemoteFileSubSystem getFileSubSystem()
Return the pre-supplied subsystem for file system access. It is possible, but rare, that will return null, if the connection is for a system type which does not have a file system.
Just a shortcut to SystemRegistry.getFileSubSystem(SystemConnection)


getCmdSubSystem

public RemoteCmdSubSystem getCmdSubSystem()
Return the pre-supplied subsystem for command shell access. It is possible, but rare, that will return null, if the connection is for a system type which does not support a unix/windows-like command shell.
Just a shortcut to SystemRegistry.getCmdSubSystem(SystemConnection)


getLocalDefaultUserId

public String getLocalDefaultUserId()
Return the local default user Id without resolving up the food chain.

See Also:
getDefaultUserId()

clearLocalDefaultUserId

public void clearLocalDefaultUserId()
Clear the local default user Id so next query will return the value from the preference store.

Same as calling setDefaultUserId(null)

See Also:
setDefaultUserId(String)

deletingConnection

public void deletingConnection()
Private method called when this connection is being deleted, so we can do any pre-death cleanup we need.

What we need to do is delete our entry in the preference store for our default userId.


renamingSystemProfile

public void renamingSystemProfile(String oldName,
                                  String newName)
Private method called when this connection's profile is being rename, so we can do any pre-death cleanup we need.

What we need to do is rename our entry in the preference store for our default userId.


getForceUserIdToUpperCase

public boolean getForceUserIdToUpperCase()
Call this to query whether the default userId is to be uppercased.


compareUserIds

public boolean compareUserIds(String userId1,
                              String userId2)
Call this to compare two userIds taking case sensitivity


getSystemType

public String getSystemType()
Returns:
The value of the SystemType attribute

setSystemType

public void setSystemType(String value)
Parameters:
value - The new value of the SystemType attribute

getAliasName

public String getAliasName()
Returns:
The value of the AliasName attribute The unique key for this object. Unique per connection pool

setAliasName

public void setAliasName(String value)
Parameters:
value - The new value of the AliasName attribute

getHostName

public String getHostName()
Returns:
The value of the HostName attribute

setHostName

public void setHostName(String value)
Parameters:
value - The new value of the HostName attribute

getDescription

public String getDescription()
Returns:
The value of the Description attribute

setDescription

public void setDescription(String value)
Parameters:
value - The new value of the Description attribute

getDefaultUserId

public String getDefaultUserId()
We return the default user Id. Note that we don't store it directly in the mof-modelled attribute, as we don't want the team to share it. Rather, we store the actual user Id in the preference store keyed by this connection's unique name (profile.connName) and store that key in this attribute.

Further, it is possible that there is no default user id. If so, this method will go to the preference store and will try to get the default user Id per this connection's system type.

This is all transparent to the caller though.

Returns:
The value of the DefaultUserId attribute

setDefaultUserId

public void setDefaultUserId(String value)
Intercept of setDefaultUserId so we can force it to uppercase. Also, we do not store the user Id per se in the attribute, but rather we store it in the preference with a key name unique to this connection. We store that key name in this attribute. However, this is all transparent to the caller.

Parameters:
value - The new value of the DefaultUserId attribute

isPromptable

public boolean isPromptable()
Returns:
The value of the Promptable attribute

setPromptable

public void setPromptable(boolean value)
Parameters:
value - The new value of the Promptable attribute

isOffline

public boolean isOffline()
Returns the value of the 'Offline' attribute.

Is this connection offline? If so, there is no live connection. Subsystems decide how much to enable while offline.

Returns:
the value of the 'Offline' attribute.
See Also:
setOffline(boolean), ModelPackage.getSystemConnection_Offline()

setOffline

public void setOffline(boolean value)
Sets the value of the 'Offline' attribute.

Parameters:
value - the new value of the 'Offline' attribute.
See Also:
isOffline()

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.