|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IHost
Interface for Host (SystemConnection) objects. An IHost holds information identifying a remote system. It also logically contains ISubSystem objects, although this containment is achievable programmatically versus via object oriented containment.
Field Summary |
---|
Fields inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer |
---|
NO_CHILDREN |
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)
Compare two userIds taking case sensitivity into account. |
void |
deletingHost()
Notification method called when this connection is being deleted. |
String |
getAliasName()
Get the unique user-visible connection name. |
IConnectorService[] |
getConnectorServices()
Returns all the connector services currently configured for this host |
String |
getDefaultEncoding(boolean fromRemote)
Returns the default encoding of the host. |
String |
getDefaultUserId()
Return the default user Id for this host. |
String |
getDescription()
Return the description of this host. |
boolean |
getForceUserIdToUpperCase()
Query whether the default userId is to be uppercased. |
String |
getHostName()
Get the host name or IP address. |
ISystemHostPool |
getHostPool()
Set the parent connection pool this is owned by. |
String |
getLocalDefaultUserId()
Return the local default user Id without resolving up the food chain. |
ISubSystem[] |
getSubSystems()
Return the subsystem instances under this connection. |
ISystemProfile |
getSystemProfile()
Return the system profile that owns this connection |
String |
getSystemProfileName()
Return the name of the system profile that owns this connection FIXME Check how this is different from getSystemProfile().getName() |
IRSESystemType |
getSystemType()
Get the system type. |
boolean |
isOffline()
Returns the value of the 'Offline' attribute. |
boolean |
isPromptable()
Check if this host is promptable. |
void |
renamingSystemProfile(String oldName,
String newName)
Notification method called when this connection's profile is being renamed. |
void |
setAliasName(String value)
Set the unique user-visible connection name. |
void |
setDefaultEncoding(String encoding,
boolean fromRemote)
Set the default encoding of the host. |
void |
setDefaultUserId(String value)
Intercept of setDefaultUserId so we can force it to uppercase. |
void |
setDescription(String value)
Set the description of this host. |
void |
setHostName(String value)
Set the host name or IP address. |
void |
setHostPool(ISystemHostPool pool)
Set the parent connection pool this is owned by. |
void |
setOffline(boolean value)
Specify if this connection is offline or not. |
void |
setPromptable(boolean value)
Set the promptable attribute. |
void |
setSystemType(IRSESystemType value)
Set the system type. |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.rse.core.model.IRSEModelObject |
---|
getName |
Methods inherited from interface org.eclipse.rse.core.model.IPropertySetContainer |
---|
addPropertySet, addPropertySets, clonePropertySets, createPropertySet, createPropertySet, getPropertySet, getPropertySets, removePropertySet |
Methods inherited from interface org.eclipse.rse.core.model.IRSEPersistableContainer |
---|
commit, getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored |
Method Detail |
---|
ISystemProfile getSystemProfile()
String getSystemProfileName()
void setHostPool(ISystemHostPool pool)
ISystemHostPool getHostPool()
ISubSystem[] getSubSystems()
ISystemRegistry.getSubSystems(IHost)
String getLocalDefaultUserId()
getDefaultUserId()
void clearLocalDefaultUserId()
Same as calling setDefaultUserId(null)
setDefaultUserId(String)
void deletingHost()
What we need to do is delete our entry in the preference store for our default userId.
void renamingSystemProfile(String oldName, String newName)
Implementations must not fork off other threads in the implementation of this method, since the old and new profiles will be locked during the rename operation so deadlock could occur when another thread tries to access theprofile during the time of rename ongoing.
What we need to do is rename our entry in the preference store for our default userId.
boolean getForceUserIdToUpperCase()
true
if the user id is to be uppercased.boolean compareUserIds(String userId1, String userId2)
userId1
- first id to compareuserId2
- second id to compareIRSESystemType getSystemType()
void setSystemType(IRSESystemType value)
value
- The new value of the SystemType attributeString getAliasName()
void setAliasName(String value)
value
- The new value of the AliasName attributeString getHostName()
void setHostName(String value)
value
- The new value of the HostName attributeString getDescription()
getDescription
in interface IRSEModelObject
void setDescription(String value)
value
- The new value of the Description attributeString getDefaultUserId()
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.
void setDefaultUserId(String value)
value
- The new value of the DefaultUserId attributeboolean isPromptable()
String getDefaultEncoding(boolean fromRemote)
If fromRemote is false
, returns an encoding preference
specified locally without querying the remote system (for example,
an encoding set by a user).
If fromRemote is true
, it first checks to see if there is
a local "overriding" encoding set by the client without querying the
remote system, and if such a "local" encoding preference does not exist,
returns the encoding that was set by the client by querying a remote system.
fromRemote
- false
to get the encoding that was
obtained by the client by not querying the remote system,
true
to also check the encoding, if needed, that was
set by the client after querying a remote system.
null
if
no encoding was set.setDefaultEncoding(String, boolean)
void setDefaultEncoding(String encoding, boolean fromRemote)
This method can only be called when no subsystem is connected. The client has to obtain the encoding either by querying the remote system, or by some other means (for example, set by a user).
encoding
- the encoding of the host, or null
to erase the current encoding.fromRemote
- true
if the encoding is set by the
client after querying the remote system, or false
otherwise (e.g. setting a local user preference).getDefaultEncoding(boolean)
void setPromptable(boolean value)
value
- The new value of the Promptable attributeboolean isOffline()
Query if this connection is offline or not. If so, there is no live connection. Subsystems decide how much to enable while offline. It is up to each subsystem to honor this flag.
setOffline(boolean)
void setOffline(boolean value)
value
- the new value of the 'Offline' attribute.isOffline()
IConnectorService[] getConnectorServices()
|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |