java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JInternalFrame
com.sshtools.common.ui.SshToolsApplicationInternalFrame
com.sshtools.common.ui.SessionProviderInternalFrame
- All Implemented Interfaces:
- javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, SessionManager, SshToolsApplicationContainer, javax.swing.WindowConstants
- public class SessionProviderInternalFrame
- extends SshToolsApplicationInternalFrame
- implements SessionManager
This frame class embeds a SessionProvider and manages the connection
on behalf of the caller. To invoke a session provider from an external
application is a straight forward procedure. Assuming that the connection
has already been established [see SshClient] you can invoke a frame using
the following code:
// Create an SshClient connection
SshClient ssh = new SshClient();
// Connection code goes here - see SshClient for more details
SessionProviderFrame frame = new SessionProviderFrame(null,
new SshToolsConnectionProfile(),
ssh,
SessionProviderFactory.getInstance().getProvider("sshterm"));
frame.pack();
frame.show();
- Version:
- $Id: SessionProviderInternalFrame.java,v 1.3 2003/09/24 11:26:32 martianx Exp $
| Nested classes inherited from class javax.swing.JInternalFrame |
javax.swing.JInternalFrame.AccessibleJInternalFrame, javax.swing.JInternalFrame.JDesktopIcon |
| Nested classes inherited from class javax.swing.JComponent |
javax.swing.JComponent.AccessibleJComponent |
| Nested classes inherited from class java.awt.Container |
java.awt.Container.AccessibleAWTContainer |
| Nested classes inherited from class java.awt.Component |
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy |
| Fields inherited from class javax.swing.JInternalFrame |
closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY |
| Fields inherited from class java.awt.Container |
|
|
Method Summary |
void |
addEventHandler(com.sshtools.j2ssh.SshEventAdapter eventHandler)
Implementation of the SessionManager method, simply calls the SshClient
method addEventHandler. |
void |
allowChannelOpen(java.lang.String channelType,
com.sshtools.j2ssh.connection.ChannelFactory cf)
Implemenation of the SessionManager method, simply calls the SshClient
method allowChannelOpen. |
void |
applyProfileChanges(com.sshtools.common.configuration.SshToolsConnectionProfile profile)
Implementation of the SessionManager method, this does nothing. |
boolean |
canExit()
Called by the application framework when testing exit state |
void |
exit()
Called by the framework when exiting. |
com.sshtools.j2ssh.forwarding.ForwardingClient |
getForwardingClient()
Implementation of the SessionManager method, simply calls the SshClient
method getForwardingClient. |
com.sshtools.common.configuration.SshToolsConnectionProfile |
getProfile()
Gets the profile currently attached to the frame. |
int |
getRemoteEOL()
Returns the guessed EOL setting of the remote computer |
java.lang.String |
getServerId()
Implemenation of the SessionManager method, simply calls the SshClient
method getServerId. |
SshToolsApplicationSessionPanel |
getSessionPanel()
Get the attached session provider panel. |
boolean |
initFrame(SshToolsApplication app)
Initialize the frame and open the remote session |
boolean |
isConnected()
Implementation of the SessionManager method, this simply calls the SshClient
method isConnected. |
boolean |
openChannel(com.sshtools.j2ssh.connection.Channel channel)
Implementation of the SessionManager method, this simply calls the SshClient
method openChannel. |
com.sshtools.j2ssh.session.SessionChannelClient |
openSession()
Implementation of the SessionManager method, simply calls the SshClient
openSession method. |
com.sshtools.j2ssh.SftpClient |
openSftpClient()
Implementation of the SessionManager method, this simply calls the SshClient
method openSftpClient. |
boolean |
requestDisconnect()
Implementation of the SessionManager method, this simply returns false. |
byte[] |
sendGlobalRequest(java.lang.String requestname,
boolean wantreply,
byte[] requestdata)
Implementation of the SessionManager method, simply calls the SshClient
method sendGlobalRequest. |
void |
setDisconnectOnClose(boolean disconnectOnClose)
When the session closes, should the connection be disconnected? |
| Methods inherited from class javax.swing.JInternalFrame |
addImpl, addInternalFrameListener, createRootPane, dispose, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setTitle, setUI, show, toBack, toFront, updateUI |
| Methods inherited from class javax.swing.JComponent |
addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update |
| Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, transferFocusDownCycle, validate, validateTree |
| Methods inherited from class java.awt.Component |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle |
panel
private SshToolsApplicationSessionPanel panel
provider
private SessionProvider provider
profile
private com.sshtools.common.configuration.SshToolsConnectionProfile profile
ssh
private com.sshtools.j2ssh.SshClient ssh
disconnectOnClose
private boolean disconnectOnClose
SessionProviderInternalFrame
public SessionProviderInternalFrame(com.sshtools.common.configuration.SshToolsConnectionProfile profile,
com.sshtools.j2ssh.SshClient ssh,
SessionProvider provider)
throws java.io.IOException,
SshToolsApplicationException
- Construct a new Session Provider frame.
initFrame
public boolean initFrame(SshToolsApplication app)
throws java.io.IOException,
SshToolsApplicationException
- Initialize the frame and open the remote session
getSessionPanel
public SshToolsApplicationSessionPanel getSessionPanel()
- Get the attached session provider panel.
canExit
public boolean canExit()
- Called by the application framework when testing exit state
exit
public void exit()
- Called by the framework when exiting. Can also be called to close the session.
openSession
public com.sshtools.j2ssh.session.SessionChannelClient openSession()
throws java.io.IOException
- Implementation of the SessionManager method, simply calls the SshClient
openSession method.
- Specified by:
openSession in interface SessionManager
getRemoteEOL
public int getRemoteEOL()
- Returns the guessed EOL setting of the remote computer
- Specified by:
getRemoteEOL in interface SessionManager
applyProfileChanges
public void applyProfileChanges(com.sshtools.common.configuration.SshToolsConnectionProfile profile)
- Implementation of the SessionManager method, this does nothing. Overide this
method to provide additional functionality to save changes made by the session
to the profile.
- Specified by:
applyProfileChanges in interface SessionManager
openSftpClient
public com.sshtools.j2ssh.SftpClient openSftpClient()
throws java.io.IOException
- Implementation of the SessionManager method, this simply calls the SshClient
method openSftpClient.
- Specified by:
openSftpClient in interface SessionManager
openChannel
public boolean openChannel(com.sshtools.j2ssh.connection.Channel channel)
throws java.io.IOException
- Implementation of the SessionManager method, this simply calls the SshClient
method openChannel.
- Specified by:
openChannel in interface SessionManager
isConnected
public boolean isConnected()
- Implementation of the SessionManager method, this simply calls the SshClient
method isConnected.
- Specified by:
isConnected in interface SessionManager
setDisconnectOnClose
public void setDisconnectOnClose(boolean disconnectOnClose)
- When the session closes, should the connection be disconnected?
requestDisconnect
public boolean requestDisconnect()
- Implementation of the SessionManager method, this simply returns false.
Overide to change this behaviour
- Specified by:
requestDisconnect in interface SessionManager
getForwardingClient
public com.sshtools.j2ssh.forwarding.ForwardingClient getForwardingClient()
- Implementation of the SessionManager method, simply calls the SshClient
method getForwardingClient.
- Specified by:
getForwardingClient in interface SessionManager
sendGlobalRequest
public byte[] sendGlobalRequest(java.lang.String requestname,
boolean wantreply,
byte[] requestdata)
throws java.io.IOException
- Implementation of the SessionManager method, simply calls the SshClient
method sendGlobalRequest.
- Specified by:
sendGlobalRequest in interface SessionManager
addEventHandler
public void addEventHandler(com.sshtools.j2ssh.SshEventAdapter eventHandler)
- Implementation of the SessionManager method, simply calls the SshClient
method addEventHandler.
- Specified by:
addEventHandler in interface SessionManager
getServerId
public java.lang.String getServerId()
- Implemenation of the SessionManager method, simply calls the SshClient
method getServerId.
- Specified by:
getServerId in interface SessionManager
allowChannelOpen
public void allowChannelOpen(java.lang.String channelType,
com.sshtools.j2ssh.connection.ChannelFactory cf)
throws java.io.IOException
- Implemenation of the SessionManager method, simply calls the SshClient
method allowChannelOpen.
- Specified by:
allowChannelOpen in interface SessionManager
getProfile
public com.sshtools.common.configuration.SshToolsConnectionProfile getProfile()
- Gets the profile currently attached to the frame.
- Specified by:
getProfile in interface SessionManager
JAVADOC | 
SOURCE | 
DOWNLOAD | NESTED | FIELD | CONSTR | METHOD