org.elasticsearch:jna

Java Native Access (JNA)

The definitive JNA reference (including an overview and usage details) is in the JavaDoc. Please read the overview. Questions, comments, or exploratory conversations should begin on the mailing list, although you may find it easier to find answers to already-solved problems on StackOverflow.

JNA provides Java programs easy access to native shared libraries without writing anything but Java code - no JNI or native code is required. This functionality is comparable to Windows' Platform/Invoke and Python's ctypes.

JNA allows you to call directly into native functions using natural Java method invocation. The Java call looks just like the call does in native code. Most calls require no special handling or configuration; no boilerplate or generated code is required.

JNA uses a small JNI library stub to dynamically invoke native code. The developer uses a Java interface to describe functions and structures in the target native library. This makes it quite easy to take advantage of native platform features without incurring the high overhead of configuring and building JNI code for multiple platforms. Read this more in-depth description.

While significant attention has been paid to performance, correctness and ease of use take priority.

In addition, JNA includes a platform library with many native functions already mapped as well as a set of utility interfaces that simplify native access.

Projects Using JNA

JNA is a mature library with dozens of contributors and hundreds of commercial and non-commercial projects that use it. If you're using JNA, feel free to tell us about it. Include some details about your company, project name, purpose and size and tell us how you use the library.

• Apache Cassandra: Large-scale NoSQL data store.
• Rococoa: Java bindings to the Mac OS X Cocoa framework, by Duncan McGregor.
• jna-posix: Common POSIX Functions for Java.
• JNAerator: Pronounced "generator", auto-generates JNA mappings from C headers, by Olivier Chafik.
• Freedom for Media in Java by Ken Larson/Dieter Krachtus.
• GStreamer-Java: Java bindings and utilities for GStreamer 1.x.
• VLCJ: Java bindings for libVLC.
• SVNKit: Pure Java Subversion client library.
• OmegaT Computer-Aided Translation.
• IntelliJ IDEA by JetBrains.
• Jetbrains Toolbox by JetBrains.
• Apache NetBeans IDE by Apache Software Foundation.
• FileBot Media Renamer by Reinhard Pointner.
• USB for Java by Mario Boikov.
• Waffle: Enables SSO on Windows in Java applications, by Daniel Doubrovkine.
• leveldb-jna: Cross-platform JNA based adapter for LevelDB.
• bolt-jna: Cross-platform JNA based adapter for Bolt. It is to show how to use JNA for binding to Go library.
• JVM OpenVR Bindings.
• Apache Ignite: Direct IO plugin
• Domino JNA: Cross-platform access to HCL Notes/Domino C API methods from Java
• OSHI: Cross-platform Operating System and Hardware Information library for Java
• jAlbum: Desktop based web gallery software for any web site.
• jacknji11: Provides a Java PKCS#11 interface.
• JNAJack: Java bindings for JACK Audio Connection Kit.
• Elasticsearch: Large-scale distributed search and analytics engine.
• Aki: Automated Testing on desktop

Interesting Investigations/Experiments

• Drive Lego Mindstorm NXT by Emmanuel Pirsch.
• Detect User Inactivity by Olivier Chafik.

There are also a number of examples and projects within the contrib directory of the JNA project itself.

Supported Platforms

JNA will build on most linux-like platforms with a reasonable set of GNU tools and a JDK. See the native Makefile for native configurations that have been built and tested. If your platform is supported by libffi, then chances are you can build JNA for it.

Pre-built platform support may be found here.

Download

Version 5.15.0

JNA

 jna-5.15.0.jar jna-jpms-5.15.0.jar

This is the core artifact of JNA and contains only the binding library and the core helper classes.

JNA Platform

 jna-platform-5.15.0.jar jna-platform-jpms-5.15.0.jar

This artifact holds cross-platform mappings and mappings for a number of commonly used platform functions, including a large number of Win32 mappings as well as a set of utility classes that simplify native access. The code is tested and the utility interfaces ensure that native memory management is taken care of correctly.

See PlatformLibrary.md for details.

Features

• Automatic mapping from Java to native functions, with simple mappings for all primitive data types
• Runs on most platforms which support Java
• Automatic conversion between C and Java strings, with customizable encoding/decoding
• Structure and Union arguments/return values, by reference and by value
• Function Pointers, (callbacks from native code to Java) as arguments and/or members of a struct
• Auto-generated Java proxies for native function pointers
• By-reference (pointer-to-type) arguments
• Java array and NIO Buffer arguments (primitive types and pointers) as pointer-to-buffer
• Nested structures and arrays
• Wide (wchar_t-based) strings
• Native long support (32- or 64-bit as appropriate)
• Demo applications/examples
• Supported on 1.4 or later JVMs, including JavaME (earlier VMs may work with stubbed NIO support)
• Customizable marshalling/unmarshalling (argument and return value conversions)
• Customizable mapping from Java method to native function name, and customizable invocation to simulate C preprocessor function macros
• Support for automatic Windows ASCII/UNICODE function mappings
• Varargs support
• Type-safety for native pointers
• VM crash protection (optional)
• Optimized direct mapping for high-performance applications.
• COM support for early and late binding.
• COM/Typelib java code generator.

Community and Support

All questions should be posted to the jna-users Google group. Issues can be submitted here on Github.

When posting to the mailing list, please include the following:

• What OS/CPU/architecture you're using (e.g. Windows 7 64-bit)
• Reference to your native interface definitions (i.e. C headers), if available
• The JNA mapping you're trying to use
• VM crash logs, if any
• Example native usage, and your attempted Java usage

It's nearly impossible to indicate proper Java usage when there's no native reference to work from.

For commercial support, please contact twalljava [at] java [dot] net.

Using the Library

• Getting Started
• Functional Description.
• Mapping between Java and Native
• Using Pointers and Arrays
• Using Structures and Unions
• Using By-Reference Arguments
• Customization of Type Mapping
• Callbacks/Function Pointers/Closures
• Dynamically Typed Languages (JRuby/Jython)
• Platform Library
• Direct Method Mapping (Optimization)
• Frequently Asked Questions (FAQ)
• Avoiding Crashes

Primary Documentation (JavaDoc)

The definitive JNA reference is in the JavaDoc.

Developers

• Contributing to JNA
• Setting up a Windows Development Environment
• Setting up an Android Development Environment
• Setting up a RaspberryPi Development Environment
• Setting up a Mac Development Environment
• Releasing JNA
• Publishing to Maven Central

Contributing

You're encouraged to contribute to JNA. Fork the code from https://github.com/java-native-access/jna and submit pull requests.

For more information on setting up a development environment see Contributing to JNA.

If you are interested in paid support, feel free to say so on the jna-users mailing list. Most simple questions will be answered on the list, but more complicated work, new features or target platforms can be negotiated with any of the JNA developers (this is how several of JNA's features came into being). You may even encounter other users with the same need and be able to cost share the new development.

License

This library is licensed under the LGPL, version 2.1 or later, or (from version 4.0 onward) the Apache License, version 2.0. Commercial support may be available, please e-mail twall[at]users[dot]sf[dot]net. See LICENSE for more information.

NOTE: Oracle is not sponsoring this project, even though the package name (com.sun.jna) might imply otherwise.