Adding the API calls to get Tape Library information.

Author: rpmoore

ds3-sdk/src/main/java/com/spectralogic/ds3client/Ds3Client.java

@@ -303,6 +303,11 @@ GetSystemHealthResponse getSystemHealth(GetSystemHealthRequest request)
     GetSystemInformationResponse getSystemInformation(GetSystemInformationRequest request)
             throws IOException, SignatureException;
 
+    GetTapeLibrariesResponse getTapeLibraries(GetTapeLibrariesRequest request)
+            throws IOException, SignatureException;
+
+    GetTapeLibraryResponse getTapeLibrary(GetTapeLibraryRequest request)
+            throws IOException, SignatureException;
 
     /**
      * Creates a new Ds3Client instance for the system pointed to by Node.

ds3-sdk/src/main/java/com/spectralogic/ds3client/Ds3ClientImpl.java

@@ -255,6 +255,16 @@ public GetSystemInformationResponse getSystemInformation(final GetSystemInformat
         return new GetSystemInformationResponse(this.netClient.getResponse(request));
     }
 
+    @Override
+    public GetTapeLibrariesResponse getTapeLibraries(final GetTapeLibrariesRequest request) throws IOException, SignatureException {
+        return new GetTapeLibrariesResponse(this.netClient.getResponse(request));
+    }
+
+    @Override
+    public GetTapeLibraryResponse getTapeLibrary(final GetTapeLibraryRequest request) throws IOException, SignatureException {
+        return new GetTapeLibraryResponse(this.netClient.getResponse(request));
+    }
+
     @Override
     public Ds3Client newForNode(final Node node) {
         final ConnectionDetails newConnectionDetails = ConnectionDetailsImpl.newForNode(node, this.getConnectionDetails());

ds3-sdk/src/main/java/com/spectralogic/ds3client/commands/GetTapeLibrariesRequest.java

@@ -0,0 +1,30 @@
+/*
+ * ******************************************************************************
+ *   Copyright 2014-2015 Spectra Logic Corporation. 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. A copy of the License is located at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   or in the "license" file accompanying this file.
+ *   This file 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 and limitations under the License.
+ * ****************************************************************************
+ */
+
+package com.spectralogic.ds3client.commands;
+
+import com.spectralogic.ds3client.HttpVerb;
+
+public class GetTapeLibrariesRequest extends AbstractRequest {
+    @Override
+    public String getPath() {
+        return "/_rest_/tape_library";
+    }
+
+    @Override
+    public HttpVerb getVerb() {
+        return HttpVerb.GET;
+    }
+}

ds3-sdk/src/main/java/com/spectralogic/ds3client/commands/GetTapeLibrariesResponse.java

@@ -0,0 +1,48 @@
+/*
+ * ******************************************************************************
+ *   Copyright 2014-2015 Spectra Logic Corporation. 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. A copy of the License is located at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   or in the "license" file accompanying this file.
+ *   This file 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 and limitations under the License.
+ * ****************************************************************************
+ */
+
+package com.spectralogic.ds3client.commands;
+
+import com.spectralogic.ds3client.models.tape.TapeLibraries;
+import com.spectralogic.ds3client.models.tape.TapeLibrary;
+import com.spectralogic.ds3client.networking.WebResponse;
+import com.spectralogic.ds3client.serializer.XmlOutput;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.List;
+
+public class GetTapeLibrariesResponse extends AbstractResponse{
+
+    private List<TapeLibrary> tapeLibraries;
+
+    public GetTapeLibrariesResponse(final WebResponse response) throws IOException {
+        super(response);
+    }
+
+    @Override
+    protected void processResponse() throws IOException {
+        try (final WebResponse response = getResponse()) {
+            this.checkStatusCode(200);
+            try (final InputStream inputStream = response.getResponseStream()) {
+                this.tapeLibraries = XmlOutput.fromXml(inputStream, TapeLibraries.class).getTapeLibraries();
+            }
+        }
+    }
+
+    public List<TapeLibrary> getTapeLibraries() {
+        return tapeLibraries;
+    }
+}

