Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 3.33 KB

README.md

File metadata and controls

80 lines (51 loc) · 3.33 KB
Raw

Gluon Attach

Maven Central Github Actions License: GPL v3

Gluon Attach is the component that addresses the integration with low-level platform APIs in an end-to-end Java Mobile solution.

Attach provides an uniform, platform-independent API to access device and hardware features. At runtime, the appropriate implementation (attach:desktop, attach:android, attach:ios) makes sure the platform specific code is used to deliver the functionality.

Attach is open source, and it is freely licensed under the GPL license. Gluon can provide custom consultancy and training, commercial licenses, and open source commercial support, including daily and monthly releases.

Getting started

The best way to get started with Gluon Attach is using the GluonFX Maven archetype from your IDE and creating a Gluon Mobile project.

The Gluon samples are a good way to find out how Attach is used.

See the documentation on how to add Attach with the GluonFX Plugin.

The JavaDoc contains the reference documentation for the Attach API's.

The list of available services at Attach can be found here.

Building Attach

Gluon Attach is frequently released, and this is only required in case you want to fork and build your local version of Attach.

Requisites

These are the requisites:

  • A recent version of JDK 11
  • Gradle 6.0 or superior.

To build the iOS Services:

  • A Mac with with MacOS X 11 or superior
  • XCode 11.x or superior

How to build and install Attach

To build the Attach services on the project's root, run:

./gradlew clean build

If you want to install them, run:

./gradlew clean publishToMavenLocal

When the process finishes successfully, the different services can be added to a Gluon Mobile project.

For instance, the Display service for desktop can be added to the project like:

<!-- dependencies -->
<dependency>
    <groupId>com.gluonhq.attach</groupId>
    <artifactId>display</artifactId>
    <version>4.0.9-SNAPSHOT</version>
</dependency>

<!-- plugin -->
<configuration>
    <attachList>
        <list>display</list>
    </attachList>
</configuration>

Issues and Contributions

Issues can be reported to the Issue tracker

Contributions can be submitted via Pull requests, providing you have signed the Gluon Individual Contributor License Agreement (CLA).