oracle.kv.impl.api.ops.BasicPutHandler 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.
There is a newer version: 18.3.10
/*-
 * 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.api.ops;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import oracle.kv.UnauthorizedException;
import oracle.kv.impl.api.ops.InternalOperation.OpCode;
import oracle.kv.impl.fault.WrappedClientException;
import oracle.kv.impl.security.KVStorePrivilege;
import oracle.kv.impl.security.NamespacePrivilege;
import oracle.kv.impl.security.SystemPrivilege;
import oracle.kv.impl.security.TablePrivilege;
import com.sleepycat.je.Cursor;
import com.sleepycat.je.DatabaseEntry;
import com.sleepycat.je.OperationResult;
import com.sleepycat.je.WriteOptions;

/**
 * Base server handler for {@link Put} and its subclasses.
 */
abstract class BasicPutHandler
        extends SingleKeyOperationHandler {

    /**
     * Whether this put operation has valid TTL setting that would introduce
     * implicit deletion of this record. If true, performing this operation
     * would require user having DELETE_TABLE privilege.
     */
    boolean hasValidTTLSetting = false;

    BasicPutHandler(OperationHandler handler,
                    OpCode opCode,
                    Class operationType) {
        super(handler, opCode, operationType);
    }

    @Override
    void verifyDataAccess(T op)
        throws UnauthorizedException {

        /*
         * Check if the operation has a valid TTL. If so, this operation is
         * an implicit delete and requires DELETE_TABLE privilege. See
         * tableAccessPrivileges(), below.
         *
         * The check for null handles older clients that may not include a
         * TTL.
         */
        if (((Put)op).getTTL() != null) {
            hasValidTTLSetting = (((Put)op).getTTL().getValue() != 0);
        }
        super.verifyDataAccess(op);
    }

    @Override
    List schemaAccessPrivileges() {
        return SystemPrivilege.schemaWritePrivList;
    }

    @Override
    List generalAccessPrivileges() {
        return SystemPrivilege.writeOnlyPrivList;
    }

    @Override
    public List
        tableAccessPrivileges(long tableId) {

        if (hasValidTTLSetting) {
            return Arrays.asList(new TablePrivilege.InsertTable(tableId),
                                 new TablePrivilege.DeleteTable(tableId));
        }
        return Collections.singletonList(
            new TablePrivilege.InsertTable(tableId));
    }

    @Override
    public List
    namespaceAccessPrivileges(String namespace) {

        if (hasValidTTLSetting) {
            return Arrays.asList(
                new NamespacePrivilege.InsertInNamespace(namespace),
                new NamespacePrivilege.DeleteInNamespace(namespace));
        }
        return Collections.singletonList(
            new NamespacePrivilege.InsertInNamespace(namespace));
    }

    static OperationResult putEntry(Cursor cursor,
                                    DatabaseEntry keyEntry,
                                    DatabaseEntry dataEntry,
                                    com.sleepycat.je.Put op,
                                    WriteOptions jeOptions) {
        try {
            return cursor.put(keyEntry, dataEntry, op, jeOptions);
        } catch (IllegalArgumentException iae) {
            throw new WrappedClientException(iae);
        }
    }
}