ds3-sdk/src/main/java/com/spectralogic/ds3client/commands/GetTapeLibraryRequest.java

@@ -0,0 +1,39 @@
+/*
+ * ******************************************************************************
+ *   Copyright 2014-2015 Spectra Logic Corporation. 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. A copy of the License is located at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   or in the "license" file accompanying this file.
+ *   This file 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 and limitations under the License.
+ * ****************************************************************************
+ */
+
+package com.spectralogic.ds3client.commands;
+
+import com.spectralogic.ds3client.HttpVerb;
+
+import java.util.UUID;
+
+public class GetTapeLibraryRequest extends AbstractRequest {
+
+    private final UUID id;
+
+    public GetTapeLibraryRequest(final UUID id) {
+        this.id = id;
+    }
+
+    @Override
+    public String getPath() {
+        return "/_rest_/tape_library/" + id.toString();
+    }
+
+    @Override
+    public HttpVerb getVerb() {
+        return HttpVerb.GET;
+    }
+}

ds3-sdk/src/main/java/com/spectralogic/ds3client/commands/GetTapeLibraryResponse.java

@@ -0,0 +1,45 @@
+/*
+ * ******************************************************************************
+ *   Copyright 2014-2015 Spectra Logic Corporation. 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. A copy of the License is located at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   or in the "license" file accompanying this file.
+ *   This file 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 and limitations under the License.
+ * ****************************************************************************
+ */
+
+package com.spectralogic.ds3client.commands;
+
+import com.spectralogic.ds3client.models.tape.TapeLibrary;
+import com.spectralogic.ds3client.networking.WebResponse;
+import com.spectralogic.ds3client.serializer.XmlOutput;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+public class GetTapeLibraryResponse extends AbstractResponse {
+    private TapeLibrary tapeLibrary;
+    public GetTapeLibraryResponse(final WebResponse response) throws IOException {
+        super(response);
+    }
+
+    @Override
+    protected void processResponse() throws IOException {
+        try (final WebResponse response = getResponse()) {
+            this.checkStatusCode(200);
+            try (final InputStream inputStream = response.getResponseStream()) {
+                this.tapeLibrary = XmlOutput.fromXml(inputStream, TapeLibrary.class);
+            }
+        }
+
+    }
+
+    public TapeLibrary getTapeLibrary() {
+        return tapeLibrary;
+    }
+}

ds3-sdk/src/main/java/com/spectralogic/ds3client/models/tape/TapeLibraries.java

@@ -0,0 +1,36 @@
+/*
+ * ******************************************************************************
+ *   Copyright 2014-2015 Spectra Logic Corporation. 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. A copy of the License is located at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   or in the "license" file accompanying this file.
+ *   This file 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 and limitations under the License.
+ * ****************************************************************************
+ */
+
+package com.spectralogic.ds3client.models.tape;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
+
+import java.util.List;
+
+@JacksonXmlRootElement(namespace = "Data")
+public class TapeLibraries {
+    @JsonProperty("TapeLibrary")
+    private List<TapeLibrary> tapeLibraries;
+
+    public List<TapeLibrary> getTapeLibraries() {
+        return tapeLibraries;
+    }
+
+    public void setTapeLibraries(List<TapeLibrary> tapeLibraries) {
+        this.tapeLibraries = tapeLibraries;
+    }
+
+}

ds3-sdk/src/main/java/com/spectralogic/ds3client/models/tape/TapeLibrary.java

