|
org.eclipse.rse.subsystems.terminals.core
Class TerminalServiceSubSystem
java.lang.Object
org.eclipse.rse.core.model.RSEPersistableObject
org.eclipse.rse.core.model.PropertySetContainer
org.eclipse.rse.core.model.RSEModelObject
org.eclipse.rse.core.subsystems.SubSystem
org.eclipse.rse.subsystems.terminals.core.TerminalServiceSubSystem
-
All Implemented Interfaces:
-
IAdaptable,
ISchedulingRule,
ISystemFilterPoolReferenceManagerProvider,
IPropertySetContainer,
IRSEModelObject,
IRSEPersistableContainer,
ICommunicationsListener,
IRemoteObjectResolver,
ISubSystem,
ITerminalServiceSubSystem
-
public class TerminalServiceSubSystem
- extends
SubSystem
- implements
ITerminalServiceSubSystem,
ICommunicationsListener
A Subsystem that has terminal instances as children.
EXPERIMENTAL. This class or interface has been added as part
of a work in progress. There is no guarantee that this API will work or that
it will remain the same. Please do not use this API without consulting with
the
Target Management team.
Nested classes/interfaces inherited from class org.eclipse.rse.core.subsystems.
SubSystem
|
SubSystem.ChangeStatusJob,
SubSystem.ConnectJob,
SubSystem.DisconnectJob,
SubSystem.DisplayErrorMessageJob,
SubSystem.GetPropertiesJob,
SubSystem.GetPropertyJob,
SubSystem.ResolveAbsoluteJob,
SubSystem.ResolveAbsolutesJob,
SubSystem.ResolveRelativeJob,
SubSystem.SetPropertiesJob,
SubSystem.SetPropertyJob,
SubSystem.SubSystemOperationJob,
SubSystem.SystemMessageDialogRunnable
|
Fields inherited from class org.eclipse.rse.core.subsystems.
SubSystem
|
_connectionError,
_connectorService,
_disconnecting,
_hidden,
_host,
_name,
_subsystemConfigurationId,
cancelable,
doConnection,
filterPoolReferenceManager,
OPERATION_CANCEL_SHELL,
OPERATION_CONNECT,
OPERATION_DISCONNECT,
OPERATION_GET_PROPERTIES,
OPERATION_GET_PROPERTY,
OPERATION_REMOVE_SHELL,
OPERATION_RESOLVE_ABSOLUTE,
OPERATION_RESOLVE_ABSOLUTES,
OPERATION_RESOLVE_RELATIVE,
OPERATION_RUN_COMMAND,
OPERATION_RUN_SHELL,
OPERATION_SEND_COMMAND_TO_SHELL,
OPERATION_SET_PROPERTIES,
OPERATION_SET_PROPERTY,
parentSubSystemConfiguration,
pmDialog,
previousUserIdKey,
runInThread,
saveFileName,
shell,
sortResults,
SUBSYSTEM_FILE_NAME,
supportsConnecting
|
Methods inherited from class org.eclipse.rse.core.subsystems.
SubSystem
|
addResolvedFilterStringObjects,
checkIsConnected,
clearLocalUserId,
commit,
connect,
connect,
contains,
deletingConnection,
disconnect,
disconnect,
displayAsyncMsg,
doesFilterListContentsOf,
doesFilterMatch,
doesFilterStringListContentsOf,
doesFilterStringMatch,
doesFilterTypeMatch,
filterEventFilterCreated,
filterEventFilterPoolReferenceCreated,
filterEventFilterPoolReferenceDeleted,
filterEventFilterPoolReferenceRenamed,
filterEventFilterPoolReferenceReset,
filterEventFilterPoolReferencesRePositioned,
filterEventFilterPoolReferencesReset,
filterEventFilterStringCreated,
fireEvent,
fireEvent,
fireEvent,
fireEvent,
fireEvent,
fireEvent,
forceUserIdToUpperCase,
getAdapter,
getCacheManager,
getConfigurationId,
getConnectionOwnedFilterPoolName,
getConnectionPrivateFilterPool,
getConnectorService,
getExecutedCommands,
getFilterPoolReferenceManager,
getFilterReferenceWithAbsoluteName,
getFirstParentFilterString,
getHost,
getHostAliasName,
getHostName,
getInteractionProvider,
getLocalUserId,
getLocalUserId,
getName,
getObjectWithAbsoluteName,
getObjectWithAbsoluteName,
getPersistableChildren,
getPersistableParent,
getPreferencesKey,
getPreferencesKey,
getPrimarySubSystem,
getProperties,
getProperty,
getPropertyPage,
getQueryingMessage,
getQueryingMessage,
getRemoteAttribute,
getResolvingMessage,
getRunnableContext,
getRunningMessage,
getSettingMessage,
getSettingMessage,
getShell,
getSubSystemConfiguration,
getSystemFilterPoolReferenceManager,
getSystemProfile,
getSystemProfileName,
getTargetForFilter,
getTargetsForFilter,
getUniqueOwningSystemFilterPool,
getUserId,
getVendorAttribute,
implicitConnect,
internalDisconnect,
internalGetProperties,
internalGetProperty,
internalResolveFilterString,
internalResolveFilterString,
internalResolveFilterStrings,
internalSetProperties,
internalSetProperty,
internalSwitchSubSystemConfiguration,
isConflicting,
isConnected,
isConnectionError,
isHidden,
isOffline,
isPrimarySubSystem,
promptForPassword,
promptForPassword,
renamingConnection,
renamingProfile,
resolveFilterString,
resolveFilterString,
resolveFilterStrings,
scheduleJob,
selectCommandSubSystem,
setConfigurationId,
setConnectionError,
setConnectorService,
setFilterPoolReferenceManager,
setHidden,
setHost,
setInteractionProvider,
setName,
setProperties,
setProperty,
setRemoteAttribute,
setSubSystemConfiguration,
setVendorAttribute,
showConnectCancelledMessage,
showConnectErrorMessage,
showDisconnectCancelledMessage,
showDisconnectErrorMessage,
showOperationCancelledMessage,
showOperationErrorMessage,
showOperationMessage,
sortResolvedFilterStringObjects,
supportsCaching,
switchServiceFactory
|
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
Methods inherited from interface org.eclipse.rse.core.subsystems.
ISubSystem
|
checkIsConnected,
clearLocalUserId,
connect,
connect,
deletingConnection,
disconnect,
disconnect,
doesFilterListContentsOf,
doesFilterMatch,
doesFilterStringListContentsOf,
doesFilterStringMatch,
forceUserIdToUpperCase,
getCacheManager,
getConfigurationId,
getConnectorService,
getFilterPoolReferenceManager,
getHost,
getHostAliasName,
getLocalUserId,
getName,
getPrimarySubSystem,
getProperties,
getProperty,
getSubSystemConfiguration,
getSystemFilterPoolReferenceManager,
getSystemProfile,
getSystemProfileName,
getTargetForFilter,
getUserId,
getVendorAttribute,
isConnected,
isConnectionError,
isHidden,
isOffline,
isPrimarySubSystem,
renamingConnection,
renamingProfile,
resolveFilterString,
resolveFilterString,
resolveFilterStrings,
setConfigurationId,
setConnectionError,
setConnectorService,
setFilterPoolReferenceManager,
setHidden,
setHost,
setName,
setProperties,
setProperty,
setSubSystemConfiguration,
setVendorAttribute,
supportsCaching,
switchServiceFactory
|
TerminalServiceSubSystem
public TerminalServiceSubSystem(
IHost host,
IConnectorService connectorService,
ITerminalService hostService)
- Constructor.
-
Since:
- 1.0
getTerminalService
public
ITerminalService getTerminalService()
- Return the Terminal Service associated with this subsystem.
-
-
-
Since:
- 1.0
getServiceType
public
Class getServiceType()
-
Description copied from class:
SubSystem
- Return the service type for this subsystem.
-
-
Specified by:
-
getServiceType
in interface
ISubSystem
-
Overrides:
-
getServiceType
in class
SubSystem
-
-
Returns:
- the default implementation returns null. Subclasses that
implement service subsystems should return a type as specified in the
interface.
-
See Also:
-
ISubSystem.getServiceType()
addChild
public void addChild(
TerminalElement element)
-
-
Specified by:
-
addChild
in interface
ITerminalServiceSubSystem
-
removeChild
public void removeChild(
TerminalElement element)
-
-
Specified by:
-
removeChild
in interface
ITerminalServiceSubSystem
-
removeChild
public void removeChild(
String terminalTitle)
-
-
Specified by:
-
removeChild
in interface
ITerminalServiceSubSystem
-
getChild
public
TerminalElement getChild(
String terminalTitle)
-
-
Specified by:
-
getChild
in interface
ITerminalServiceSubSystem
-
getChildren
public
Object[] getChildren()
-
Description copied from class:
SubSystem
- Return the children of this subsystem, to populate the GUI subtree of
this subsystem. By default, this method:
- Returns the filter pool references of this subsystem, if
supportsFilters() is true for our factory.
- If supportsFilters() is false from our factory, returns null
So, be sure to override this method IF you do not support filters.
Lazy Loading: Note that if your subsystem does not support connecting,
and you do not support filters, here is a good point to ensure that the
bundles which declare your UI adapters get loaded, since the default code
which overriders usually place in
SubSystem.initializeSubSystem(IProgressMonitor) is not called in that
case. Similarly, if your subsystem declares custom images for filters or
filter pools, overriding the getChildren() call here to first load your
filter adapters and THEN super.getChildren() is a good idea.
-
-
Specified by:
-
getChildren
in interface
ISubSystem
-
Overrides:
-
getChildren
in class
SubSystem
-
hasChildren
public boolean hasChildren()
-
Description copied from class:
SubSystem
- CHILD CLASSES MAY OVERRIDE THIS.
By default it returns true iff we support filters and there are filter pool references.
-
-
Specified by:
-
hasChildren
in interface
ISubSystem
-
Overrides:
-
hasChildren
in class
SubSystem
-
setTerminalService
public void setTerminalService(
ITerminalService service)
- Set the terminal service associated with this subsystem.
-
-
-
Since:
- 1.0
communicationsStateChange
public void communicationsStateChange(
CommunicationsEvent e)
-
Description copied from interface:
ICommunicationsListener
- This method is invoked whenever the communications state is invoked
immediately before and after the state of the communications changes.
The state field in CommunicationsEvent determines which state
change is about to or has occurred.
-
-
Specified by:
-
communicationsStateChange
in interface
ICommunicationsListener
-
isPassiveCommunicationsListener
public boolean isPassiveCommunicationsListener()
-
Description copied from interface:
ICommunicationsListener
- This method determines if the communications listener is a passive or
active listener. Typically a passive listener registers with the communications
system and responds to events as they occur. An active listener typically
registers with the communications system only for the duration of the task (i.e.
user editing a file, or outstanding communications request.)
The user will be prompted on a disconnect if there are any active communication
listeners registered.
-
-
Specified by:
-
isPassiveCommunicationsListener
in interface
ICommunicationsListener
-
-
Returns:
- false if the communications listener is an active listener, true if the
communications listener is a passive listener.
cancelAllTerminals
public void cancelAllTerminals()
- Set the terminal service associated with this subsystem.
-
-
initializeSubSystem
public void initializeSubSystem(
IProgressMonitor monitor)
throws
SystemMessageException
-
Description copied from class:
SubSystem
- Initialize this subsystem instance after the corresponding
IConnectorService connect method finishes. This method should be
overridden if any initialization for the subsystem needs to occur at this
time.
The default implementation currently does nothing, but overriding methods
should call super before doing any other work.
-
-
Specified by:
-
initializeSubSystem
in interface
ISubSystem
-
Overrides:
-
initializeSubSystem
in class
SubSystem
-
-
Parameters:
-
monitor - a progress monitor that can be used to show progress
during long-running operation. Cancellation is typically not
supported since it might leave the system in an inconsistent
state.
-
Throws:
-
SystemMessageException
- if an error occurs during initialization.
uninitializeSubSystem
public void uninitializeSubSystem(
IProgressMonitor monitor)
-
Description copied from class:
SubSystem
- Uninitialize this subsystem just after disconnect. The default
implementation currently does nothing. Overriding methods should call
super after doing their own work.
-
-
Specified by:
-
uninitializeSubSystem
in interface
ISubSystem
-
Overrides:
-
uninitializeSubSystem
in class
SubSystem
-
-
Parameters:
-
monitor - a progress monitor that can be used to show progress
during long-running operation. Cancellation is typically not
supported since it might leave the system in an inconsistent
state.
canSwitchTo
public boolean canSwitchTo(
ISubSystemConfiguration configuration)
-
Description copied from class:
SubSystem
- Determine if a service subsystem is capable of switching to this new
configuration. This is usually a test of this configuration's type
against the type expected by this subsystem. This supplied implementation
returns false. Subclasses should override if they implement a service
subsystem.
-
-
Specified by:
-
canSwitchTo
in interface
ISubSystem
-
Overrides:
-
canSwitchTo
in class
SubSystem
-
-
Parameters:
-
configuration - the configuration to which this subsystem may switch
-
Returns:
- true if this subsystem is capable of switching to this
configuration, false otherwise. This implementation returns false.
-
See Also:
-
ISubSystem.canSwitchTo(ISubSystemConfiguration)
getParentRemoteTerminalSubSystemConfiguration
public
ITerminalServiceSubSystemConfiguration getParentRemoteTerminalSubSystemConfiguration()
-
-
Specified by:
-
getParentRemoteTerminalSubSystemConfiguration
in interface
ITerminalServiceSubSystem
-
-
Returns:
- parent subsystem factory, cast to a
ITerminalServiceSubSystemConfiguration
-
Since:
- 1.0
Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.
|
|