oracle.kv.impl.security.SystemPrivilege Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oracle-nosql-server Show documentation
NoSQL Database Server - supplies build and runtime support for the server (store) side of the Oracle NoSQL Database.
The newest version!
/*-
 * Copyright (C) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This file was distributed by Oracle as part of a version of Oracle NoSQL
 * Database made available at:
 *
 * http://www.oracle.com/technetwork/database/database-technologies/nosqldb/downloads/index.html
 *
 * Please see the LICENSE file included in the top-level directory of the
 * appropriate version of Oracle NoSQL Database for a copy of the license and
 * additional information.
 */
package oracle.kv.impl.security;

import java.util.Collections;
import java.util.EnumMap;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 * Implementation of system privileges within KVStore security system.
 */
public class SystemPrivilege extends KVStorePrivilege {

    private static final long serialVersionUID = 1L;

    /*
     * A lists of canonical system privilege instances corresponding to
     * system privilege labels.
     */
    public static final SystemPrivilege READ_ANY =
        new SystemPrivilege(KVStorePrivilegeLabel.READ_ANY);

    public static final SystemPrivilege WRITE_ANY =
        new SystemPrivilege(KVStorePrivilegeLabel.WRITE_ANY);

    public static final SystemPrivilege SYSVIEW =
        new SystemPrivilege(KVStorePrivilegeLabel.SYSVIEW);

    public static final SystemPrivilege USRVIEW =
        new SystemPrivilege(KVStorePrivilegeLabel.USRVIEW);

    public static final SystemPrivilege SYSOPER =
        new SystemPrivilege(KVStorePrivilegeLabel.SYSOPER);

    public static final SystemPrivilege INTLOPER =
        new SystemPrivilege(KVStorePrivilegeLabel.INTLOPER);

    public static final SystemPrivilege DBVIEW =
        new SystemPrivilege(KVStorePrivilegeLabel.DBVIEW);

    public static final SystemPrivilege SYSDBA =
        new SystemPrivilege(KVStorePrivilegeLabel.SYSDBA);

    /*
     * A series of useful privilege arrays
     */
    private static final KVStorePrivilege[] emptyPriv =
        new KVStorePrivilege[0];

    private static final KVStorePrivilege[] sysdba =
        new KVStorePrivilege[] { SYSDBA };

    private static final KVStorePrivilege[] dbviewAndSysdba =
        new KVStorePrivilege[] { DBVIEW, SYSDBA };

    private static final KVStorePrivilege[] readany =
        new KVStorePrivilege[] { READ_ANY };

    private static final KVStorePrivilege[] writeany =
        new KVStorePrivilege[] { WRITE_ANY };

    /*
     * Internal used only privilege to allow the access and operation on Avro
     * schemas.
     */
    public static final SystemPrivilege READ_ANY_SCHEMA =
        new SystemPrivilege(KVStorePrivilegeLabel.READ_ANY_SCHEMA) {

        private static final long serialVersionUID = 1L;

        @Override
        public KVStorePrivilege[] implyingPrivileges() {
            return dbviewAndSysdba;
        }
    };

    public static final SystemPrivilege WRITE_ANY_SCHEMA =
        new SystemPrivilege(KVStorePrivilegeLabel.WRITE_ANY_SCHEMA) {

        private static final long serialVersionUID = 1L;

        @Override
        public KVStorePrivilege[] implyingPrivileges() {
            return sysdba;
        }
    };

    /*
     * System privileges for table operations
     */
    public static final SystemPrivilege READ_ANY_TABLE =
        new SystemPrivilege(KVStorePrivilegeLabel.READ_ANY_TABLE) {

        private static final long serialVersionUID = 1L;

        @Override
        public KVStorePrivilege[] implyingPrivileges() {
            return readany;
        }
    };

    public static final SystemPrivilege DELETE_ANY_TABLE =
        new SystemPrivilege(KVStorePrivilegeLabel.DELETE_ANY_TABLE) {

        private static final long serialVersionUID = 1L;

        @Override
        public KVStorePrivilege[] implyingPrivileges() {
            return writeany;
        }
    };

