microsoft/java-client-library

Java Client Library for DeployR

Java Client Library for DeployR

The DeployR API exposes a wide range of R analytics services to client application developers. These services are exposed using standards based JSON/XML and are delivered by the DeployR server as Web services over HTTP(S).

The DeployR Java client library is provided to simplify the integration of DeployR services within Java client applications.

Links

• Download
• Quick Start Tutorial
• Client Library API JavaDoc
• DeployR API Reference Guide
• Library Dependencies
• Example Code
• License

Dependencies

Declarative JAR Dependencies: Maven Central Repository Artifacts

Artifacts for each official release (since 7.3.0) of the DeployR Java client library are published to the Maven Central repository.

ArtifactId: jDeployR

Using build frameworks such as Maven and Gradle your Java client application can simply declare a dependency on the appropriate version of the jDeployR artifact to ensure all required JAR dependencies are resolved and available at runtime.

Bundled JAR Dependencies

If you are not defining your DeployR client library JAR dependencies using declarative tools then you must ensure the required JAR files are placed directly on your application CLASSPATH.

Besides the DeployR Java client library JAR itself, jDeployR-<version>.jar, there are a number of 3rd party JAR file dependencies. These additional JAR file dependencies are provided for your convenience in the lib directory within this repository.

Building the Java Client Library

A Gradle build script is provided to build the DeployR Java client library:

build.gradle

By default, the build will generate a version of the jDeployR-<version>.jar file in the build/libs directory.

You do not need to install Gradle before running these commands. To build the DeployR Java client library a Unix based OS, run the following shell script:

gradlew build

To build the DeployR Java client library on a Windows based OS, run the following batch file:

gradlew.bat build

Examples

The DeployR Java client library ships with a number of sample applications provided to demonstrate some of the key featues introduced by the Quick Start Tutorial for the Java client library. See here for details.

The DeployR Java client library also ships with a set of unit tests. See here for details.

License

Copyright (C) 2010-2016, Microsoft Corporation

This program is licensed to you under the terms of Version 2.0 of the Apache License. This program is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0) for more details.

java-client-library's Issues

Update attach package tests

Update attach package tests to accommodate server logic changes of not automatically installing R packages when library("pkg") returns FALSE.

Hardcoded passwords for tests/examples

Remove hardcoded passwords for tests/examples.

RStringVector I/O of `NULL` values should be consistent with R vectors

When we pass a RStringVector from the client with all NULL values we get incorrect and inconsistent results:

1. R console output produces boolean/logical True - incorrect
2. Return type in the calling client is RDataNA which is not a vector with NULL values - incorrect

Results should be consistent with R, for example:

> x <- c(NULL, NULL, NULL, NULL)
> x
NULL

> y <- c(NULL, NULL, "foo", NULL)
> y
[1] "foo"

Reproduce:

List<String> v = new ArrayList<String>();
v.add(null);
v.add(null);
v.add(null);
v.add(null);
RDataFactory.createStringVector("x", v);

List<String> v = new ArrayList<String>();
v.add(null);
v.add(null);
v.add("foo");
v.add(null);
RDataFactory.createStringVector("y", v);

View response. It should be consistent with R vectors.

The library doesn't work if SSL is used with a properly signed certificate.

If I use https then I get a scheme is not registered error because the only way to add https as a permitted scheme is through use of a self-signed certificate. It would be better if there was an option that allowed the use of https (and then trusted a self-signed certificate if one was present).

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request