SolidFire Java SDK <img src="https://raw.githubusercontent.com/solidfire/solidfire-sdk-java/gh-pages/Java-SDK-Icon-RGB-02.png"" height="50" width="50" >

SolidFire Management API as a Java SDK

##Description The SolidFire Java SDK is a collection of software modules and libraries that facilitate integration and orchestration between proprietary systems and third-party applications. The Java SDK allows developers to deeply integrate SolidFire system API with the Java programming language. The SolidFire Java SDK reduces the amount of additional coding time required for integration.

##Compatibility

Component	Version
Java	7.0 & 8.0
SolidFire OS	Element 7.x & 8.x

##Getting Help Contacting SolidFire SDK Support If you have any questions or comments about this product, contact sdk@solidfire.com or reach out to the developer community at developer.solidfire.com. Your feedback helps us focus our efforts on new features and capabilities.

##Download Download the latest JAR or grab via Maven:

<dependency>
  <groupId>com.solidfire</groupId>
  <artifactId>element-api</artifactId>
  <version>1.0.0.53</version>
</dependency>

or SBT:

libraryDependencies += "com.solidfire" % "element-api" % "1.0.0.53"

or Gradle:

compile 'com.solidfire:element-api:1.0.0.53'

##Assembly Jar The SolidFire Java SDK is also released as a Signed Assembly containing everything you need to quickly spin up a working client to interact with you SolidFire cluster. The assembly can be downloaded here.

Dependencies:

Component	Version
base64	2.3.8
gson	2.3
joda-time	2.4
joda-convert	1.2
slf4j-api	1.7.7
logback-core	1.1.3
logback-classic	1.1.3

Note: The SDK assembly should only be used in a standalone setting such as scripting or for prototyping. It should not be used in a production environment as the signed components might conflict with other components that are unsigned or signed with another certificate. See below.

###Limitations with a Certificate Signed Assembly Jar The SDK assembly is signed with a certificate controlled by SolidFire, Inc, assuring the archive is official and legitimate. One caveat to having a set of components also signed with SolidFire's certificate, is no other version of these components can exist on the classpath. This will cause a security exception in the JVM.

If using the SDK with a restricted version of the above listed components, e.g. logback, or in developing an enterprise solution that runs in a web application container, etc., use the publicly hosted versions of the SDK.

##Documentation

Latest JavaDoc

1.0.0.53 JavaDoc

##Examples ###Examples of using the API (Java)

import com.solidfire.javautil.Optional;

// Import Optional common empty types (String, Long, & Map)
import static com.solidfire.javautil.Optional.*;

public class ReadmeJavaExample {
  public static void main(String[] args ) {
    // Create Connection to SF Cluster
    SolidFireElementIF sf = SolidFireElement.create("mvip", "8.0", "username", "password");

    // Create some accounts
    AddAccountRequest addAccountRequest = new AddAccountRequest("username", EMPTY_STRING, 
                                                                EMPTY_STRING, EMPTY_MAP);
    Long accountId = sf.addAccount(addAccountRequest).getAccountID();

    // And a volume with default QoS
    CreateVolumeRequest createVolumeRequest = new CreateVolumeRequest("volumeName", accountId, 
                                                                      1000000000l, false, 
                                                                      Optional.<QoS>empty(), 
                                                                      EMPTY_MAP);
    Long volumeId = sf.createVolume(createVolumeRequest).getVolumeID();

    // Lookup iqn for new volume
    String iqn = sf.listVolumesForAccount(accountId, of(volumeId), of(1l)).getVolumes()[0].getIqn();

    // Change Min and Burst QoS while keeping Max and Burst Time the same
    QoS qos = new QoS(of(5000l), EMPTY_LONG, of(30000l), EMPTY_LONG);

    // Modify the volume size and QoS
    ModifyVolumeRequest modifyVolumeRequest = new ModifyVolumeRequest(volumeId, EMPTY_LONG, 
                                                                      EMPTY_STRING, EMPTY_STRING, 
                                                                      of(qos), of(2000000000l),
                                                                      EMPTY_MAP);
    sf.modifyVolume(modifyVolumeRequest);
  }
}

###Examples of using the API (Scala)

// Import your Java Primitive Types
import java.lang.Long

import com.solidfire.javautil.Optional.{empty, of}

class ReadmeExample {

  // Create Connection to SF Cluster
  val sf = SolidFireElement.create("mvip", "8.0", "username", "password")

  // Create some accounts
  val addAccount = new AddAccountRequest("username", empty[String], empty[String], empty())
  val accountId = sf.addAccount(addAccount).getAccountID

  // And a volume
  val createVolume = new CreateVolumeRequest("volumeName", accountId, 1000000000l, false, empty[QoS], empty())
  val volumeId = sf.createVolume(createVolume).getVolumeID

  // Lookup iqn for new volume
  val iqn: String = sf.listVolumesForAccount(accountId, of(volumeId), of(1l)).getVolumes()(0).getIqn

  // Change Min and Burst QoS while keeping Max and Burst Time the same
  val qos: QoS = new QoS(of(5000l), empty[Long], of(30000l), empty[Long])

  // Modify the volume
  val modifyVolume = new ModifyVolumeRequest(volumeId, empty[Long], empty[String], empty[String], 
                                             of(qos), of( 2000000000l ), empty())
  sf.modifyVolume(modifyVolume)
}

##Logback The SDK and the Assembly leverage the SLF4J API for logging with the logback-classic implementation. An advantage to using the SLF4J interface is the avaialabitly of legacy logging framework bridges, for intecepting and consolidating all logging calls into a single log. ###Tracing Request / Response calls in the log An example logback.xml:

<configuration debug="true">

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoders are assigned the type
             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <logger name="com.solidfire.element.api.SolidFireElement" level="DEBUG" />

    <root level="INFO">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

##Roadmap

Version	Release Date	Notes
1.0	November 20, 2015	Accounts, Volumes, Access Groups, Snapshots, and Group Snapshots
1.1	TBD	Complete Nitorgen & Oxygen API Coverage
1.2	TBD	Fluorine API Coverage
1.3	TBD	Neon API Coverage

##License Copyright © 2015 SolidFire, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions andlimitations under the License.