    public static final SystemPrivilege INSERT_ANY_TABLE =
        new SystemPrivilege(KVStorePrivilegeLabel.INSERT_ANY_TABLE) {

        private static final long serialVersionUID = 1L;

        @Override
        public KVStorePrivilege[] implyingPrivileges() {
            return writeany;
        }
    };

    public static final SystemPrivilege CREATE_ANY_TABLE =
        new SystemPrivilege(KVStorePrivilegeLabel.CREATE_ANY_TABLE) {

        private static final long serialVersionUID = 1L;

        @Override
        public KVStorePrivilege[] implyingPrivileges() {
            return sysdba;
        }
    };

    public static final SystemPrivilege DROP_ANY_TABLE =
        new SystemPrivilege(KVStorePrivilegeLabel.DROP_ANY_TABLE) {

        private static final long serialVersionUID = 1L;

        @Override
        public KVStorePrivilege[] implyingPrivileges() {
            return sysdba;
        }
    };

    public static final SystemPrivilege EVOLVE_ANY_TABLE =
        new SystemPrivilege(KVStorePrivilegeLabel.EVOLVE_ANY_TABLE) {

        private static final long serialVersionUID = 1L;

        @Override
        public KVStorePrivilege[] implyingPrivileges() {
            return sysdba;
        }
    };

    public static final SystemPrivilege CREATE_ANY_INDEX =
        new SystemPrivilege(KVStorePrivilegeLabel.CREATE_ANY_INDEX) {

        private static final long serialVersionUID = 1L;

        @Override
        public KVStorePrivilege[] implyingPrivileges() {
            return sysdba;
        }
    };

    public static final SystemPrivilege DROP_ANY_INDEX =
        new SystemPrivilege(KVStorePrivilegeLabel.DROP_ANY_INDEX) {

            private static final long serialVersionUID = 1L;

            @Override
            public KVStorePrivilege[] implyingPrivileges() {
                return sysdba;
            }
        };

    public static final SystemPrivilege CREATE_ANY_NAMESPACE =
        new SystemPrivilege(KVStorePrivilegeLabel.CREATE_ANY_NAMESPACE) {

            private static final long serialVersionUID = 1L;

            @Override
            public KVStorePrivilege[] implyingPrivileges() {
                return sysdba;
            }
        };

    public static final SystemPrivilege DROP_ANY_NAMESPACE =
        new SystemPrivilege(KVStorePrivilegeLabel.DROP_ANY_NAMESPACE) {

            private static final long serialVersionUID = 1L;

            @Override
            public KVStorePrivilege[] implyingPrivileges() {
                return sysdba;
            }
        };

    /*
     * A map to store system privilege instances used to define system
     * predefined roles.
     */
    private static final EnumMap
        sysPrivilegeMap = new EnumMap(
            KVStorePrivilegeLabel.class);

    static {
        sysPrivilegeMap.put(READ_ANY.getLabel(), READ_ANY);
        sysPrivilegeMap.put(WRITE_ANY.getLabel(), WRITE_ANY);
        sysPrivilegeMap.put(SYSDBA.getLabel(), SYSDBA);
        sysPrivilegeMap.put(SYSVIEW.getLabel(), SYSVIEW);
        sysPrivilegeMap.put(DBVIEW.getLabel(), DBVIEW);
        sysPrivilegeMap.put(USRVIEW.getLabel(), USRVIEW);
        sysPrivilegeMap.put(SYSOPER.getLabel(), SYSOPER);
        sysPrivilegeMap.put(INTLOPER.getLabel(), INTLOPER);

        sysPrivilegeMap.put(CREATE_ANY_TABLE.getLabel(), CREATE_ANY_TABLE);
        sysPrivilegeMap.put(READ_ANY_TABLE.getLabel(), READ_ANY_TABLE);
        sysPrivilegeMap.put(INSERT_ANY_TABLE.getLabel(), INSERT_ANY_TABLE);
        sysPrivilegeMap.put(DELETE_ANY_TABLE.getLabel(), DELETE_ANY_TABLE);
        sysPrivilegeMap.put(DROP_ANY_TABLE.getLabel(), DROP_ANY_TABLE);
        sysPrivilegeMap.put(EVOLVE_ANY_TABLE.getLabel(), EVOLVE_ANY_TABLE);
        sysPrivilegeMap.put(CREATE_ANY_INDEX.getLabel(), CREATE_ANY_INDEX);
        sysPrivilegeMap.put(DROP_ANY_INDEX.getLabel(), DROP_ANY_INDEX);
        sysPrivilegeMap.put(CREATE_ANY_NAMESPACE.getLabel(),
            CREATE_ANY_NAMESPACE);
        sysPrivilegeMap.put(DROP_ANY_NAMESPACE.getLabel(), DROP_ANY_NAMESPACE);
    }

