# (C) 2015 Clemson University
# See COPYING in top-level directory.
===============================================================================
Brief Documentation - OrangeFS JNI and Hadoop Client

  Exposing OrangeFS Direct Client User Interface Calls to Java Developers 
  through JNI.

===============================================================================
Step 1: 

  JNI Instructions:

    ./configure --prefix=/opt/orangefs --enable-shared \
            --enable-jni --with-jdk=<path_to_jdk>
    make
    sudo make install

  For comprehensive documentation on using Hadoop with OrangeFS, please visit docs.orangefs.com/.

===============================================================================
Step 2:

  *Note: The environment variable LD_LIBRARY_PATH and JNI_LIBRARY_PATH should 
    contain the path of your JNI libraries and other required library paths. 

  ex:     
    export LD_LIBRARY_PATH=/opt/orangefs/lib
    export JNI_LIBRARY_PATH=/opt/orangefs/lib

===============================================================================
Step 3:

  Use the .jar files in your Java applications. Be sure to include the full
    path names of the .jar files needed by passing the -cp option to javac
    and java.

  example file Main.java:

    import org.orangefs.usrint.*;

    public class Main
    {
        public static final void main(String args[])
        {
            Orange fs = Orange.getInstance();
            fs.posix.mkdir("/mnt/orangefs/test", fs.posix.f.S_IRWXU);
        }
    }

  example of building and running Main.java:

    javac -cp ".:/opt/orangefs/lib/orangefs-jni-VERSION.jar" Main.java
    java -cp ".:/opt/orangefs/lib/orangefs-jni-VERSION.jar" Main

  Where 'VERSION' is the 3 digit OrangeFS release version in the format 'x.x.x'.
