org.firebirdsql.jdbc.metadata.PrivilegeMapping Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation
JDBC Driver for the Firebird RDBMS
The newest version!
/*
 * Firebird Open Source JDBC Driver
 *
 * Distributable under LGPL license.
 * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * LGPL License for more details.
 *
 * This file was created by members of the firebird development team.
 * All individual contributions remain the Copyright (C) of those
 * individuals.  Contributors to this file are either listed here or
 * can be obtained from a source control history command.
 *
 * All rights reserved.
 */
package org.firebirdsql.jdbc.metadata;

import java.util.Map;

/**
 * Maps Firebird privilege codes (from {@code RDB$USER_PRIVILEGES.RDB$PRIVILEGE}) to a privilege name.
 *
 * @author Mark Rotteveel
 * @since 5
 */
public final class PrivilegeMapping {

    private static final Map PRIVILEGE_MAPPING = Map.ofEntries(
            // NOTE: 'A' doesn't seem to be used by Firebird (maybe in older versions?)
            Map.entry("A", "ALL"),
            Map.entry("D", "DELETE"),
            Map.entry("I", "INSERT"),
            Map.entry("R", "REFERENCES"),
            Map.entry("S", "SELECT"),
            Map.entry("U", "UPDATE"),

            Map.entry("C", "CREATE"),
            Map.entry("L", "ALTER"),
            Map.entry("O", "DROP"),

            // Executing procedures/functions (unused in JDBC metadata)
            Map.entry("X", "EXECUTE"),
            // Usage of object (unused in JDBC metadata)
            Map.entry("G", "USAGE"),
            // User/object is a member of a ROLE (unused in JDBC metadata)
            Map.entry("M", "MEMBEROF"));

    private PrivilegeMapping() {
        // no instances
    }

    /**
     * Maps the (one character) Firebird privilege code to the equivalent JDBC privilege.
     *
     * @param firebirdPrivilege
     *         Firebird privilege character
     * @return privilege name or {@code "UNKNOWN"} when the privilege is not known
     */
    public static String mapPrivilege(String firebirdPrivilege) {
        return PRIVILEGE_MAPPING.getOrDefault(firebirdPrivilege, "UNKNOWN");
    }
}