oracle.kv.impl.admin.CommandServiceImpl 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
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.
/*-
* 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.admin;
import static oracle.kv.impl.security.AccessCheckUtils.checkPermission;
import java.io.File;
import java.io.FilenameFilter;
import java.io.IOException;
import java.lang.reflect.Constructor;
import java.net.URI;
import java.rmi.RemoteException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
import oracle.kv.KVVersion;
import oracle.kv.impl.admin.Snapshot.SnapResult;
import oracle.kv.impl.admin.Snapshot.SnapResultSummary;
import oracle.kv.impl.admin.Snapshot.SnapshotOperation;
import oracle.kv.impl.admin.criticalevent.CriticalEvent;
import oracle.kv.impl.admin.param.Parameters;
import oracle.kv.impl.admin.param.StorageNodeParams;
import oracle.kv.impl.admin.param.StorageNodePool;
import oracle.kv.impl.admin.plan.Plan;
import oracle.kv.impl.admin.plan.PlanStateChange;
import oracle.kv.impl.admin.topo.Rules;
import oracle.kv.impl.admin.topo.TopologyCandidate;
import oracle.kv.impl.api.avro.AvroDdl;
import oracle.kv.impl.api.avro.AvroSchemaMetadata;
import oracle.kv.impl.api.table.FieldMap;
import oracle.kv.impl.api.table.NameUtils;
import oracle.kv.impl.api.table.TableImpl;
import oracle.kv.impl.api.table.TableLimits;
import oracle.kv.impl.api.table.TableMetadata;
import oracle.kv.impl.fault.CommandFaultException;
import oracle.kv.impl.fault.ProcessFaultHandler;
import oracle.kv.impl.metadata.Metadata;
import oracle.kv.impl.metadata.Metadata.MetadataType;
import oracle.kv.impl.metadata.MetadataInfo;
import oracle.kv.impl.mgmt.AdminStatusReceiver;
import oracle.kv.impl.monitor.Tracker.RetrievedEvents;
import oracle.kv.impl.monitor.TrackerListener;
import oracle.kv.impl.monitor.views.PerfEvent;
import oracle.kv.impl.monitor.views.ServiceChange;
import oracle.kv.impl.param.LoadParameters;
import oracle.kv.impl.param.ParameterMap;
import oracle.kv.impl.param.ParameterState;
import oracle.kv.impl.security.AccessCheckUtils.PlanAccessContext;
import oracle.kv.impl.security.AccessCheckUtils.PlanOperationContext;
import oracle.kv.impl.security.AccessCheckUtils.TableContext;
import oracle.kv.impl.security.AuthContext;
import oracle.kv.impl.security.ExecutionContext;
import oracle.kv.impl.security.KVStorePrivilege;
import oracle.kv.impl.security.KVStorePrivilegeLabel;
import oracle.kv.impl.security.KVStoreUserPrincipal;
import oracle.kv.impl.security.OperationContext;
import oracle.kv.impl.security.SystemPrivilege;
import oracle.kv.impl.security.TablePrivilege;
import oracle.kv.impl.security.annotations.PublicMethod;
import oracle.kv.impl.security.annotations.SecureAPI;
import oracle.kv.impl.security.annotations.SecureAutoMethod;
import oracle.kv.impl.security.annotations.SecureInternalMethod;
import oracle.kv.impl.security.annotations.SecureR2Method;
import oracle.kv.impl.security.metadata.KVStoreUser.UserDescription;
import oracle.kv.impl.security.metadata.SecurityMetadata;
import oracle.kv.impl.test.RemoteTestInterface;
import oracle.kv.impl.topo.AdminId;
import oracle.kv.impl.topo.AdminType;
import oracle.kv.impl.topo.DatacenterId;
import oracle.kv.impl.topo.DatacenterType;
import oracle.kv.impl.topo.RepGroupId;
import oracle.kv.impl.topo.RepNodeId;
import oracle.kv.impl.topo.ResourceId;
import oracle.kv.impl.topo.StorageNodeId;
import oracle.kv.impl.topo.Topology;
import oracle.kv.impl.util.ConfigurableService.ServiceStatus;
import oracle.kv.impl.util.FileNames;
import oracle.kv.impl.util.SerialVersion;
import oracle.kv.impl.util.registry.VersionedRemoteImpl;
import oracle.kv.table.FieldDef;
import oracle.kv.table.TimeToLive;
import oracle.kv.util.ErrorMessage;
import com.sleepycat.je.DatabaseException;
import com.sleepycat.je.rep.ReplicatedEnvironment;
import com.sleepycat.je.rep.ReplicatedEnvironment.State;
import com.sleepycat.je.util.DbBackup;
@SecureAPI
public class CommandServiceImpl
extends VersionedRemoteImpl implements CommandService {
private final AdminService aservice;
private RemoteTestInterface rti;
private static final String TEST_INTERFACE_NAME =
"oracle.kv.impl.admin.CommandServiceTestInterface";
/**
* A cached copy of the Admin. This is null until configure() is
* called.
*/
private Admin admin;
private DbBackup dbBackup;
public CommandServiceImpl(AdminService aservice) {
this.aservice = aservice;
admin = aservice.getAdmin();
startTestInterface();
}
/**
* Can the test interface be created?
*/
private void startTestInterface() {
try {
final Class cl = Class.forName(TEST_INTERFACE_NAME);
final Constructor c = cl.getConstructor(aservice.getClass());
rti = (RemoteTestInterface) c.newInstance(aservice);
rti.start(SerialVersion.CURRENT);
} catch (Exception ignored) /* CHECKSTYLE:OFF */ {
}/* CHECKSTYLE:ON */
}
@Override
@SecureR2Method
public synchronized ServiceStatus ping(short serialVersion) {
throw invalidR2MethodException();
}
/**
* Return the service status associated with the CommandService. If the
* service is up, it will return RUNNING. Otherwise it won't respond
* at all. This is just a way for the client to ask if the service is
* running.
*/
@Override
@PublicMethod
public synchronized ServiceStatus ping(AuthContext authCtx,
short serialVersion) {
return ServiceStatus.RUNNING;
}
@Override
@SecureR2Method
public List getStorageNodePoolNames(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public List getStorageNodePoolNames(AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation>() {
@Override
public List execute() {
requireConfigured();
final Parameters p = admin.getCurrentParameters();
final List names =
new ArrayList<>(p.getStorageNodePoolNames());
Collections.sort(names);
return names;
}
});
}
@Override
@SecureR2Method
public void addStorageNodePool(final String name, short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void addStorageNodePool(final String name,
AuthContext authCtx, short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
admin.addStorageNodePool(name);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void cloneStorageNodePool(final String name,
final String source,
AuthContext authCtx, short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
admin.cloneStorageNodePool(name, source);
}
});
}
@Override
@SecureR2Method
public void removeStorageNodePool(final String name, short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void removeStorageNodePool(final String name, AuthContext authCtx,
short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
admin.removeStorageNodePool(name);
}
});
}
@Override
@SecureR2Method
public List getStorageNodePoolIds(final String name,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public List getStorageNodePoolIds(final String name,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation>() {
@Override
public List execute() {
requireConfigured();
final Parameters p = admin.getCurrentParameters();
final StorageNodePool pool = p.getStorageNodePool(name);
if (pool == null) {
throw new IllegalCommandException
("No such Storage Node Pool: " + name);
}
return pool.getList();
}
});
}
@Override
@SecureR2Method
public void addStorageNodeToPool(final String name,
final StorageNodeId snId,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void addStorageNodeToPool(final String name,
final StorageNodeId snId,
AuthContext authCtx,
short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
admin.addStorageNodeToPool(name, snId);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void removeStorageNodeFromPool(final String name,
final StorageNodeId snId,
AuthContext authCtx,
short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
admin.removeStorageNodeFromPool(name, snId);
}
});
}
@Override
@SecureR2Method
public void replaceStorageNodePool(final String name,
final List ids,
final short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void replaceStorageNodePool(final String name,
final List ids,
AuthContext authCtx,
final short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
admin.replaceStorageNodePool(name, ids);
}
});
}
@Override
@SecureR2Method
public String createTopology(final String candidateName,
final String snPoolName,
final int numPartitions,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
@Deprecated
public String createTopology(final String candidateName,
final String snPoolName,
final int numPartitions,
AuthContext authCtx,
short serialVersion) {
return createTopology(candidateName, snPoolName, numPartitions, false,
authCtx, serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String createTopology(final String candidateName,
final String snPoolName,
final int numPartitions,
final boolean json,
AuthContext authCtx,
short serialVersion) {
return createTopology(candidateName,
snPoolName,
numPartitions,
json, SerialVersion.ADMIN_CLI_JSON_V1_VERSION,
authCtx, serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String createTopology(final String candidateName,
final String snPoolName,
final int numPartitions,
final boolean json,
final short jsonVersion,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return admin.createTopoCandidate(candidateName, snPoolName,
numPartitions, json,
jsonVersion);
}
});
}
@Override
@SecureR2Method
public String copyCurrentTopology(final String candidateName,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String copyCurrentTopology(final String candidateName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
admin.addTopoCandidate(candidateName,
admin.getCurrentTopology());
return "Created " + candidateName;
}
});
}
@Override
@SecureR2Method
public String copyTopology(final String sourceCandidateName,
final String targetCandidateName,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String copyTopology(final String sourceCandidateName,
final String targetCandidateName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
admin.addTopoCandidate(targetCandidateName,
sourceCandidateName);
return "Created " + targetCandidateName;
}
});
}
@Override
@SecureR2Method
public String validateTopology(final String candidateName,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public String validateTopology(String candidateName,
AuthContext authCtx,
short serialVersion) {
return validateTopology(candidateName,
SerialVersion.ADMIN_CLI_JSON_V1_VERSION,
authCtx, serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public String validateTopology(final String candidateName,
final short jsonVersion,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return admin.validateTopology(candidateName, jsonVersion);
}
});
}
@Override
@SecureR2Method
public List listTopologies(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public List listTopologies(AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation>() {
@Override
public List execute() {
requireConfigured();
return admin.listTopoCandidates();
}
});
}
@Override
@SecureR2Method
public String deleteTopology(final String candidateName,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String deleteTopology(final String candidateName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
admin.deleteTopoCandidate(candidateName);
return "Removed " + candidateName;
}
});
}
@Override
@SecureR2Method
public String rebalanceTopology(final String candidateName,
final String snPoolName,
final DatacenterId dcId,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String rebalanceTopology(final String candidateName,
final String snPoolName,
final DatacenterId dcId,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return admin.rebalanceTopology(candidateName, snPoolName,
dcId);
}
});
}
@Override
@SecureR2Method
public String changeRepFactor(final String candidateName,
final String snPoolName,
final DatacenterId dcId,
final int repFactor,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String changeRepFactor(final String candidateName,
final String snPoolName,
final DatacenterId dcId,
final int repFactor,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return admin.changeRepFactor(candidateName, snPoolName,
dcId, repFactor);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String changeZoneType(final String candidateName,
final DatacenterId dcId,
final DatacenterType type,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return admin.changeZoneType(candidateName, dcId, type);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String changeZoneMasterAffinity(final String candidateName,
final DatacenterId dcId,
final boolean masterAffinity,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
final Topology topology =
admin.getCandidate(candidateName).getTopology();
/* Do not allow to change master affinity for secondary zone */
try {
Rules.validateMasterAffinity(masterAffinity,
topology.get(dcId).getDatacenterType());
} catch (IllegalArgumentException iae) {
throw new IllegalCommandException(iae.getMessage(), iae);
}
return admin.changeZoneMasterAffinity(candidateName,
dcId,
masterAffinity);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String changeZoneArbiters(final String candidateName,
final DatacenterId dcId,
final boolean allowArbiters,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return admin.changeZoneArbiters(candidateName,
dcId,
allowArbiters);
}
});
}
@Override
@SecureR2Method
public String redistributeTopology(final String candidateName,
final String snPoolName,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String redistributeTopology(final String candidateName,
final String snPoolName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return admin.redistributeTopology(candidateName, snPoolName);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String contractTopology(final String candidateName,
final String snPoolName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return admin.contractTopology(candidateName, snPoolName);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String removeFailedShard(final RepGroupId failedShard,
final String candidateName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return admin.removeFailedShard(failedShard, candidateName);
}
});
}
@Override
@SecureR2Method
public String moveRN(final String candidateName,
final RepNodeId rnId,
final StorageNodeId snId,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String moveRN(final String candidateName,
final RepNodeId rnId,
final StorageNodeId snId,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return admin.moveRN(candidateName, rnId, snId);
}
});
}
@Override
@SecureR2Method
public String preview(final String targetTopoName,
final String startTopoName,
final boolean verbose,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String preview(final String targetTopoName,
final String startTopoName,
final boolean verbose,
AuthContext authCtx,
short serialVersion) {
return preview(targetTopoName,
startTopoName,
verbose, SerialVersion.ADMIN_CLI_JSON_V1_VERSION,
authCtx, serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String preview(final String targetTopoName,
final String startTopoName,
final boolean verbose,
final short jsonVersion,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return admin.previewTopology(targetTopoName, startTopoName,
verbose, jsonVersion);
}
});
}
@Override
@SecureR2Method
public List getAdmins(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public List getAdmins(AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation>() {
@Override
public List execute() {
requireConfigured();
final Parameters p = admin.getCurrentParameters();
final ArrayList list = new ArrayList<>();
for (AdminId id : p.getAdminIds()) {
list.add(p.get(id).getMap());
}
return list;
}
});
}
@Override
@SecureR2Method
public Plan getPlanById(final int planId, short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureInternalMethod
public Plan getPlanById(final int planId,
AuthContext authCtx, final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Plan execute() {
requireConfigured();
/*
* Don't talk to pre-V11 client since they cannot recognize
* new plans introduced in V11.
*/
checkClientSupported(serialVersion, SerialVersion.V11);
final Plan plan = admin.getPlanById(planId);
if (plan != null) {
checkPermission(aservice,
new PlanAccessContext(plan, "Get plan"));
}
return plan;
}
});
}
@Override
@SecureR2Method
@Deprecated
public Map getPlans(short serialVersion) {
throw invalidR2MethodException();
}
@Override
/* Not used. Annotated with SYSVIEW for safety. */
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
@Deprecated
public Map getPlans(AuthContext authCtx,
final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation>() {
@Override
public Map execute() {
requireConfigured();
/*
* Don't talk to pre-V11 client since they cannot recognize
* new plans introduced in V11.
*/
checkClientSupported(serialVersion, SerialVersion.V11);
return admin.getRecentPlansCopy();
}
});
}
@Override
@SecureR2Method
public void approvePlan(final int planId, short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureInternalMethod
public void approvePlan(final int planId,
AuthContext authCtx, short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
final Plan plan = admin.getAndCheckPlan(planId);
checkPermission(aservice,
new PlanOperationContext(plan, "Approve plan"));
admin.approvePlan(planId);
}
});
}
@Override
@SecureR2Method
public void executePlan(final int planId, final boolean force,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureInternalMethod
public void executePlan(final int planId, final boolean force,
AuthContext authCtx, short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
final Plan plan = admin.getAndCheckPlan(planId);
checkPermission(aservice,
new PlanOperationContext(plan, "Execute plan"));
admin.executePlan(planId, force);
}
});
}
@Override
@SecureR2Method
public Plan.State awaitPlan(final int planId, final int timeout,
final TimeUnit timeUnit, short serialVersion) {
throw invalidR2MethodException();
}
/**
* Wait for the plan to finish. If a timeout period is specified, return
* either when the plan finishes or the timeout occurs.
* @return the current plan status when the call returns. If the call timed
* out, the plan may still be running.
*/
@Override
@SecureInternalMethod
public Plan.State awaitPlan(final int planId, final int timeout,
final TimeUnit timeUnit,
AuthContext authCtx, short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Plan.State execute() {
requireConfigured();
final Plan plan = admin.getAndCheckPlan(planId);
checkPermission(aservice,
new PlanOperationContext(plan, "Await plan"));
return admin.awaitPlan(planId, timeout, timeUnit);
}
});
}
@Override
@SecureR2Method
public void cancelPlan(final int planId, short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureInternalMethod
public void cancelPlan(final int planId,
AuthContext authCtx, short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
final Plan plan = admin.getAndCheckPlan(planId);
checkPermission(aservice,
new PlanOperationContext(plan, "Cancel plan"));
admin.cancelPlan(planId);
}
});
}
@Override
@SecureR2Method
public void interruptPlan(final int planId, short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureInternalMethod
public void interruptPlan(final int planId,
AuthContext authCtx,
short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
final Plan plan = admin.getAndCheckPlan(planId);
checkPermission(aservice,
new PlanOperationContext(plan,
"Interrupt plan"));
admin.interruptPlan(planId);
}
});
}
@Override
@SecureR2Method
public void retryPlan(final int planId, short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureInternalMethod
public void retryPlan(final int planId,
AuthContext authCtx,
short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
final Plan plan = admin.getAndCheckPlan(planId);
checkPermission(aservice,
new PlanOperationContext(plan, "Retry plan"));
admin.executePlan(planId, false);
}
});
}
/**
* @deprecated Unused since R2, since the Admin Console has become
* read-only.
*/
@Deprecated
@Override
@SecureR2Method
public void createAndExecuteConfigurationPlan(final String kvsName,
final String dcName,
final int repFactor,
short serialVersion) {
throw invalidR2MethodException();
}
/**
* @deprecated Unused since R2, since the Admin Console has become
* read-only.
*/
@Deprecated
@Override
/* Not used by client. Annotated with SYSOPER for safety */
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void createAndExecuteConfigurationPlan(final String kvsName,
final String dcName,
final int repFactor,
AuthContext authCtx,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureR2Method
public int createDeployDatacenterPlan(final String planName,
final String datacenterName,
final int repFactor,
final String datacenterComment,
short serialVersion) {
throw invalidR2MethodException();
}
/**
* Note that datacenterComment is unused, and is deprecated as of R2. This
* method is only used by R2 and earlier clients.
*/
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createDeployDatacenterPlan(final String planName,
final String datacenterName,
final int repFactor,
final String datacenterComment,
AuthContext authCtx,
short serialVersion) {
return createDeployDatacenterPlan(planName,
datacenterName,
repFactor,
DatacenterType.PRIMARY,
false /* allowArbiters */,
authCtx,
serialVersion);
}
@Override
@SecureR2Method
public int createDeployDatacenterPlan(final String planName,
final String datacenterName,
final int repFactor,
final DatacenterType datacenterType,
final short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createDeployDatacenterPlan(final String planName,
final String datacenterName,
final int repFactor,
final DatacenterType datacenterType,
AuthContext authCtx,
final short serialVersion) {
return createDeployDatacenterPlan(planName,
datacenterName,
repFactor,
datacenterType,
false /* allowArbiters */,
authCtx,
serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createDeployDatacenterPlan(final String planName,
final String datacenterName,
final int repFactor,
final DatacenterType datacenterType,
final boolean allowArbiters,
AuthContext authCtx,
final short serialVersion) {
return createDeployDatacenterPlan(planName, datacenterName, repFactor,
datacenterType, allowArbiters,
false /* masterAffinity */,
authCtx, serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createDeployDatacenterPlan(final String planName,
final String datacenterName,
final int repFactor,
final DatacenterType datacenterType,
final boolean allowArbiters,
final boolean masterAffinity,
AuthContext authCtx,
final short serialVersion) {
return aservice.getFaultHandler().execute(
new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
try {
Rules.validateReplicationFactor(repFactor);
} catch (IllegalArgumentException iae) {
throw new IllegalCommandException(
"Bad replication factor", iae);
}
try {
Rules.validateArbiter(allowArbiters, datacenterType);
} catch (IllegalArgumentException iae) {
throw new IllegalCommandException(
"Secondary datacenters do not allow Arbiters.",
iae);
}
try {
Rules.validateMasterAffinity(masterAffinity,
datacenterType);
} catch (IllegalArgumentException iae) {
throw new IllegalCommandException(
iae.getMessage(), iae);
}
return admin.getPlanner().createDeployDatacenterPlan
(planName, datacenterName, repFactor,
datacenterType, allowArbiters, masterAffinity);
}
});
}
@Override
@SecureR2Method
public int createDeploySNPlan(final String planName,
final DatacenterId datacenterId,
final String hostName,
final int registryPort,
final String comment,
short serialVersion) {
throw invalidR2MethodException();
}
/**
* Creates a plan to deploy a storage node, and stores it by id.
*/
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createDeploySNPlan(final String planName,
final DatacenterId datacenterId,
final String hostName,
final int registryPort,
final String comment,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
final ParameterMap pMap = admin.copyPolicy();
final StorageNodeParams snParams =
new StorageNodeParams
(pMap, null, hostName, registryPort, comment);
return admin.getPlanner().createDeploySNPlan
(planName, datacenterId, snParams);
}
});
}
@Override
@SecureR2Method
public int createDeployAdminPlan(final String planName,
final StorageNodeId snid,
final int httpPort,
short serialVersion) {
throw invalidR2MethodException();
}
/**
* Creates a plan to deploy an Admin, and stores it by its plan id.
*/
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createDeployAdminPlan(final String planName,
final StorageNodeId snid,
final int httpPort /* unused*/,
final AdminType adminType,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createDeployAdminPlan
(planName, snid, adminType);
}
});
}
/**
* Creates a plan to deploy an Admin, and stores it by its plan id.
*/
@Deprecated
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createDeployAdminPlan(final String planName,
final StorageNodeId snid,
final int httpPort,
AuthContext authCtx,
short serialVersion) {
/*
* Callers to this API are expecting the Admin to be a PRIMARY, so
* pass in a specific type instead of null.
*/
return createDeployAdminPlan(planName,
snid,
httpPort,
AdminType.PRIMARY,
authCtx,
serialVersion);
}
@Override
@SecureR2Method
public int createRemoveAdminPlan(final String planName,
final DatacenterId dcid,
final AdminId aid,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
@Deprecated
public int createRemoveAdminPlan(final String planName,
final DatacenterId dcid,
final AdminId aid,
AuthContext authCtx,
short serialVersion) {
return createRemoveAdminPlan(planName, dcid, aid, false, authCtx,
serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createRemoveAdminPlan(final String planName,
final DatacenterId dcid,
final AdminId aid,
final boolean failedSN,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createRemoveAdminPlan
(planName, dcid, aid, failedSN);
}
});
}
@Override
@SecureR2Method
public int createDeployTopologyPlan(final String planName,
final String candidateName,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
@Deprecated
public int createDeployTopologyPlan(final String planName,
final String candidateName,
AuthContext authCtx,
short serialVersion) {
return createDeployTopologyPlan(planName, candidateName, null,
authCtx, serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createDeployTopologyPlan(final String planName,
final String candidateName,
final RepGroupId failedShard,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createDeployTopoPlan
(planName, candidateName, failedShard);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createFailoverPlan(final String planName,
final Set newPrimaryZones,
final Set offlineZones,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute(
new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createFailoverPlan(
planName, newPrimaryZones, offlineZones);
}
});
}
@Override
@SecureR2Method
public int createStopAllRepNodesPlan(final String planName,
short serialVersion) {
throw invalidR2MethodException();
}
/**
* Creates a plan to stop all RepNodes in a kvstore.
*/
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createStopAllRepNodesPlan(final String planName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createStopAllRepNodesPlan(planName);
}
});
}
@Override
@SecureR2Method
public int createStartAllRepNodesPlan(final String planName,
short serialVersion) {
throw invalidR2MethodException();
}
/**
* Creates a plan to start all RepNodes in a kvstore.
*/
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createStartAllRepNodesPlan(final String planName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createStartAllRepNodesPlan(planName);
}
});
}
@Override
@SecureR2Method
public int createStopRepNodesPlan(final String planName,
final Set ids,
short serialVersion) {
throw invalidR2MethodException();
}
/**
* Creates a plan to stop the given RepNodes.
*/
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createStopRepNodesPlan(final String planName,
final Set ids,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createStopRepNodesPlan(planName, ids);
}
});
}
@Override
@SecureR2Method
public int createStartRepNodesPlan(final String planName,
final Set ids,
short serialVersion) {
throw invalidR2MethodException();
}
/**
* Creates a plan to start the given RepNodes.
*/
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createStartRepNodesPlan(final String planName,
final Set ids,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createStartRepNodesPlan(planName, ids);
}
});
}
/**
* Creates a plan to stop the given services.
*/
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createStopServicesPlan(final String planName,
final Set ids,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createStopServicesPlan(planName, ids);
}
});
}
/**
* Creates a plan to start the given services.
*/
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createStartServicesPlan(final String planName,
final Set ids,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createStartServicesPlan(planName, ids);
}
});
}
@Override
@SecureR2Method
public int createChangeParamsPlan(final String planName,
final ResourceId rid,
final ParameterMap newParams,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createChangeParamsPlan(final String planName,
final ResourceId rid,
final ParameterMap newParams,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createChangeParamsPlan(planName, rid, newParams);
}
});
}
@Override
@SecureR2Method
public int createChangeAllParamsPlan(final String planName,
final DatacenterId dcid,
final ParameterMap newParams,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createChangeAllParamsPlan(final String planName,
final DatacenterId dcid,
final ParameterMap newParams,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createChangeAllParamsPlan(planName, dcid, newParams);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createChangeAllANParamsPlan(final String planName,
final DatacenterId dcid,
final ParameterMap newParams,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createChangeAllANParamsPlan(planName, dcid, newParams);
}
});
}
@Override
@SecureR2Method
public int createChangeAllAdminsPlan(final String planName,
final DatacenterId dcid,
final ParameterMap newParams,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createChangeAllAdminsPlan(final String planName,
final DatacenterId dcid,
final ParameterMap newParams,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createChangeAllAdminsPlan(planName, dcid, newParams);
}
});
}
/* no R2-compatible version */
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int
createChangeGlobalComponentsParamsPlan(final String planName,
final ParameterMap newParams,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createChangeGlobalComponentsParamsPlan(planName,
newParams,
false);
}
});
}
/* no R2-compatible version */
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int
createChangeGlobalSecurityParamsPlan(final String planName,
final ParameterMap newParams,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createChangeGlobalSecurityParamsPlan(planName, newParams);
}
});
}
/* no R2-compatible version */
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createCreateUserPlan(final String planName,
final String userName,
final boolean isEnabled,
final boolean isAdmin,
final char[] plainPassword,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@SuppressWarnings("deprecation")
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createCreateUserPlan(planName, userName, isEnabled,
isAdmin, plainPassword);
}
});
}
/* no R2-compatible version */
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createDropUserPlan(final String planName,
final String userName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@SuppressWarnings("deprecation")
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createDropUserPlan(planName, userName);
}
});
}
/* no R2-compatible version */
@Override
/*
* Minimum privilege is USRVIEW to verify the user has successfully logged
* in. SYSOPER is required if the modified user is different from the
* current user. Such check will be conducted in the plan.
*/
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.USRVIEW })
public int createChangeUserPlan(final String planName,
final String userName,
final Boolean isEnabled,
final char[] plainPassword,
final boolean retainPassword,
final boolean clearRetainedPassword,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@SuppressWarnings("deprecation")
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createChangeUserPlan(planName, userName,
isEnabled, plainPassword,
retainPassword,
clearRetainedPassword);
}
});
}
/* no R2-compatible version */
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createGrantPlan(final String planName,
final String grantee,
final Set roles,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createGrantPlan(planName, grantee, roles);
}
});
}
/* no R2-compatible version */
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createRevokePlan(final String planName,
final String userName,
final Set roles,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createRevokePlan(planName, userName, roles);
}
});
}
@Override
@SecureR2Method
public int createMigrateSNPlan(final String planName,
final StorageNodeId oldNode,
final StorageNodeId newNode,
final int newHttpPort,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createMigrateSNPlan(final String planName,
final StorageNodeId oldNode,
final StorageNodeId newNode,
final int newHttpPort,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createMigrateSNPlan(planName, oldNode,
newNode);
}
});
}
@Override
@SecureR2Method
public int createRemoveSNPlan(final String planName,
final StorageNodeId targetNode,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createRemoveSNPlan(final String planName,
final StorageNodeId targetNode,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createRemoveSNPlan(planName, targetNode);
}
});
}
@Override
@SecureR2Method
public int createRemoveDatacenterPlan(final String planName,
final DatacenterId targetId,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createRemoveDatacenterPlan(final String planName,
final DatacenterId targetId,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createRemoveDatacenterPlan(planName, targetId);
}
});
}
/** Create a plan that will address mismatches in the topology */
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createRepairPlan(final String planName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createRepairPlan(planName);
}
});
}
/*
* Note on table names and namespaces.
* In order to keep the on-the-wire signatures compatible and not duplicate
* interfaces for compatibility, table names with namespaces are passed as
* a string string of the format:
* [namespace:]full-table-name
*
* Validation of the namespace and names will have been done before getting
* here.
*/
/*
* The pre-4.0 version
*/
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.CREATE_ANY_TABLE })
public int createAddTablePlan(final String planName,
final String tableName,
final String parentName,
final FieldMap fieldMap,
final List primaryKey,
final List shardKey,
final boolean r2compat,
final int schemaId,
final String description,
AuthContext authCtx,
short serialVersion) {
return createAddTablePlan(planName, null, tableName, parentName,
fieldMap, primaryKey, null,
shardKey, null, null, r2compat, schemaId,
description, authCtx, serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.CREATE_ANY_TABLE })
public int createAddTablePlan(final String planName,
final String tableName,
final String parentName,
final FieldMap fieldMap,
final List primaryKey,
final List primaryKeySizes,
final List shardKey,
final TimeToLive ttl,
final boolean r2compat,
final int schemaId,
final String description,
AuthContext authCtx,
final short serialVersion) {
return createAddTablePlan(planName, null, tableName, parentName,
fieldMap, primaryKey, primaryKeySizes,
shardKey, ttl, null, r2compat, schemaId,
description, authCtx, serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.CREATE_ANY_TABLE })
public int createAddTablePlan(final String planName,
final String namespace,
final String tableName,
final String parentName,
final FieldMap fieldMap,
final List primaryKey,
final List primaryKeySizes,
final List shardKey,
final TimeToLive ttl,
final boolean r2compat,
final int schemaId,
final String description,
AuthContext authCtx,
final short serialVersion) {
return createAddTablePlan(planName, namespace, tableName, parentName,
fieldMap, primaryKey, primaryKeySizes,
shardKey, ttl, null, r2compat, schemaId,
description, authCtx, serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.CREATE_ANY_TABLE })
public int createAddTablePlan(final String planName,
final String namespace,
final String tableName,
final String parentName,
final FieldMap fieldMap,
final List primaryKey,
final List primaryKeySizes,
final List shardKey,
final TimeToLive ttl,
final TableLimits limits,
final boolean r2compat,
final int schemaId,
final String description,
AuthContext authCtx,
final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
if (schemaId != 0) {
validateSchemaId(schemaId);
}
TableImpl table = TableImpl.createTable(
namespace,
tableName,
null,
primaryKey,
primaryKeySizes,
shardKey,
fieldMap,
r2compat,
schemaId,
description,
true,
null,
ttl,
limits,
false);
return admin.getPlanner().
createAddTablePlan(planName, table, parentName, false);
}
});
}
@Override
@SecureInternalMethod
public int createRemoveTablePlan(final String planName,
final String tableName,
final boolean removeData,
AuthContext authCtx,
short serialVersion) {
return createRemoveTablePlan(planName, null, tableName,
removeData, authCtx, serialVersion);
}
@Override
@SecureInternalMethod
public int createRemoveTablePlan(final String planName,
final String namespace,
final String tableName,
final boolean removeData,
AuthContext authCtx,
short serialVersion) {
if (!removeData) {
throw new IllegalArgumentException("removeData cannot be false");
}
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
final TableImpl table = getAndCheckTable(namespace, tableName);
/*
* If an non-owner drops a table and to remove the data, the
* DROP_INDEX privilege will also be checked if any index exists
* in the table.
*/
final List privsToCheck = new ArrayList<>();
if (!table.getIndexes().isEmpty()) {
privsToCheck.add(
new TablePrivilege.DropIndex(table.getId(), namespace));
}
privsToCheck.add(SystemPrivilege.DROP_ANY_TABLE);
checkPermission(aservice, new TableContext("Drop table",
table,
privsToCheck));
return admin.getPlanner().
createRemoveTablePlan(planName, namespace, tableName);
}
});
}
/**
* Pre-JSON_INDEX_VERSION
*/
@Override
@SecureInternalMethod
public int createAddIndexPlan(final String planName,
final String indexName,
final String tableName,
final String[] indexedFields,
final String description,
AuthContext authCtx,
short serialVersion) {
return createAddIndexPlan(planName,
null,
indexName,
tableName,
indexedFields,
null,
description,
authCtx,
serialVersion);
}
@Override
@SecureInternalMethod
public int createAddIndexPlan(final String planName,
final String namespace,
final String indexName,
final String tableName,
final String[] indexedFields,
final FieldDef.Type[] indexedTypes,
final String description,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
final TableImpl table = getAndCheckTable(namespace, tableName);
final TablePrivilege privToCheck =
new TablePrivilege.CreateIndex(table.getId(), namespace);
checkPermission(aservice, new TableContext("Create index",
table,
privToCheck));
return admin.getPlanner().
createAddIndexPlan(planName,
namespace,
indexName,
tableName,
indexedFields,
indexedTypes,
description);
}
});
}
@Override
@SecureInternalMethod
public int createRemoveIndexPlan(final String planName,
final String indexName,
final String tableName,
AuthContext authCtx,
short serialVersion) {
return createRemoveIndexPlan(planName, null, indexName, tableName,
authCtx, serialVersion);
}
@Override
@SecureInternalMethod
public int createRemoveIndexPlan(final String planName,
final String namespace,
final String indexName,
final String tableName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
final TableImpl table = getAndCheckTable(namespace, tableName);
final TablePrivilege privToCheck =
new TablePrivilege.DropIndex(table.getId(), namespace);
checkPermission(aservice, new TableContext("Drop index",
table,
privToCheck));
return admin.getPlanner().
createRemoveIndexPlan(planName, namespace, indexName,
tableName, false);
}
});
}
/*
* The pre-4.0 version (without TimeToLive argument).
*/
@Override
@SecureInternalMethod
public int createEvolveTablePlan(final String planName,
final String tableName,
final int tableVersion,
final FieldMap fieldMap,
AuthContext authCtx,
short serialVersion) {
return createEvolveTablePlan(planName, null, tableName, tableVersion,
fieldMap, null, authCtx, serialVersion);
}
@Override
@SecureInternalMethod
public int createEvolveTablePlan(final String planName,
final String tableName,
final int tableVersion,
final FieldMap fieldMap,
final TimeToLive ttl,
AuthContext authCtx,
short serialVersion) {
return createEvolveTablePlan(planName, null, tableName, tableVersion,
fieldMap, ttl, authCtx, serialVersion);
}
@Override
@SecureInternalMethod
public int createEvolveTablePlan(final String planName,
final String namespace,
final String tableName,
final int tableVersion,
final FieldMap fieldMap,
final TimeToLive ttl,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
final TableImpl table = getAndCheckTable(namespace, tableName);
final TablePrivilege privToCheck =
new TablePrivilege.EvolveTable(table.getId(), namespace);
checkPermission(aservice,
new TableContext("Evolve table",
table, privToCheck));
return admin.getPlanner().
createEvolveTablePlan(planName,
namespace,
tableName,
tableVersion,
fieldMap,
ttl);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createNetworkRestorePlan(final String planName,
final ResourceId sourceNode,
final ResourceId targetNode,
final boolean retainOrigLog,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createNetworkRestorePlan(
planName, sourceNode, targetNode, retainOrigLog);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createEnableRequestsPlan(final String planName,
final String requestType,
final Set resIds,
final boolean entireStore,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createEnableRequestsPlan(
planName, requestType, resIds, entireStore);
}
});
}
/**
* This is only used by table code, maybe change it to be table-specific.
*/
@Override
@SecureInternalMethod
public > T
getMetadata(final Class returnType,
final MetadataType metadataType,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public T execute() {
requireConfigured();
checkPermission(aservice,
new MetadataAccessContext(metadataType));
return admin.getMetadata(returnType, metadataType);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void putMetadata(final Metadata metadata,
AuthContext authCtx,
short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
admin.saveMetadata(metadata, (Plan)null);
MetadataType type = metadata.getType();
int planId = 0;
switch (type) {
case TABLE:
planId = admin.getPlanner().
createBroadcastTableMDPlan();
break;
case SECURITY:
planId = admin.getPlanner().
createBroadcastSecurityMDPlan();
break;
default:
throw new IllegalCommandException
("Invalid metadata type: " + type);
}
/*
* approve, execute, wait
*/
admin.approvePlan(planId);
admin.executePlan(planId, false);
admin.awaitPlan(planId, 0, null);
admin.assertSuccess(planId);
}
});
}
@Override
@SecureR2Method
public Topology getTopology(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public Topology getTopology(AuthContext authCtx,
final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Topology execute() {
requireConfigured();
/*
* Don't talk to pre-V11 client since they cannot recognize
* new topology introduced in V11.
*/
checkClientSupported(serialVersion, SerialVersion.V11);
return admin.getCurrentTopology();
}
});
}
@Override
@SecureR2Method
public Parameters getParameters(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public Parameters getParameters(AuthContext authCtx,
final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Parameters execute() {
requireConfigured();
return getCurrentParameters(serialVersion);
}
});
}
@Override
@SecureR2Method
public ParameterMap getRepNodeParameters(final RepNodeId rnid,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public ParameterMap getRepNodeParameters(final RepNodeId rnid,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public ParameterMap execute() {
requireConfigured();
final Parameters p = admin.getCurrentParameters();
if (p.get(rnid) != null) {
return p.get(rnid).getMap();
}
throw new IllegalCommandException
("RepNode does not exist: " + rnid);
}
});
}
@Override
@SecureR2Method
public ParameterMap getPolicyParameters(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public ParameterMap getPolicyParameters(AuthContext authCtx,
final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public ParameterMap execute() {
requireConfigured();
return getCurrentParameters(serialVersion).getPolicies();
}
});
}
@Override
@SecureR2Method
public void newParameters(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void newParameters(AuthContext authCtx, short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
/**
* Allow this call even if not configured. This call can be
* made as a side effect of a storage node being registered and
* especially in test environments it can be difficult to know
* the configured state.
*/
if (admin != null) {
admin.newParameters();
}
}
});
}
/* no R2-compatible version */
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void newGlobalParameters(AuthContext authCtx, short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
/**
* Allow this call even if not configured. This call can be
* made as a side effect of a storage node being registered and
* especially in test environments it can be difficult to know
* the configured state.
*/
if (admin != null) {
admin.newGlobalParameters();
}
}
});
}
/* no R2-compatible version */
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void newSecurityMDChange(AuthContext authCtx, short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
admin.newSecurityMDChange();
}
});
}
@Override
@SecureR2Method
public void configure(final String storeName, short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void configure(final String storeName,
AuthContext authCtx,
short serialVersion) {
aservice.getFaultHandler().execute
(new AdminServiceFaultHandler.SimpleCommandProc() {
@Override
protected void perform() {
if (admin != null) {
if (storeName.equals(aservice.getParams().
getGlobalParams().getKVStoreName())) {
return;
}
throw new IllegalCommandException(
"Store has been configured with a different name");
}
/* Not yet configured */
aservice.configure(storeName);
/* Admin should be non-null now */
admin = aservice.getAdmin();
}
@Override
protected RuntimeException getWrappedException(RuntimeException e) {
if (e instanceof IllegalStateException) {
return new CommandFaultException(
e.getMessage(), e, ErrorMessage.NOSQL_5400,
CommandResult.STORE_CLEANUP);
}
if (e instanceof DatabaseException) {
return new CommandFaultException(
e.getMessage(), e, ErrorMessage.NOSQL_5400,
CommandResult.STORE_CLEANUP);
}
return e;
}
});
}
@Override
@SecureR2Method
public String getStoreName(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public String getStoreName(AuthContext authCtx, short serialVersion) {
if (admin != null) {
return admin.getParams().getGlobalParams().getKVStoreName();
}
return null;
}
@Override
@SecureR2Method
public String getRootDir(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public String getRootDir(AuthContext authCtx, short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
if (admin != null) {
return admin.getParams().getStorageNodeParams().
getRootDirPath();
}
return null;
}
});
}
@Override
@SecureR2Method
public void stop(final boolean force, short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void stop(final boolean force,
AuthContext authCtx,
short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
aservice.stop(force);
}
});
}
/**
* Stop the remote test interface, if present. Called from
* AdminService.stop so that the test interface is stopped whenever the
* admin stops the command service.
*/
void stopRemoteTestInterface(Logger logger) {
if (rti != null) {
logger.info("Stopping remoteTestInterface");
try {
rti.stop(SerialVersion.CURRENT);
} catch (RemoteException e) {
logger.log(
Level.INFO,
"Ignore exception while stopping remoteTestInterface",
e);
}
}
}
@Override
@SecureR2Method
public void setPolicies(final ParameterMap policyMap,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void setPolicies(final ParameterMap policyMap,
AuthContext authCtx,
short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
admin.setPolicy(policyMap);
}
});
}
@Override
@SecureR2Method
public Map getStatusMap(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public Map getStatusMap(AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation
>() {
@Override
public Map execute() {
requireConfigured();
return admin.getMonitor().getServiceChangeTracker().getStatus();
}
});
}
@Override
@SecureR2Method
public Map getPerfMap(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public Map getPerfMap(AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().
execute(new ProcessFaultHandler.SimpleOperation
>() {
@Override
public Map execute() {
requireConfigured();
return admin.getMonitor().getPerfTracker().getPerf();
}
});
}
@Override
@SecureR2Method
public RetrievedEvents getStatusSince(final long since,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public RetrievedEvents getStatusSince(final long since,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().
execute(new ProcessFaultHandler.SimpleOperation
>() {
@Override
public RetrievedEvents execute() {
requireConfigured();
return admin.getMonitor().getServiceChangeTracker().
retrieveNewEvents(since);
}
});
}
@Override
@SecureR2Method
public RetrievedEvents getPerfSince(long since,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public RetrievedEvents getPerfSince(long since,
AuthContext authCtx,
short serialVersion) {
requireConfigured();
return admin.getMonitor().getPerfTracker().retrieveNewEvents(since);
}
@Override
@SecureR2Method
public RetrievedEvents getLogSince(long since,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public RetrievedEvents getLogSince(long since,
AuthContext authCtx,
short serialVersion) {
requireConfigured();
/*
* Don't talk to pre-V11 client since they cannot recognize
* arbiter logging event introduced in V11.
*/
checkClientSupported(serialVersion, SerialVersion.V11);
return admin.getMonitor().getLogTracker().retrieveNewEvents(since);
}
@Override
@SecureR2Method
public RetrievedEvents getPlanSince(long since,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public RetrievedEvents getPlanSince(long since,
AuthContext authCtx,
short serialVersion) {
requireConfigured();
return admin.getMonitor().getPlanStateChangeTracker().
retrieveNewEvents(since);
}
@Override
@SecureR2Method
public void registerLogTrackerListener(TrackerListener tl,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public void registerLogTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion) {
requireConfigured();
admin.getMonitor().getLogTracker().registerListener(tl);
}
@Override
@SecureR2Method
public void removeLogTrackerListener(TrackerListener tl,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public void removeLogTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion) {
requireConfigured();
admin.getMonitor().getLogTracker().removeListener(tl);
}
@Override
@SecureR2Method
public void registerStatusTrackerListener(TrackerListener tl,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public void registerStatusTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion) {
requireConfigured();
admin.getMonitor().getServiceChangeTracker().registerListener(tl);
}
@Override
@SecureR2Method
public void removeStatusTrackerListener(TrackerListener tl,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public void removeStatusTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion) {
requireConfigured();
admin.getMonitor().getServiceChangeTracker().removeListener(tl);
}
@Override
@SecureR2Method
public void registerPerfTrackerListener(TrackerListener tl,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public void registerPerfTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion) {
requireConfigured();
admin.getMonitor().getPerfTracker().registerListener(tl);
}
@Override
@SecureR2Method
public void removePerfTrackerListener(TrackerListener tl,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public void removePerfTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion) {
requireConfigured();
admin.getMonitor().getPerfTracker().removeListener(tl);
}
@Override
@SecureR2Method
public void registerPlanTrackerListener(TrackerListener tl,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public void registerPlanTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion) {
requireConfigured();
admin.getMonitor().getPlanStateChangeTracker().registerListener(tl);
}
@Override
@SecureR2Method
public void removePlanTrackerListener(TrackerListener tl,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public void removePlanTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion) {
requireConfigured();
admin.getMonitor().getPlanStateChangeTracker().removeListener(tl);
}
@Override
@SecureR2Method
public Map getLogFileNames(final short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public Map getLogFileNames(final AuthContext authCtx,
final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation>() {
@Override
public Map execute() {
requireConfigured();
final Map namesToTimes = new HashMap<>();
final File logDir = FileNames.getLoggingDir
(new File(getRootDir(authCtx, serialVersion)),
getStoreName(authCtx, serialVersion));
final File[] files = logDir.listFiles(new FilenameFilter() {
@Override
public boolean accept(File dir, String fname) {
return fname.endsWith(FileNames.LOG_FILE_SUFFIX) ||
fname.endsWith(FileNames.PERF_FILE_SUFFIX) ||
fname.endsWith(FileNames.STAT_FILE_SUFFIX) ||
fname.endsWith(FileNames.DETAIL_CSV) ||
fname.endsWith(FileNames.SUMMARY_CSV);
}
});
for (File f : files) {
final String name = f.getName();
final long modTime = f.lastModified();
namesToTimes.put(name, Long.valueOf(modTime));
}
return namesToTimes;
}
});
}
private void checkReady() {
if (!admin.isReady()) {
throw new AdminNotReadyException
("The Admin is not ready to serve this request. " +
"Please try again later");
}
}
private void requireConfigured() {
if (admin == null) {
throw new IllegalCommandException
("This command can't be used until the Admin is configured.",
ErrorMessage.NOSQL_5200,
CommandResult.NO_CLEANUP_JOBS);
}
checkReady();
}
/**
* Throws UnsupportedOperationException if client serialization version is
* earlier than required one.
*/
@Override
protected void checkClientSupported(short clientSerialVersion,
short requiredSerialVersion) {
try {
super.checkClientSupported(clientSerialVersion,
requiredSerialVersion);
} catch (UnsupportedOperationException e) {
throw new AdminFaultException(
e, e.getMessage(), ErrorMessage.NOSQL_5200,
CommandResult.NO_CLEANUP_JOBS);
}
}
/*
* Give current parameters based on client version filter.
* pre-V11 client does not support SpacialCharsParamter class.
* pre-V9 client does not support AuthMethodsParameter class.
*/
private Parameters getCurrentParameters(short serialVersion) {
final Parameters params = admin.getCurrentParameters();
if (serialVersion < SerialVersion.V11) {
params.getPolicies().remove(
ParameterState.SEC_PASSWORD_ALLOWED_SPECIAL);
}
if (serialVersion < SerialVersion.V9) {
params.getGlobalParams().getMap().remove(
ParameterState.GP_USER_EXTERNAL_AUTH);
}
return params;
}
@Override
@SecureR2Method
@Deprecated
public ReplicatedEnvironment.State getAdminState
(final short serialVersion) {
throw invalidR2MethodException();
}
@Override
/*
* Only USRVIEW is required here because we want to allow all authenticated
* users to be able to perform this operation, since it is required by
* every operation that uses the admin to figure out if the admin is
* running.
*/
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.USRVIEW})
@Deprecated
public ReplicatedEnvironment.State getAdminState
(AuthContext authCtx, final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.
SimpleOperation() {
@Override
public ReplicatedEnvironment.State execute() {
/*
* Don't talk to pre-V2 versions of the client.
*
* Note: This serial version check counts on getAdminState()
* always being the first RMI call from the client.
*/
checkClientSupported(serialVersion, SerialVersion.V2);
if (admin == null) {
return null; /* indicates unconfigured */
}
try {
return admin.getReplicationMode();
} catch (IllegalStateException iae) {
/* State cannot be queried if detached. */
return State.DETACHED;
}
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.USRVIEW })
public AdminStatus getAdminStatus(
AuthContext authCtx, final short serialVersion) {
return aservice.getFaultHandler().execute(
new ProcessFaultHandler.SimpleOperation() {
@Override
public AdminStatus execute() {
/*
* Say the admin is running if it is not configured, as
* done by ping
*/
if (admin == null) {
return new AdminStatus(ServiceStatus.RUNNING,
State.UNKNOWN,
false,
null);
}
return admin.getAdminStatus();
}
});
}
@Override
@SecureR2Method
public URI getMasterRmiAddress(short serialVersion) {
throw invalidR2MethodException();
}
@Override
/*
* Only USRVIEW is required here because we want to allow all authenticated
* users to be able to perform this operation, since it is required by
* every operation that needs to locate the master admin node.
*/
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.USRVIEW })
public URI getMasterRmiAddress(AuthContext authCtx, short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public URI execute() {
requireConfigured();
return admin.getMasterRmiAddress();
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.USRVIEW })
public URI getMasterWebServiceAddress(AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public URI execute() {
requireConfigured();
return admin.getMasterWebServiceAddress();
}
});
}
@Override
@SecureR2Method
public List getEvents(final long startTime,
final long endTime,
final CriticalEvent.EventType type,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public List getEvents(final long startTime,
final long endTime,
final CriticalEvent.EventType type,
AuthContext authCtx,
final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation>() {
@Override
public List execute() {
requireConfigured();
/*
* Don't talk to pre-V11 client since they cannot recognize
* new events introduced in V11.
*/
checkClientSupported(serialVersion, SerialVersion.V11);
return admin.getEvents(startTime, endTime, type);
}
});
}
@Override
@SecureR2Method
public CriticalEvent getOneEvent(final String eventId,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public CriticalEvent getOneEvent(final String eventId,
AuthContext authCtx,
final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public CriticalEvent execute() {
requireConfigured();
/*
* Don't talk to pre-V11 client since they cannot recognize
* new events introduced in V11.
*/
checkClientSupported(serialVersion, SerialVersion.V11);
return admin.getOneEvent(eventId);
}
});
}
@Override
@SecureR2Method
public String [] startBackup(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public String [] startBackup(AuthContext authCtx, short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String [] execute() {
requireConfigured();
final ReplicatedEnvironment env = admin.getEnv();
if (dbBackup != null) {
dbBackup.endBackup();
}
dbBackup = new DbBackup(env);
dbBackup.startBackup();
return dbBackup.getLogFilesInBackupSet();
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void verifyData(final boolean verifyBtree,
final boolean verifyLog,
final boolean verifyIndex,
final boolean verifyRecord,
final long btreeDelay,
final long logDelay,
AuthContext authCtx,
short serialVersion)
throws IOException {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.Procedure() {
@Override
public void execute() throws IOException {
requireConfigured();
admin.verifyData(verifyBtree, verifyLog, verifyIndex,
verifyRecord, btreeDelay, logDelay);
}
});
}
@Override
@SecureR2Method
public long stopBackup(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public long stopBackup(AuthContext authCtx, short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Long execute() {
requireConfigured();
long lastFile = -1;
if (dbBackup != null) {
lastFile = dbBackup.getLastFileInBackupSet();
dbBackup.endBackup();
dbBackup = null;
}
return lastFile;
}
});
}
@Override
@SecureR2Method
public void updateMemberHAAddress(final AdminId targetId,
final String targetHelperHosts,
final String newNodeHostPort,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public void updateMemberHAAddress(final AdminId targetId,
final String targetHelperHosts,
final String newNodeHostPort,
AuthContext authCtx,
short serialVersion) {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
aservice.updateMemberHAAddress(targetId,
targetHelperHosts,
newNodeHostPort);
}
});
}
@Override
@SecureR2Method
public VerifyResults verifyConfiguration(final boolean showProgress,
final boolean listAll,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
@Deprecated
public VerifyResults verifyConfiguration(final boolean showProgress,
final boolean listAll,
AuthContext authCtx,
short serialVersion) {
return verifyConfiguration(showProgress, listAll, false /* json */,
authCtx, serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public VerifyResults verifyConfiguration(final boolean showProgress,
final boolean listAll,
final boolean json,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public VerifyResults execute() {
requireConfigured();
final VerifyConfiguration checker =
new VerifyConfiguration(admin,
showProgress,
listAll,
json,
admin.getLogger());
checker.verifyTopology();
return checker.getResults();
}
});
}
@Override
@SecureR2Method
public VerifyResults verifyUpgrade(final KVVersion targetVersion,
final List snIds,
final boolean showProgress,
final boolean listAll,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
@Deprecated
public VerifyResults verifyUpgrade(final KVVersion targetVersion,
final List snIds,
final boolean showProgress,
final boolean listAll,
AuthContext authCtx,
short serialVersion) {
return verifyUpgrade(targetVersion, snIds, showProgress, listAll,
false /* json */, authCtx, serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public VerifyResults verifyUpgrade(final KVVersion targetVersion,
final List snIds,
final boolean showProgress,
final boolean listAll,
final boolean json,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public VerifyResults execute() {
requireConfigured();
final VerifyConfiguration checker =
new VerifyConfiguration(admin,
showProgress,
listAll,
json,
admin.getLogger());
checker.verifyUpgrade(targetVersion, snIds);
return checker.getResults();
}
});
}
@Override
@SecureR2Method
public VerifyResults verifyPrerequisite(final KVVersion targetVersion,
final KVVersion prerequisiteVersion,
final List snIds,
final boolean showProgress,
final boolean listAll,
final short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
@Deprecated
public VerifyResults verifyPrerequisite(final KVVersion targetVersion,
final KVVersion prerequisiteVersion,
final List snIds,
final boolean showProgress,
final boolean listAll,
AuthContext authCtx,
final short serialVersion) {
return verifyPrerequisite(targetVersion, prerequisiteVersion, snIds,
showProgress, listAll, false /* json */, authCtx, serialVersion);
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public VerifyResults verifyPrerequisite(final KVVersion targetVersion,
final KVVersion prerequisiteVersion,
final List snIds,
final boolean showProgress,
final boolean listAll,
final boolean json,
AuthContext authCtx,
final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public VerifyResults execute() {
requireConfigured();
final VerifyConfiguration checker =
new VerifyConfiguration(admin,
showProgress,
listAll,
json,
admin.getLogger());
checker.verifyPrerequisite(targetVersion,
prerequisiteVersion,
snIds);
return checker.getResults();
}
});
}
@Override
@SecureR2Method
public LoadParameters getParams(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public LoadParameters getParams(AuthContext authCtx, short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public LoadParameters execute() {
requireConfigured();
return admin.getAllParams();
}
});
}
@Override
@SecureR2Method
public String getStorewideLogName(short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public String getStorewideLogName(AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return admin.getStorewideLogName();
}
});
}
@Override
@SecureR2Method
public TopologyCandidate getTopologyCandidate(final String candidateName,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW})
public TopologyCandidate getTopologyCandidate(final String candidateName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public TopologyCandidate execute() {
requireConfigured();
return admin.getCandidate(candidateName);
}
});
}
@Override
@SecureR2Method
public List getTopologyHistory(final boolean concise,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public List getTopologyHistory(final boolean concise,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation>() {
@Override
public List execute() {
requireConfigured();
return admin.displayRealizedTopologies(concise);
}
});
}
@Override
@SecureR2Method
public SortedMap
getSchemaSummaries(final boolean includeDisabled,
final short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.DBVIEW })
public SortedMap
getSchemaSummaries(final boolean includeDisabled,
AuthContext authCtx,
final short serialVersion) {
requireConfigured();
return AvroDdl.execute
(aservice,
new AvroDdl.Command>() {
@Override
public SortedMap
execute(AvroDdl ddl) {
return ddl.getSchemaSummaries(includeDisabled);
}
});
}
@Override
@SecureR2Method
public AvroDdl.SchemaDetails getSchemaDetails(final int schemaId,
final short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.DBVIEW })
public AvroDdl.SchemaDetails getSchemaDetails(final int schemaId,
AuthContext authCtx,
final short serialVersion) {
requireConfigured();
return AvroDdl.execute(aservice,
new AvroDdl.Command() {
@Override
public AvroDdl.SchemaDetails execute(AvroDdl ddl) {
return ddl.getSchemaDetails(schemaId);
}
});
}
@Override
@SecureR2Method
public AvroDdl.AddSchemaResult
addSchema(final AvroSchemaMetadata metadata,
final String schemaText,
final AvroDdl.AddSchemaOptions options,
final short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSDBA })
public AvroDdl.AddSchemaResult
addSchema(final AvroSchemaMetadata metadata,
final String schemaText,
final AvroDdl.AddSchemaOptions options,
final AuthContext authCtx,
final short serialVersion) {
requireConfigured();
return AvroDdl.execute(aservice,
new AvroDdl.Command() {
@Override
public AvroDdl.AddSchemaResult execute(AvroDdl ddl) {
return ddl.addSchema(metadata,
schemaText,
options,
admin.getStoreVersion());
}
});
}
@Override
@SecureR2Method
public boolean updateSchemaStatus(final int schemaId,
final AvroSchemaMetadata newMeta,
final short serialVersion) {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSDBA })
public boolean updateSchemaStatus(final int schemaId,
final AvroSchemaMetadata newMeta,
final AuthContext authCtx,
final short serialVersion) {
requireConfigured();
return AvroDdl.execute(aservice, new AvroDdl.Command() {
@Override
public Boolean execute(AvroDdl ddl) {
return ddl.updateSchemaStatus(schemaId,
newMeta,
admin.getStoreVersion());
}
});
}
@Override
@SecureR2Method
public void assertSuccess(final int planId, short serialVersion)
throws RemoteException {
throw invalidR2MethodException();
}
@Override
@SecureInternalMethod
public void assertSuccess(final int planId,
final AuthContext authCtx,
short serialVersion)
throws RemoteException {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
requireConfigured();
final Plan plan = admin.getAndCheckPlan(planId);
checkPermission
(aservice,
new PlanAccessContext(plan, "Assert success"));
admin.assertSuccess(planId);
}
});
}
@Override
@SecureR2Method
public String getPlanStatus(final int planId,
final long options,
short serialVersion)
throws RemoteException {
throw invalidR2MethodException();
}
@Override
@Deprecated
@SecureInternalMethod
public String getPlanStatus(final int planId,
final long options,
final AuthContext authCtx,
short serialVersion)
throws RemoteException {
return getPlanStatus(planId, options, false, authCtx, serialVersion);
}
@Override
@SecureInternalMethod
public String getPlanStatus(final int planId,
final long options,
final boolean json,
final AuthContext authCtx,
short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
final Plan plan = admin.getAndCheckPlan(planId);
checkPermission
(aservice,
new PlanAccessContext(plan, "Get plan status"));
return admin.getPlanStatus(planId, options, json);
}
});
}
@Override
@SecureR2Method
public void installStatusReceiver(final AdminStatusReceiver asr,
short serialVersion)
throws RemoteException {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public void installStatusReceiver(final AdminStatusReceiver asr,
final AuthContext authCtx,
short serialVersion)
throws RemoteException {
aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleProcedure() {
@Override
public void execute() {
aservice.installStatusReceiver(asr);
}
});
}
@Override
@SecureR2Method
public String getUpgradeOrder(final KVVersion targetVersion,
final KVVersion prerequisiteVersion,
short serialVersion)
throws RemoteException {
throw invalidR2MethodException();
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public String getUpgradeOrder(final KVVersion targetVersion,
final KVVersion prerequisiteVersion,
final AuthContext authCtx,
short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public String execute() {
requireConfigured();
return UpgradeUtil.generateUpgradeList(admin,
targetVersion,
prerequisiteVersion);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public List>
getUpgradeOrderList(final KVVersion targetVersion,
final KVVersion prerequisiteVersion,
final AuthContext authCtx,
short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute(
new ProcessFaultHandler.
SimpleOperation>>() {
@Override
public List> execute() {
requireConfigured();
return UpgradeUtil.generateUpgradeOrderList(
admin, targetVersion, prerequisiteVersion);
}
});
}
@Override
@SecureR2Method
public int[] getPlanIdRange(final long startTime,
final long endTime,
final int howMany,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
/*
* Minimum required is USRVIEW for users to show plans created by them.
* SYSVIEW is required to show all other users' plan.
*/
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.USRVIEW })
public int[] getPlanIdRange(final long startTime,
final long endTime,
final int howMany,
AuthContext authCtx,
final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public int[] execute() {
requireConfigured();
final ExecutionContext currentCtx =
ExecutionContext.getCurrent();
if (currentCtx == null ||
currentCtx.hasPrivilege(SystemPrivilege.SYSVIEW)) {
return admin.getPlanIdRange(startTime, endTime, howMany,
null /* ownerId */);
}
return admin.getPlanIdRange(startTime, endTime, howMany,
getCurrentUserId());
}
});
}
@Override
@SecureR2Method
public Map getPlanRange(final int firstPlanId,
final int howMany,
short serialVersion) {
throw invalidR2MethodException();
}
@Override
/*
* Minimum required is USRVIEW for users to show plans created by them.
* SYSVIEW is required to show all other users' plan.
*/
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.USRVIEW })
public Map getPlanRange(final int firstPlanId,
final int howMany,
AuthContext authCtx,
final short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation>() {
@Override
public Map execute() {
requireConfigured();
/*
* Don't talk to pre-V11 client since they cannot recognize
* arbiter plans introduced in V11.
*/
checkClientSupported(serialVersion, SerialVersion.V11);
final ExecutionContext currentCtx =
ExecutionContext.getCurrent();
if (currentCtx == null ||
currentCtx.hasPrivilege(SystemPrivilege.SYSVIEW)) {
return admin.getPlanRange(firstPlanId, howMany,
null /* ownerId */);
}
return admin.getPlanRange(firstPlanId, howMany,
getCurrentUserId());
}
});
}
@Override
/*
* Minimum required is USRVIEW for a user to show its own information.
* SYSVIEW is required to show all other users' information.
*/
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.USRVIEW })
public Map
getUsersDescription(final AuthContext authCtx, short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute(
new ProcessFaultHandler.
SimpleOperation>() {
@Override
public Map execute() {
requireConfigured();
final SecurityMetadata md =
admin.getMetadata(SecurityMetadata.class,
MetadataType.SECURITY);
if (md == null) {
return null;
}
/*
* If security is not enabled, or current user has SYSVIEW
* privilege, returns all users' description.
*/
final ExecutionContext currentCtx =
ExecutionContext.getCurrent();
if (currentCtx == null ||
currentCtx.hasPrivilege(SystemPrivilege.SYSVIEW)) {
return md.getUsersDescription();
}
return md.getCurrentUserDescription();
}
});
}
/* no R2-compatible version */
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public boolean verifyUserPassword(final String userName,
final char[] password,
AuthContext authCtx,
short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Boolean execute() {
requireConfigured();
final SecurityMetadata md =
admin.getMetadata(SecurityMetadata.class,
MetadataType.SECURITY);
return md == null ?
false : md.verifyUserPassword(userName, password);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public SnapResult executeSnapshotOperation(final SnapshotOperation sop,
final StorageNodeId snid,
final ResourceId rid,
final String sname,
AuthContext authCtx,
short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute(
new ProcessFaultHandler.SimpleOperation() {
@Override
public SnapResult execute() {
requireConfigured();
return new SnapshotOperationProxy(admin).
executeSnapshotOp(sop, snid, rid, sname);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public SnapResultSummary
executeSnapshotOperation(final SnapshotOperation sop,
final String sname,
final DatacenterId dcId,
AuthContext authCtx,
short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute(
new ProcessFaultHandler.SimpleOperation() {
@Override
public SnapResultSummary execute() {
requireConfigured();
return new SnapshotOperationProxy(admin).
executeSnapshotTasks(sop, sname, dcId);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSVIEW })
public String[] listSnapshots(final StorageNodeId snid,
AuthContext authCtx,
short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute(
new ProcessFaultHandler.SimpleOperation() {
@Override
public String[] execute() {
requireConfigured();
return new SnapshotOperationProxy(admin).
listSnapshots(snid);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public Set repairAdminQuorum(final Set zoneIds,
final Set adminIds,
AuthContext authCtx,
short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute(
new ProcessFaultHandler.SimpleOperation>() {
@Override
public Set execute() {
requireConfigured();
return admin.repairAdminQuorum(zoneIds, adminIds);
}
});
}
/**
* Make sure that the schema id passed in for a table creation is a valid
* schema id in the system. If not found this call with throw
* IllegalCommandException.
*/
private void validateSchemaId(final int schemaId) {
getSchemaDetails(schemaId, (AuthContext) null, (short) 0);
}
/**
* Tries to identify current user. An IllegalCommandException will be
* thrown if failed.
*
* @return id of current user
*/
private static String getCurrentUserId() {
final KVStoreUserPrincipal currentUser =
KVStoreUserPrincipal.getCurrentUser();
if (currentUser == null) {
throw new IllegalCommandException(
"Cannot identify current user");
}
return currentUser.getUserId();
}
private TableImpl getAndCheckTable(String namespace, String tableName) {
final TableMetadata tableMd =
aservice.getAdmin().getMetadata(TableMetadata.class,
MetadataType.TABLE);
final TableImpl table = (tableMd == null) ? null :
tableMd.getTable(namespace, tableName);
if (table == null) {
throw new IllegalCommandException(
"Could not find table: " +
NameUtils.makeQualifiedName(namespace, tableName));
}
return table;
}
/**
* Provides an implementation of OperationContext for access checking when
* Metadata is requested.
*/
private static class MetadataAccessContext implements OperationContext {
private final MetadataType mdType;
private MetadataAccessContext(MetadataType type) {
this.mdType = type;
}
@Override
public String describe() {
return "Metadata request for type: " + mdType;
}
@Override
public List getRequiredPrivileges() {
/*
* Table Metadata requires DBVIEW authentication, others require
* INTLOPER
*/
if (mdType.equals(MetadataType.TABLE)) {
return SystemPrivilege.dbviewPrivList;
}
return SystemPrivilege.internalPrivList;
}
}
/**
* Creates a plan to inform the Store of the existence of an ES node, and
* stores it by its plan id.
*/
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createRegisterESClusterPlan(final String planName,
final String clusterName,
final String transportHp,
final boolean secure,
final boolean forceClear,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
if (admin.getParams().getSecurityParams() != null) {
if (admin.getParams().getSecurityParams().isSecure() ^
secure) {
throw new IllegalCommandException("Can not register" +
" ES Cluster." +
" Please Register secure ES on secure KV" +
" and non-secure ES on non-secure KV");
}
}
return admin.getPlanner().createRegisterESClusterPlan
(planName, clusterName, transportHp,secure, forceClear);
}
});
}
/**
* Creates a plan to cause the Store to forget about a registered ES
* cluster. Only one cluster may be registered, so no identifying
* information is needed.
*/
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createDeregisterESClusterPlan(final String planName,
AuthContext authCtx,
short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createDeregisterESClusterPlan
(planName);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createVerifyServicePlan(final String planName,
final ResourceId rid,
final boolean verifyBtree,
final boolean verifyLog,
final boolean verifyIndex,
final boolean verifyRecord,
final long btreeDelay,
final long logDelay,
AuthContext authCtx,
short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createVerifyServicePlan
(planName, rid, verifyBtree, verifyLog, verifyIndex,
verifyRecord, btreeDelay, logDelay);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createVerifyAllAdminsPlan(final String planName,
final DatacenterId dcid,
final boolean verifyBtree,
final boolean verifyLog,
final boolean verifyIndex,
final boolean verifyRecord,
final long btreeDelay,
final long logDelay,
AuthContext authCtx,
short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createVerifyAllAdminsPlan
(planName, dcid, verifyBtree, verifyLog, verifyIndex,
verifyRecord, btreeDelay, logDelay);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createVerifyAllRepNodesPlan(final String planName,
final DatacenterId dcid,
final boolean verifyBtree,
final boolean verifyLog,
final boolean verifyIndex,
final boolean verifyRecord,
final long btreeDelay,
final long logDelay,
AuthContext authCtx,
short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createVerifyAllRepNodesPlan
(planName, dcid, verifyBtree, verifyLog, verifyIndex,
verifyRecord, btreeDelay, logDelay);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createVerifyAllServicesPlan(final String planName,
final DatacenterId dcid,
final boolean verifyBtree,
final boolean verifyLog,
final boolean verifyIndex,
final boolean verifyRecord,
final long btreeDelay,
final long logDelay,
AuthContext authCtx,
short serialVersion)
throws RemoteException {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().createVerifyAllServicesPlan
(planName, dcid, verifyBtree, verifyLog, verifyIndex,
verifyRecord, btreeDelay, logDelay);
}
});
}
@Override
@SecureAutoMethod(privileges = { KVStorePrivilegeLabel.SYSOPER })
public int createTableLimitPlan(String planName,
String namespace,
String tableName,
TableLimits newLimits,
AuthContext NULL_CTX, short serialVersion) {
return aservice.getFaultHandler().execute
(new ProcessFaultHandler.SimpleOperation() {
@Override
public Integer execute() {
requireConfigured();
return admin.getPlanner().
createTableLimitPlan(planName,
namespace, tableName,
newLimits);
}
});
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy