org.jnetstream.capture
Interface RemoteSession

All Superinterfaces:

Captures.Factory, Captures.LiveCaptureFactory, Captures.RemoteFactory, java.io.Closeable

public interface RemoteSession
extends Captures.RemoteFactory, java.io.Closeable

A remote session which allows remote capture of live packets or capture file manipulation. Use a CaptureServer to create a RemoteSession instance which is connected to the requested remote system. The RemoteSession object implements the Captures which is an abstract factory method for establishing live or file captures and performing operations on files. All these operations are preformed on the remote system transparentely. Notice that Captures is the same interface used to create local captures and manipulate local files, so this is a very powerful abstract which allows exact same functionality but accross the network.

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Nested Class Summary

static interface

RemoteSession.RemoteSessionFactory Remote session handler is an object that is called by the CaptureServer to handle an incomming RemoteSession connection.

Field Summary

Fields inherited from interface org.jnetstream.capture.Captures.LiveCaptureFactory

LIVE_CAPTURE_FACTORY_CLASS_PROPERTY

Method Summary

void	close() Closes the remote session to the remote server.
LiveCaptureDevice[]	listCaptureDevices() Gets a list of capture devices on the remote system.

Methods inherited from interface org.jnetstream.capture.Captures.Factory

append, catFile, catFile, countPackets, formatType, formatType, newFile, newFile, newFile, newFile, openFile, openFile, openFile, openFile, registerListener, removeRegisteredListener, splitFile, splitFile, validateFile

Methods inherited from interface org.jnetstream.capture.Captures.LiveCaptureFactory

newCaptureDevice, openLive, openLive, openLive, openLive, openLive, openLive, openLive, openTransmitter, openTransmitter

Method Detail

listCaptureDevices

LiveCaptureDevice[] listCaptureDevices()
                                       throws java.io.IOException

Gets a list of capture devices on the remote system. The list will contain all available capture devices or network interfaces available on the remote system.

Specified by:

listCaptureDevices in interface Captures.LiveCaptureFactory

Returns:

List of devices, if no devices are available the list will be empty. This method never returns null.

Throws:

java.io.IOException - any IO errors

close

void close()
           throws java.io.IOException

Closes the remote session to the remote server. The session object is no longer valid. Any method invocation on this remote session after the close will throw IllegalStateException. All open capture sessions through this remote session are closed as well.

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException - any IO errors