Installation and Environment

Inside this section:


Downloading packages [Top]

jNetStream has a number of ready to install packages that you download from SourceForge.net download servers. The link below will take you to the download area:

Download



Note!
If you are looking for the new API ver 3.0, it has not been fully released in binary form.
You need to compile from source at this time.
See section below for installation from source. Or check lastest status.

If you are looking for source, you will need to follow the section titled "Installation Instructions - Source installation" below.


Installation Instructions - Source installation [Top]

The source for jNetStream is stored on SourceForge.net in a SVN repository. There are 3 main modules that make up the entire jNetStream project.

  • CommonUtils - all the common utility stuff that jNetStream shares with other projects
  • jNetStreamAPI - pure API module. The module is a standalone project that is made up of mostly interfaces and just a few classes. Will compile, but can not be run as there is no implementing classes in this module
  • jNetStreamImplementation - implementation of the jNetStreamAPI package. This module contains all the classes that implement the interfaces and factories defined in the API module.

You will need an SVN client on your workstation to download the source. Most modern IDE's have builtin support for SVN repositories. SVN is very similar to CVS, but allows for better code management.

Here are step by step instructions for downloading and configuring source modules.

Step 1 - install CommonUtils module [Top]

Download and configure "CommonUtils" module. The svn URL is as follows to download the source:

https://jnetstream.svn.sourceforge.net/svnroot/jnetstream/CommonUtils/trunk

The module contains a "lib" directory which conaints some prerequisite component jar files. All these jar files need to be added to the classpath. Once you add the prerequisites, then the module should compile without any warnings.

Step 2 - install jNetStreamAPI module [Top]

Download and configure "jNetStreamAPI" module. The svn URL is as follows to download the source:

https://jnetstream.svn.sourceforge.net/svnroot/jnetstream/jNetStreamAPI/...

The module contains a "lib" directory which conaints some prerequisite component jar files. All these jar files need to be added to the classpath. Once you add the prerequisites, then the module should compile without any warnings. This module is also dependent on the "CommonUtils" module, described above. So both modules classpaths should be merged with all of their common prerequisite jar files in their respective lib directories only included once.

Step 3 - install jNetStreamImplementation module [Top]

Download and configure "jNetStreamImplementation" module. The svn URL is as follows to download the source:

https://jnetstream.svn.sourceforge.net/svnroot/jnetstream/jNetStreamImpl...

The module contains a "lib" directory which conaints some prerequisite component jar files. All these jar files need to be added to the classpath. Once you add the prerequisites, then the module should compile without any warnings. This module is also dependent on the "CommonUtils" and "jNetStreamAPI" modules, described above. So all modules classpaths should be merged with all of their common prerequisite jar files in their respective lib directories only included once.

In addition to jar files, the "jNetStreamImpl" module requires some native libraries, i.e. DLLs, which also reside in 2 different sub-directories of lib (1 for each of the 2 different jPcap libraries included). These can not simply be added to the classpath, but need to be defined to the java VM on the command line during invokation using the following options "-Djava.library.path=lib". Here is an example which invokes some imaginary application with the appropriate commandline arguments:

Shell> java "-Djava.library.path=lib/SFjPcap;lib/KFjPcap" MyApplication

Native libraries are needed in order to invoke packet capture on live network interfaces. Also they are needed for filtering and other reasons.

Step 4 - Test the installation - run the main jUnit test suite [Top]

The last thing to do is to make sure that everything runs smoothly. There is a master jUnit test suite which you can run that will verify that all portions of jNetStream installation are running correctly. This will test the environment and if all the prerequisites have been installed correctly.

(Note: Currently jNetStream does not have an ant script in its source form. It will for final binary distribution)

The class path of the master jUnit test suite is:

com.slytechs.jnetstream.tests.AllTestsjNetStream

Installation Instructions - OS specific binary [Top]

[Under Construction]

Installation directory structure [Top]

[Under Construction]