CaseNodeData.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2017 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * 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 and
 * limitations under the License.
 */
package org.sleuthkit.autopsy.coordinationservice;

import java.nio.BufferUnderflowException;
import java.nio.ByteBuffer;

public final class CaseNodeData {

    private static final int CURRENT_VERSION = 0;
    
    private int version;
    private boolean errorsOccurred;

    public static int getCurrentVersion() {
        return CaseNodeData.CURRENT_VERSION;
    }
    
    public CaseNodeData(byte[] nodeData) throws InvalidDataException {
        if(nodeData == null || nodeData.length == 0) {
            this.version = CURRENT_VERSION;
            this.errorsOccurred = false;
        } else {
            /*
             * Get fields from node data.
             */
            ByteBuffer buffer = ByteBuffer.wrap(nodeData);
            try {
                if (buffer.hasRemaining()) {
                    this.version = buffer.getInt();

                    /*
                     * Flags bit format: 76543210
                     * 0-6 --> reserved for future use
                     * 7 --> errorsOccurred
                     */
                    byte flags = buffer.get();
                    this.errorsOccurred = (flags < 0);
                }
            } catch (BufferUnderflowException ex) {
                throw new InvalidDataException("Node data is incomplete", ex);
            }
        }
    }

    public boolean getErrorsOccurred() {
        return this.errorsOccurred;
    }

    public void setErrorsOccurred(boolean errorsOccurred) {
        this.errorsOccurred = errorsOccurred;
    }

    public int getVersion() {
        return this.version;
    }
    
    public byte[] toArray() {
        ByteBuffer buffer = ByteBuffer.allocate(5);
        
        buffer.putInt(this.version);
        buffer.put((byte)(this.errorsOccurred ? 0x80 : 0));
        
        // Prepare the array
        byte[] array = new byte[buffer.position()];
        buffer.rewind();
        buffer.get(array, 0, array.length);

        return array;
    }

    public final static class InvalidDataException extends Exception {

        private static final long serialVersionUID = 1L;

        private InvalidDataException(String message) {
            super(message);
        }

        private InvalidDataException(String message, Throwable cause) {
            super(message, cause);
        }
    }
}