alsutton/enterprisepasswordsafe

/*
 * Copyright (c) 2017 Carbon Security Ltd. <opensource@carbonsecurity.co.uk>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.enterprisepasswordsafe.database.schema;

import java.sql.SQLException;

public final class HierarchyGroupAccessControlTable
    extends AbstractTable {

    /**
     * The name of this table
     */

    private static final String TABLE_NAME = "hierarchy_group_access_control";

    /**
     * The column information
     */

    private static final ColumnSpecification NODE_ID_COLUMN = new ColumnSpecification("node_id", ColumnSpecification.TYPE_ID, false, true);
    private static final ColumnSpecification GROUP_ID_COLUMN = new ColumnSpecification("group_id", ColumnSpecification.TYPE_ID);
    private static final ColumnSpecification SETTING_COLUMN = new ColumnSpecification("setting", ColumnSpecification.TYPE_BLOB);

    private static final ColumnSpecification[] COLUMNS = {
        NODE_ID_COLUMN, GROUP_ID_COLUMN, SETTING_COLUMN
    };

    /**
     * The index information
     */

    private static final ColumnSpecification[] COMBINED_ID_INDEX_COLUMNS = { NODE_ID_COLUMN, GROUP_ID_COLUMN };
    private static final IndexSpecification COMBINED_ID_INDEX = new IndexSpecification("hgc_nidgid", TABLE_NAME, COMBINED_ID_INDEX_COLUMNS);

    private static final IndexSpecification ID_INDEX = new IndexSpecification("hgc_nid", TABLE_NAME, NODE_ID_COLUMN);

    private static final IndexSpecification[] INDEXES = {
        COMBINED_ID_INDEX, ID_INDEX
    };

    /**
     * Get the name of this table
     */

    @Override
    public String getTableName() {
        return TABLE_NAME;
    }

    /**
     * Get all of the columns in the table
     */

    @Override
    ColumnSpecification[] getAllColumns() {
        return COLUMNS;
    }

    /**
     * Get all of the indexes in the table
     */

    @Override
    IndexSpecification[] getAllIndexes() {
        return INDEXES;
    }

    /**
     * Update the current schema to the latest version
     */

    @Override
    public void updateSchema(final long schemaID)
        throws SQLException {
        if(schemaID < SchemaVersion.SCHEMA_201112) {
            createTableIfNotPresent(NODE_ID_COLUMN);
        }
    }

    /**
     * Gets an instance of this table schema
     */

    static HierarchyGroupAccessControlTable getInstance() {
        return new HierarchyGroupAccessControlTable();
    }
}