Adding API support for getting tape drive information as well as tape failure information.

Author: rpmoore

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

@@ -309,6 +309,15 @@ GetTapeLibrariesResponse getTapeLibraries(GetTapeLibrariesRequest request)
     GetTapeLibraryResponse getTapeLibrary(GetTapeLibraryRequest request)
             throws IOException, SignatureException;
 
+    GetTapeDrivesResponse getTapeDrives(GetTapeDrivesRequest request)
+            throws IOException, SignatureException;
+
+    GetTapeDriveResponse getTapeDrive(GetTapeDriveRequest request)
+            throws IOException, SignatureException;
+
+    GetTapeFailureResponse getTapeFailure(GetTapeFailureRequest 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

@@ -265,6 +265,21 @@ public GetTapeLibraryResponse getTapeLibrary(final GetTapeLibraryRequest request
         return new GetTapeLibraryResponse(this.netClient.getResponse(request));
     }
 
+    @Override
+    public GetTapeDrivesResponse getTapeDrives(final GetTapeDrivesRequest request) throws IOException, SignatureException {
+        return new GetTapeDrivesResponse(this.netClient.getResponse(request));
+    }
+
+    @Override
+    public GetTapeDriveResponse getTapeDrive(final GetTapeDriveRequest request) throws IOException, SignatureException {
+        return new GetTapeDriveResponse(this.netClient.getResponse(request));
+    }
+
+    @Override
+    public GetTapeFailureResponse getTapeFailure(final GetTapeFailureRequest request) throws IOException, SignatureException {
+        return new GetTapeFailureResponse(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/GetTapeDriveRequest.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 GetTapeDriveRequest extends AbstractRequest {
+
+    private final UUID id;
+
+    public GetTapeDriveRequest(final UUID id) {
+        this.id = id;
+    }
+
+    @Override
+    public String getPath() {
+        return "/_rest_/tape_drive/" + id.toString();
+    }
+
+    @Override
+    public HttpVerb getVerb() {
+        return HttpVerb.GET;
+    }
+}

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

@@ -0,0 +1,46 @@
+/*
+ * ******************************************************************************
+ *   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.TapeDrive;
+import com.spectralogic.ds3client.networking.WebResponse;
+import com.spectralogic.ds3client.serializer.XmlOutput;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+public class GetTapeDriveResponse extends AbstractResponse {
+
+    private TapeDrive tapeDrive;
+
+    public GetTapeDriveResponse(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.tapeDrive = XmlOutput.fromXml(inputStream, TapeDrive.class);
+            }
+        }
+    }
+
+    public TapeDrive getTapeDrive() {
+        return tapeDrive;
+    }
+}

ds3-sdk/src/main/java/com/spectralogic/ds3client/commands/GetTapeDrivesRequest.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 GetTapeDrivesRequest extends AbstractRequest {
+    @Override
+    public String getPath() {
+        return "/_rest_/tape_drive";
+    }
+
+    @Override
+    public HttpVerb getVerb() {
+        return HttpVerb.GET;
+    }
+}

ds3-sdk/src/main/java/com/spectralogic/ds3client/commands/GetTapeDrivesResponse.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.TapeDrive;
+import com.spectralogic.ds3client.models.tape.TapeDrives;
+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 GetTapeDrivesResponse extends AbstractResponse {
+
+    private List<TapeDrive> tapeDrives;
+
+    public GetTapeDrivesResponse(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.tapeDrives = XmlOutput.fromXml(inputStream, TapeDrives.class).getTapeDrives();
+            }
+        }
+    }
+
+    public List<TapeDrive> getTapeDrives() {
+        return tapeDrives;
+    }
+}

ds3-sdk/src/main/java/com/spectralogic/ds3client/commands/GetTapeFailureRequest.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 GetTapeFailureRequest extends AbstractRequest {
+    @Override
+    public String getPath() {
+        return "/_rest_/tape_failure";
+    }
+
+    @Override
+    public HttpVerb getVerb() {
+        return HttpVerb.GET;
+    }
+}

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

@@ -0,0 +1,46 @@
+/*
+ * ******************************************************************************
+ *   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.TapeFailure;
+import com.spectralogic.ds3client.models.tape.TapeFailures;
+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 GetTapeFailureResponse extends AbstractResponse {
+    private List<TapeFailure> tapeFailures;
+    public GetTapeFailureResponse(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.tapeFailures = XmlOutput.fromXml(inputStream, TapeFailures.class).getTapeFailures();
+            }
+        }
+    }
+
+    public List<TapeFailure> getTapeFailures() {
+        return tapeFailures;
+    }
+}

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

@@ -0,0 +1,116 @@
+/*
+ * ******************************************************************************
+ *   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 TapeDrive {
+    @JsonProperty("ErrorMessage")
+    private String errorMessage;
+    @JsonProperty("ForceTapeRemoval")
+    private boolean forceTapeRemoval;
+    @JsonProperty("Id")
+    private UUID id;
+    @JsonProperty("PartitionId")
+    private UUID partitionId;
+    @JsonProperty("SerialNumber")
+    private String serialNumber;
+    @JsonProperty("State")
+    private State state;
+    @JsonProperty("TapeId")
+    private UUID tapeId;
+    @JsonProperty("Type")
+    private Type type;
+
+    public String getErrorMessage() {
+        return errorMessage;
+    }
+
+    public void setErrorMessage(String errorMessage) {
+        this.errorMessage = errorMessage;
+    }
+
+    public boolean isForceTapeRemoval() {
+        return forceTapeRemoval;
+    }
+
+    public void setForceTapeRemoval(boolean forceTapeRemoval) {
+        this.forceTapeRemoval = forceTapeRemoval;
+    }
+
+    public UUID getId() {
+        return id;
+    }
+
+    public void setId(UUID id) {
+        this.id = id;
+    }
+
+    public UUID getPartitionId() {
+        return partitionId;
+    }
+
+    public void setPartitionId(UUID partitionId) {
+        this.partitionId = partitionId;
+    }
+
+    public String getSerialNumber() {
+        return serialNumber;
+    }
+
+    public void setSerialNumber(String serialNumber) {
+        this.serialNumber = serialNumber;
+    }
+
+    public State getState() {
+        return state;
+    }
+
+    public void setState(State state) {
+        this.state = state;
+    }
+
+    public UUID getTapeId() {
+        return tapeId;
+    }
+
+    public void setTapeId(UUID tapeId) {
+        this.tapeId = tapeId;
+    }
+
+    public Type getType() {
+        return type;
+    }
+
+    public void setType(Type type) {
+        this.type = type;
+    }
+
+    public enum State {
+        NORMAL, OFFLINE, ONLINE_PENDING, ONLINE_IN_PROGRESS, PENDING_INSPECTION, UNKNOWN, DATA_CHECKPOINT_FAILURE,
+        DATA_CHECKPOINT_MISSING, LTFS_WITH_FOREIGN_DATA, FOREIGN, IMPORT_PENDING, IMPORT_IN_PROGRESS, LOST, BAD,
+        SERIAL_NUMBER_MISMATCH, BAR_CODE_MISSING, FORMAT_PENDING, FORMAT_IN_PROGRESS, EJECT_TO_EE_IN_PROGRESS,
+        EJECT_FROM_EE_PENDING, EJECTED
+    }
+
+    public enum Type {
+        UNKNOWN, LTO5, LTO6, LTO_CLEANING_TAPE, TS_JC, TS_JY, TS_JK, TS_JD, TS_JZ, TS_JL, TS_CLEANING_TAPE, FORBIDDEN
+    }
+}