@@ -0,0 +1,66 @@
+/*
+ * ******************************************************************************
+ *   Copyright 2014-2015 Spectra Logic Corporation. 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. A copy of the License is located at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   or in the "license" file accompanying this file.
+ *   This file 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 and limitations under the License.
+ * ****************************************************************************
+ */
+
+package com.spectralogic.ds3client.models.tape;
+
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
+
+import java.util.UUID;
+
+@JacksonXmlRootElement(namespace = "Data")
+public class TapeLibrary {
+    @JsonProperty("Id")
+    private UUID id;
+    @JsonProperty("ManagementUrl")
+    private String managementUrl;
+    @JsonProperty("Name")
+    private String name;
+    @JsonProperty("SerialNumber")
+    private String serialNumber;
+
+    public UUID getId() {
+        return id;
+    }
+
+    public void setId(UUID id) {
+        this.id = id;
+    }
+
+    public String getManagementUrl() {
+        return managementUrl;
+    }
+
+    public void setManagementUrl(String managementUrl) {
+        this.managementUrl = managementUrl;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getSerialNumber() {
+        return serialNumber;
+    }
+
+    public void setSerialNumber(String serialNumber) {
+        this.serialNumber = serialNumber;
+    }
+}

ds3-sdk/src/test/java/com/spectralogic/ds3client/Ds3Client_Test.java

@@ -22,6 +22,7 @@
 import com.spectralogic.ds3client.models.*;
 import com.spectralogic.ds3client.models.bulk.*;
 import com.spectralogic.ds3client.models.bulk.Objects;
+import com.spectralogic.ds3client.models.tape.TapeLibrary;
 import com.spectralogic.ds3client.networking.FailedRequestException;
 import com.spectralogic.ds3client.serializer.XmlProcessingException;
 import com.spectralogic.ds3client.utils.ByteArraySeekableByteChannel;
@@ -705,4 +706,35 @@ public void systemInformation() throws IOException, SignatureException {
 
         assertThat(response.getSystemInformation(), is(notNullValue()));
     }
+
+    @Test
+    public void getTapeLibraries() throws IOException, SignatureException {
+        final String responsePayload = "<Data><TapeLibrary><Id>f4dae25d-e52a-4430-82bd-525e4f15493c</Id><ManagementUrl>a</ManagementUrl><Name>test library</Name><SerialNumber>test library</SerialNumber></TapeLibrary><TapeLibrary><Id>82bdab72-d79a-4b43-95d7-f2c16cd9aa45</Id><ManagementUrl>a</ManagementUrl><Name>test library 2</Name><SerialNumber>test library 2</SerialNumber></TapeLibrary></Data>";
+
+        final GetTapeLibrariesResponse response = MockNetwork
+                .expecting(HttpVerb.GET, "/_rest_/tape_library", null, null)
+                .returning(200, responsePayload)
+                .asClient()
+                .getTapeLibraries(new GetTapeLibrariesRequest());
+
+        final List<TapeLibrary> libraries = response.getTapeLibraries();
+
+        assertThat(libraries.size(), is(2));
+        assertThat(libraries.get(0).getId().toString(), is("f4dae25d-e52a-4430-82bd-525e4f15493c"));
+    }
+
+    @Test
+    public void getTapeLibrary() throws IOException, SignatureException {
+        final String responsePayload = "<Data><Id>e23030e5-9b8d-4594-bdd1-15d3c45abb9f</Id><ManagementUrl>a</ManagementUrl><Name>125ca16e-60e3-43b2-a26f-0bc81843745f</Name><SerialNumber>test library</SerialNumber></Data>";
+
+        final GetTapeLibraryResponse response = MockNetwork
+                .expecting(HttpVerb.GET, "/_rest_/tape_library/e23030e5-9b8d-4594-bdd1-15d3c45abb9f", null, null)
+                .returning(200, responsePayload)
+                .asClient()
+                .getTapeLibrary(new GetTapeLibraryRequest(UUID.fromString("e23030e5-9b8d-4594-bdd1-15d3c45abb9f")));
+
+        assertThat(response.getTapeLibrary(), is(notNullValue()));
+        assertThat(response.getTapeLibrary().getId().toString(), is("e23030e5-9b8d-4594-bdd1-15d3c45abb9f"));
+
+    }
 }