    private static final Set allSysPrivs =
        new HashSet(sysPrivilegeMap.values());

    /*
     * A couple of useful privilege lists.
     */
    public static final List dbviewPrivList =
        Collections.singletonList(SystemPrivilege.DBVIEW);

    public static final List sysdbaPrivList =
        Collections.singletonList(SystemPrivilege.SYSDBA);

    public static final List internalPrivList =
        Collections.singletonList(SystemPrivilege.INTLOPER);

    public static final List sysviewPrivList =
        Collections.singletonList(SystemPrivilege.SYSVIEW);

    public static final List usrviewPrivList =
        Collections.singletonList(SystemPrivilege.USRVIEW);

    public static final List sysoperPrivList =
        Collections.singletonList(SystemPrivilege.SYSOPER);

    public static final List writeOnlyPrivList =
        Collections.singletonList(SystemPrivilege.WRITE_ANY);

    public static final List readOnlyPrivList =
        Collections.singletonList(SystemPrivilege.READ_ANY);

    public static final List schemaReadPrivList =
        Collections.singletonList(SystemPrivilege.READ_ANY_SCHEMA);

    public static final List schemaWritePrivList =
        Collections.singletonList( SystemPrivilege.WRITE_ANY_SCHEMA );

    public static final List tableCreatePrivList =
        Collections.singletonList( SystemPrivilege.CREATE_ANY_TABLE );

    public static final List tableDropPrivList =
        Collections.singletonList( SystemPrivilege.DROP_ANY_TABLE );

    public static final List namespaceCreatePrivList =
        Collections.singletonList( SystemPrivilege.CREATE_ANY_NAMESPACE );

    public static final List namespaceDropPrivList =
        Collections.singletonList( SystemPrivilege.DROP_ANY_NAMESPACE );


    /**
     * Constructs a system privilege using the specified label.
     */
    SystemPrivilege(KVStorePrivilegeLabel privLabel) {
        super(privLabel);

        if (privLabel.getType() != PrivilegeType.SYSTEM) {
            throw new IllegalArgumentException(
                "Could not create a system privilege using a non-system " +
                "privilege label " + privLabel);
        }
    }

    /**
     * Gets a canonical predefined system privilege instance according to the
     * specified label.
     *
     * @param privLabel KVStore privilege label
     * @return KVStorePrivilege instance
     */
    public static SystemPrivilege get(KVStorePrivilegeLabel privLabel) {

        if (privLabel.getType() != PrivilegeType.SYSTEM) {
            throw new IllegalArgumentException(
                "Could not obtain a system privilege with a non-system " +
                "privilege label " + privLabel);
        }
        return sysPrivilegeMap.get(privLabel);
    }

    /**
     * Return all system privileges.
     */
    public static Set getAllSystemPrivileges() {
        return allSysPrivs;
    }

    /**
     * Return an empty array as the set of privileges implying this privilege
     * by default. This can be overrided by subclasses so that they can
     * implement new semantics.
     */
    @Override
    public KVStorePrivilege[] implyingPrivileges() {
        return emptyPriv;
    }
}