com.microsoft.sqlserver.jdbc.dataclassification.SensitivityClassification Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mssql-jdbc Show documentation
Microsoft JDBC Driver for SQL Server.
There is a newer version: 12.7.0.jre11-preview
/*
 * Microsoft JDBC Driver for SQL Server Copyright(c) Microsoft Corporation All rights reserved. This program is made
 * available under the terms of the MIT License. See the LICENSE file in the project root for more information.
 */

package com.microsoft.sqlserver.jdbc.dataclassification;

import java.util.ArrayList;
import java.util.List;

import com.microsoft.sqlserver.jdbc.SQLServerException;


/**
 * Provides the functionality to retrieve Sensitivity Classification data as received from SQL Server for the active
 * resultSet
 */
public class SensitivityClassification {

    /**
     * Sensitivity Rank
     * 
     * https://docs.microsoft.com/sql/relational-databases/system-catalog-views/sys-sensitivity-classifications-transact-sql
     *
     */
    public enum SensitivityRank {
        /**
         * rank not defined
         */
        NOT_DEFINED(-1),
        
        /**
         * rank NONE
         */
        NONE(0),
        
        /**
         * rank LOW
         */
        LOW(10),
        
        /**
         * rank MEDIUM
         */
        MEDIUM(20),
        
        /**
         * rank HIGH
         */
        HIGH(30),
        
        /**
         * rank CRITICAL
         */
        CRITICAL(40);

        private static final SensitivityRank[] VALUES = values();
        private int rank;

        private SensitivityRank(int rank) {
            this.rank = rank;
        }

        /**
         * Get rank value
         * 
         * @return rank
         */
        public int getValue() {
            return rank;
        }

        /**
         * Check if sensitivity rank value is valid
         * 
         * @param rank
         *        rank
         * 
         * @return if sensitivity rank value is valid
         * @throws SQLServerException
         *         if error
         */
        public static boolean isValid(int rank) throws SQLServerException {
            for (SensitivityRank r : VALUES) {
                if (r.getValue() == rank) {
                    return true;
                }
            }
            return false;
        }
    }

    private List labels;
    private List informationTypes;
    private List columnSensitivities;
    private int sensitivityRank;

    /*
     * Creating new ArrayList here assures that 'informationTypes' and 'labels' properties will not be null. The Count
     * of the ColumnSensitivities property will be equal to the number of output columns for the query result set.
     */

    /**
     * Constructs a SensitivityClassification Object
     * 
     * @param labels
     *        Labels as received from SQL Server
     * @param informationTypes
     *        Information Types as received from SQL Server
     * @param columnSensitivity
     *        Column Sensitivities as received from SQL Server
     */
    public SensitivityClassification(List labels, List informationTypes,
            List columnSensitivity) {
        this.labels = new ArrayList<>(labels);
        this.informationTypes = new ArrayList<>(informationTypes);
        this.columnSensitivities = new ArrayList<>(columnSensitivity);
    }

    /**
     * Constructs a SensitivityClassification Object
     * 
     * @param labels
     *        Labels as received from SQL Server
     * @param informationTypes
     *        Information Types as received from SQL Server
     * @param columnSensitivity
     *        Column Sensitivities as received from SQL Server
     * @param sensitivityRank
     *        Sensitivity rank as received from SQL Server
     */
    public SensitivityClassification(List labels, List informationTypes,
            List columnSensitivity, int sensitivityRank) {
        this.labels = new ArrayList<>(labels);
        this.informationTypes = new ArrayList<>(informationTypes);
        this.columnSensitivities = new ArrayList<>(columnSensitivity);
        this.sensitivityRank = sensitivityRank;
    }

    /**
     * Returns the labels for this SensitivityClassification Object
     * 
     * @return labels
     */
    public List getLabels() {
        return labels;
    }

    /**
     * Returns the information types for this SensitivityClassification Object
     * 
     * @return informationTypes
     */
    public List getInformationTypes() {
        return informationTypes;
    }

    /**
     * Returns the column sensitivity for this SensitivityClassification Object
     * 
     * @return columnSensitivities
     */
    public List getColumnSensitivities() {
        return columnSensitivities;
    }

    /**
     * Returns the sensitivity rank
     * 
     * @return sensitivity rank
     */
    public int getSensitivityRank() {
        return sensitivityRank;
    }
}