oracle.kv.impl.admin.CommandService 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 java.io.IOException;
import java.net.URI;
import java.rmi.RemoteException;
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.LogRecord;
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.plan.Plan;
import oracle.kv.impl.admin.plan.PlanStateChange;
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.TableLimits;
import oracle.kv.impl.fault.OperationFaultException;
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.security.AuthContext;
import oracle.kv.impl.security.metadata.KVStoreUser.UserDescription;
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.registry.VersionedRemote;
import oracle.kv.table.FieldDef;
import oracle.kv.table.TimeToLive;
import com.sleepycat.je.rep.ReplicatedEnvironment;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* This is the interface used by the command line client.
*/
public interface CommandService extends VersionedRemote {
/**
* Returns the CommandService's status, which can only be RUNNNING.
*
* @since 3.0
*/
ServiceStatus ping(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
ServiceStatus ping(short serialVersion) throws RemoteException;
/* -- Topology related APIs -- */
/**
* Return a list of the names of all storage node pools.
*
* @since 3.0
*/
List getStorageNodePoolNames(AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
List getStorageNodePoolNames(short serialVersion)
throws RemoteException;
/**
* Add a new StorageNodePool.
*
* @since 3.0
*/
void addStorageNodePool(String name,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Clone an existing StorageNodePool as a new StorageNodePool.
*
* @since 4.0
*/
void cloneStorageNodePool(String name,
String source,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void addStorageNodePool(String name, short serialVersion)
throws RemoteException;
/**
* Remove a storage node pool.
*
* @since 3.0
*/
void removeStorageNodePool(String name,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void removeStorageNodePool(String name, short serialVersion)
throws RemoteException;
/**
* Get a list of the storage node ids in a pool.
*
* @since 3.0
*/
List getStorageNodePoolIds(String name,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
List getStorageNodePoolIds(String name, short serialVersion)
throws RemoteException;
/**
* Add a storage node to the pool with the given name.
*
* @since 3.0
*/
void addStorageNodeToPool(String name,
StorageNodeId snId,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void addStorageNodeToPool(String name,
StorageNodeId snId,
short serialVersion)
throws RemoteException;
/**
* Remove a storage node from the pool with the given name.
*
* @since 4.0
*/
void removeStorageNodeFromPool(String name,
StorageNodeId snId,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Replace the contents of a storage node pool.
*
* @since 3.0
*/
void replaceStorageNodePool(String name,
List ids,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void replaceStorageNodePool(String name,
List ids,
short serialVersion)
throws RemoteException;
/**
* Creates a named topology. The initial configuration will be based on the
* storage nodes specified by the snPoolName parameter. The
* number of partitions for a topology is fixed once the topology is
* created and cannot be changed. The command will throw TODO if there is
* not enough capacity in the specified snPoolName to satisfy
* the number of the replication nodes needed to create the topology.
*
* @throws IllegalCommandException if the name referenced by
* candidateName is already associated with a topology
*
* @since 3.5
*/
String createTopology(String candidateName,
String snPoolName,
int numPartitions,
boolean json,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Creates a named topology. The initial configuration will be based on the
* storage nodes specified by the snPoolName parameter. The
* number of partitions for a topology is fixed once the topology is
* created and cannot be changed. The command will throw
* IllegalCommandException if there is not enough capacity
* in the specified snPoolName to satisfy the number of the
* replication nodes needed to create the topology.
* @param candidateName name of the topology candidate
* @param snPoolName pool contain the storage nodes used to create
* topology
* @param numPartitions number of partitions for the topology
* @param json whether to return JSON style string
* @param jsonVersion version of JSON style string
* @param authCtx
* @param serialVersion
* @return string representing create topology result
* @throws RemoteException
* @since 18.1
*/
String createTopology(String candidateName,
String snPoolName,
int numPartitions,
boolean json,
short jsonVersion,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* TODO: Remove this overloading without JSON parameter after R3
* compatibility period.
*
* @deprecated
* @since 3.0
*/
@Deprecated
String createTopology(String candidateName,
String snPoolName,
int numPartitions,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String createTopology(String candidateName,
String snPoolName,
int numPartitions,
short serialVersion)
throws RemoteException;
/**
* Creates a copy of the current (deployed) topology and associates it with
* the candidateName parameter. Changes to the copy will have
* no effect on the current topology.
*
* @throws IllegalCommandException is @param candidateName is already
* associated with a topology
*
* @since 3.0
*/
String copyCurrentTopology(String candidateName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String copyCurrentTopology(String candidateName,
short serialVersion)
throws RemoteException;
/**
* Returns the list of named topologies. If no named topologies exist an
* empty list is returned.
*
* @since 3.0
*/
List listTopologies(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
List listTopologies(short serialVersion) throws RemoteException;
/**
* Delete a named topology. Removing a topology that was used to create a
* plan will not affect the plan. If @param candidateName is not associated
* with a topology, this method does nothing.
*
* @since 3.0
*/
String deleteTopology(String candidateName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String deleteTopology(String candidateName, short serialVersion)
throws RemoteException;
/**
* Re-balances the replication nodes of a data center or store. The set of
* replication nodes in the topology having the name referenced by the
* candidateName parameter will be re-balanced across the
* storage nodes specified by the snPoolName parameter. Both
* the replication factor and the number of shards is not changed. If the
* value input for the dcId parameter is not
* null, the re-balance will only be done to nodes in that
* data center, otherwise the re-balance will be for all nodes in the
* store. The method will fail if there is not enough capacity in the
* specified pool to satisfy the number of the replication nodes needed to
* implement the change.
*
* @throws IllegalCommandException if the name referenced by
* candidateName is not associated with a topology.
*
* @since 3.0
*/
String rebalanceTopology(String candidateName,
String snPoolName,
DatacenterId dcId,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String rebalanceTopology(String candidateName, String snPoolName,
DatacenterId dcId, short serialVersion)
throws RemoteException;
/**
* Changes the replication factor of a data center and adds or removes
* replication nodes in the topology having the name referenced by the
* candidateName parameter. The data center's replication
* factor is changed and new replication nodes are added and re-balanced
* across the storage nodes specified by the snPoolName
* parameter. The number of shards is not changed. The method will fail if
* there is not enough capacity in the pool referenced by
* snPoolName to satisfy the number of the replication nodes
* needed to implement the change, or the rep-factor is smaller then the
* current data center's replication factor. If the current replication
* factor and rep-factor are equal this method will do nothing.
*
* @throws IllegalCommandException if the name referenced by
* candidateName is not associated with a topology.
*
* @since 3.0
*/
String changeRepFactor(String candidateName, String snPoolName,
DatacenterId dcId, int repFactor,
AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String changeRepFactor(String candidateName, String snPoolName,
DatacenterId dcId, int repFactor,
short serialVersion)
throws RemoteException;
/**
* Changes the type of the specified data center.
*
* @since 3.4
*/
String changeZoneType(String candidateName, DatacenterId dcId,
DatacenterType type,
AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* Changes master affinity.
*
* @since 18.1
*/
String changeZoneMasterAffinity(String candidateName, DatacenterId dcId,
boolean masterAffinity,
AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* Changes the allow arbiter attribute of the specified data center.
*
* @since 4.0
*/
String changeZoneArbiters(String candidateName, DatacenterId dcId,
boolean allowArbiters,
AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* Redistributes partitions in the topology having the name referenced by
* the candidateName parameter. The number of shards will be
* recalculated and new replication nodes will be added as needed. The new
* replication nodes will be assigned to the storage nodes specified by the
* snPoolName parameter. Partitions from existing shards will
* be re-assigned to the new shards. The method will fail if there is not
* enough capacity in the pool referenced by snPoolName to
* satisfy the number of the replication nodes needed to implement the
* change.
*
* @throws IllegalCommandException if the name referenced by
* candidateName is not associated with a topology.
*
* @since 3.0
*/
String redistributeTopology(String candidateName,
String snPoolName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String redistributeTopology(String candidateName,
String snPoolName,
short serialVersion)
throws RemoteException;
/**
* Contracts storage nodes in the topology having the name referenced by
* the candidateName parameter. The number of shards will be
* recalculated and replication nodes will be removed as needed. The to be
* removed replication nodes will be from the storage nodes not specified by
* the snPoolName parameter.
*
* @throws IllegalCommandException if the name referenced by
* candidateName is not associated with a topology.
*
* @since 4.0
*/
String contractTopology(String candidateName,
String snPoolName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Removes a shard from the topology specified by the
* candidateName parameter by removing the failed shard
* referenced by the failedShard parameter. The final number
* of shards will be one less and replication nodes will be removed from
* failed shard.
*
* @throws IllegalCommandException if the name referenced by
* candidateName is not associated with a topology.
*
* @since 18.1
*/
String removeFailedShard(RepGroupId failedShard,
String candidateName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Displays the steps necessary to migrate one topology to another. If
* @param startTopoName is not {@code null} then that topology is used as
* the starting point otherwise the deployed store's topology is used.
*
* @throws IllegalCommandException is {@code targetTopoName} or
* {@code startTopoName} are not associated with a topology
*
* @since 3.0
*/
String preview(String targetTopoName, String startTopoName,
boolean verbose, AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* Displays the steps necessary to migrate one topology to another.
*
* @param targetTopoName name of the topology to be changed to
* @param startTopoName is not {@code null} then that topology is used as
* the starting point otherwise the deployed store's topology is used.
* @param verbose whether to display verbose output
* @param jsonVersion specify which version of JSON string to display the
* return result
* @param authCtx
* @param serialVersion
* @throws RemoteException
* @since 18.1
*/
String preview(String targetTopoName, String startTopoName,
boolean verbose, short jsonVersion,
AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String preview(String targetTopoName, String startTopoName,
boolean verbose, short serialVersion)
throws RemoteException;
/* -- Plan APIs -- */
/**
* Get a list of the Admins and their parameters.
*
* @since 3.0
*/
List getAdmins(AuthContext authCtx, short serialVersion) throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
List getAdmins(short serialVersion) throws RemoteException;
/**
* Get the specified plan.
*
* @since 3.0
*/
Plan getPlanById(int planId,
AuthContext authCtx,
short serialVersion) throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
Plan getPlanById(int planId, short serialVersion) throws RemoteException;
/**
* Return the map of all plans.
*
* @since 3.0
* @deprecated in favor of getPlanRange.
*/
@Deprecated
Map getPlans(AuthContext authCtx,
short serialVersion) throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
Map getPlans(short serialVersion) throws RemoteException;
/**
* Approve the identified plan.
*
* @since 3.0
*/
void approvePlan(int planId, AuthContext authCtx,
short serialVersion) throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void approvePlan(int planId, short serialVersion) throws RemoteException;
/**
* Execute the identified plan. Returns when plan execution is finished.
* @param force if true, ignor
*
* @since 3.0
*/
void executePlan(int planId, boolean force,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void executePlan(int planId, boolean force, short serialVersion)
throws RemoteException;
/**
* 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.
*
* @since 3.0
*/
Plan.State awaitPlan(int planId,
int timeout,
TimeUnit timeUnit,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
Plan.State awaitPlan(int planId, int timeout,
TimeUnit timeUnit, short serialVersion)
throws RemoteException;
/**
* Cancel a plan.
*
* @since 3.0
*/
void cancelPlan(int planId,
AuthContext authCtx,
short serialVersion) throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void cancelPlan(int planId, short serialVersion) throws RemoteException;
/**
* Interrupt a plan.
*
* @since 3.0
*/
void interruptPlan(int planId,
AuthContext authCtx,
short serialVersion) throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void interruptPlan(int planId, short serialVersion) throws RemoteException;
/**
* To be removed after R3 compatibility period.
*
* @since 3.0
*/
@Deprecated
void retryPlan(int planId,
AuthContext authCtx,
short serialVersion) throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void retryPlan(int planId, short serialVersion) throws RemoteException;
/**
* Create and run Plans for initial configuration of a node. This creates,
* approves and executes plans to deploy a data center, storage node, and
* admin all in one call. Because all of the necessary information is in
* the admin this relieves the client of the burden of collection.
*
*
* @since 3.0
*/
void createAndExecuteConfigurationPlan(String kvsName,
String dcName,
int repFactor,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void createAndExecuteConfigurationPlan(String kvsName,
String dcName,
int repFactor,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to deploy a new PRIMARY Datacenter.
* Note that datacenterComment is unused, and is deprecated as of R2. This
* command is only used by R2 and earlier clients.
*
* @since 3.0
*/
int createDeployDatacenterPlan(String planName,
String datacenterName,
int repFactor,
String datacenterComment,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createDeployDatacenterPlan(String planName,
String datacenterName,
int repFactor,
String datacenterComment,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to deploy a new Datacenter with the specified type.
* This command is used by R3.0 to R3.5 clients.
* @deprecated
* @since 3.0
*/
@Deprecated
int createDeployDatacenterPlan(String planName,
String datacenterName,
int repFactor,
DatacenterType datacenterType,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to deploy a new Datacenter with the specified type and
* whether to allow arbiters.
* This command is used by R4.0 or later clients. This command should be
* removed after R4 compatibility period.
*
* @since 4.0
*/
@Deprecated
int createDeployDatacenterPlan(String planName,
String datacenterName,
int repFactor,
DatacenterType datacenterType,
boolean allowArbiters,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to deploy a new Datacenter with the specified type and
* whether to allow arbiters.
* This command is used by R18.1 or later clients.
*
* @since 18.1
*/
int createDeployDatacenterPlan(String planName,
String datacenterName,
int repFactor,
DatacenterType datacenterType,
boolean allowArbiters,
boolean masterAffinity,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createDeployDatacenterPlan(String planName,
String datacenterName,
int repFactor,
DatacenterType datacenterType,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to deploy a new StorageNode.
*
* @since 3.0
*/
int createDeploySNPlan(String planName,
DatacenterId datacenterId,
String hostName,
int registryPort,
String comment,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createDeploySNPlan(String planName,
DatacenterId datacenterId,
String hostName,
int registryPort,
String comment,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to deploy a new Admin service instance of the specified
* type. If type is null the Admin service will get its type from the
* containing zone.
*
* @since 3.3
*/
int createDeployAdminPlan(String planName,
StorageNodeId snid,
int httpPort,
AdminType type,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to deploy a new Admin service instance.
*
* @since 3.0
*/
@Deprecated
int createDeployAdminPlan(String planName,
StorageNodeId snid,
int httpPort,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createDeployAdminPlan(String planName,
StorageNodeId snid,
int httpPort,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to remove the specified Admin (if aid is
* non-null and dcid is null), or
* all Admins deployed to the specified datacenter (if dcid is
* non-null and aid is null).
*
* @param planName the name to assign to the created Plan
*
* @param dcid the id of the datacenter containing the Admins to remove.
* If this parameter and the aid parameter are both
* non-null or both null, then an
* IllegalArgumentException is thrown.
*
* @param aid the id of the specific Admin to remove. If this parameter
* and the dcid parameter are both non-null or
* both null, then an IllegalArgumentException
* is thrown.
*
* @param failedSN if true, remove admin hosted on a failed SN
*
* @throws IllegalArgumentException if the dcid parameter and
* the aid parameter are both non-null or both
* null.
*
* @since 18.1
*/
int createRemoveAdminPlan(String planName,
DatacenterId dcid,
AdminId aid,
boolean failedSN,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* TODO: Remove this overloading without failedSN parameter
* after R3 compatibility period.
*
* @deprecated
* @since 3.0
*/
@Deprecated
int createRemoveAdminPlan(String planName,
DatacenterId dcid,
AdminId aid,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createRemoveAdminPlan(String planName,
DatacenterId dcid,
AdminId aid,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to deploy a topology.
*
*/
int createDeployTopologyPlan(String planName,
String candidateName,
RepGroupId failedShard,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* TODO: Remove this overloading without failedShard parameter
* after R3 compatibility period.
*
* @deprecated
* @since 3.0
*/
@Deprecated
int createDeployTopologyPlan(String planName,
String candidateName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createDeployTopologyPlan(String planName,
String candidateName,
short serialVersion)
throws RemoteException;
/**
* Create a new plan that performs a failover.
*
* @since 3.4
*/
int createFailoverPlan(String planName,
Set newPrimaryZones,
Set offlineZones,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to shut down the repnodes in a kvstore.
*
* @since 3.0
*/
int createStopAllRepNodesPlan(String planName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createStopAllRepNodesPlan(String planName, short serialVersion)
throws RemoteException;
/**
* Create a new Plan to start up the repnodes in a kvstore.
*
* @since 3.0
*/
int createStartAllRepNodesPlan(String planName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createStartAllRepNodesPlan(String planName, short serialVersion)
throws RemoteException;
/**
* Stop a given set of RepNodes. Can be removed when
* KVVersion.PREREQUISITE_VERSION is greater than or equal to
* KVVersion.R3_4.
*
* @since 3.0
*/
@Deprecated
int createStopRepNodesPlan(String planName,
Set rnids,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createStopRepNodesPlan(String planName,
Set rnids,
short serialVersion)
throws RemoteException;
/**
* Start a given set of RepNodes. Can be removed when
* KVVersion.PREREQUISITE_VERSION is greater than or equal to
* KVVersion.R3_4.
*
* @since 3.0
*/
@Deprecated
int createStartRepNodesPlan(String planName,
Set rnids,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createStartRepNodesPlan(String planName,
Set rnids,
short serialVersion)
throws RemoteException;
/**
* Stop a set of services.
*
* @since 3.4
*/
int createStopServicesPlan(String planName,
Set serviceIds,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Start a set of services.
*
* @since 3.4
*/
int createStartServicesPlan(String planName,
Set serviceIds,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to alter a service's parameters.
*
* @since 3.0
*/
int createChangeParamsPlan(String planName,
ResourceId rid,
ParameterMap newParams,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createChangeParamsPlan(String planName,
ResourceId rid,
ParameterMap newParams,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to alter parameters for all RepNodes deployed to the
* specified datacenter. If null is input for the
* dcid parameter, then the specified parameters will be
* changed for all RepNodes from each of the datacenters making up the
* store.
*
* @since 3.0
*/
int createChangeAllParamsPlan(String planName,
DatacenterId dcid,
ParameterMap newParams,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createChangeAllParamsPlan(String planName,
DatacenterId dcid,
ParameterMap newParams,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to alter parameters for all ArbNodes deployed to the
* specified datacenter. If null is input for the
* dcid parameter, then the specified parameters will be
* changed for all ArbNodes from each of the datacenters making up the
* store.
*
* @since 4.0
*/
int createChangeAllANParamsPlan(String planName,
DatacenterId dcid,
ParameterMap newParams,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to alter parameters for all admin services deployed to
* the specified datacenter. If null is input for the
* dcid parameter, then the specified parameters will be
* changed for all admin services from each of the datacenters making up
* the store.
*
* @since 3.0
*/
int createChangeAllAdminsPlan(String planName,
DatacenterId dcid,
ParameterMap newParams,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createChangeAllAdminsPlan(String planName,
DatacenterId dcid,
ParameterMap newParams,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to alter parameters for global scoped, non-security
* parameters. The specified parameters will be changed for all
* SN-managed components in the store.
*
* @since 4.3
*/
int createChangeGlobalComponentsParamsPlan(String planName,
ParameterMap newParams,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to alter parameters for global security parameters.
* The specified parameters will be changed for all admin and repnode
* services from storage nodes in the store.
*
* @since 3.0
*/
int createChangeGlobalSecurityParamsPlan(String planName,
ParameterMap newParams,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to change a user's information.
*
* @since 3.0
*/
int createChangeUserPlan(String planName,
String userName,
Boolean isEnabled,
char[] newPlainPassword,
boolean retainPassword,
boolean clearRetainedPassword,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to add a user of kvstore.
*
* @since 3.0
*/
int createCreateUserPlan(String planName,
String userName,
boolean isEnabled,
boolean isAdmin,
char[] plainPassword,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to remove a user of kvstore.
*
* @since 3.0
*/
int createDropUserPlan(String planName,
String userName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to grant roles to user in KVStore.
*
* @since 3.1
*/
int createGrantPlan(String planName,
String grantee,
Set roles,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to revoke roles from user in KVStore.
*
* @since 3.1
*/
int createRevokePlan(String planName,
String target,
Set roles,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to move all services from the old storage node to a
* new storage node.
*
* @since 3.0
*/
int createMigrateSNPlan(String planName,
StorageNodeId oldNode,
StorageNodeId newNode,
int newHttpPort,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createMigrateSNPlan(String planName,
StorageNodeId oldNode,
StorageNodeId newNode,
int newHttpPort,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to remove a storage node from the store.
*
* @since 3.0
*/
int createRemoveSNPlan(String planName,
StorageNodeId targetNode,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createRemoveSNPlan(String planName,
StorageNodeId targetNode,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to remove a datacenter from the store.
*
* @since 3.0
*/
int createRemoveDatacenterPlan(String planName,
DatacenterId targetId,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
int createRemoveDatacenterPlan(String planName,
DatacenterId targetId,
short serialVersion)
throws RemoteException;
/**
* Create a plan that will address topology inconsistencies.
*/
int createRepairPlan(String planName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after 3.5 compatibility period.
*/
@Deprecated
public int createAddTablePlan(String planName,
String tableName,
String parentName,
FieldMap fieldMap,
List primaryKey,
List majorKey,
boolean r2compat,
int schemaId,
String description,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* @since 4.0
*/
@Deprecated
public int createAddTablePlan(String planName,
String tableName,
String parentName,
FieldMap fieldMap,
List primaryKey,
List primaryKeySizes,
List majorKey,
TimeToLive ttl,
boolean r2compat,
int schemaId,
String description,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a new Plan to create a new Table in the store.
*
* @param planName the name of the plan
* @param namespace namespace for the new table. This is optional.
* @param tableName the id of the new table. This is used in its generated
* Key objects so it should be short to save space in the store.
* @param parentName set to a qualified ("." separated) path to a parent
* table if the new table is a child table, null otherwise.
* @param fieldMap an object that represents the map of {@link FieldDef}
* objects that comprises the table, along with the field declaration
* order.
* @param primaryKey the list of fields that comprise the primary key for
* this table. It must contain at least one field. For child tables it is
* a superset of its parent table's primary key. Primary key fields turn
* into Keys in requests.
* @param majorKey the list of primary key fields that comprise the major
* portion of generated Key objects for the table. This must be strict,
* ordered subset of the primaryKey if set. It is only used for top-level
* tables. For child tables the major/minor split is either that of
* the parent table or the boundary between the parent and child table
* primary keys. The Key components generated by a child table are
* implicitly minor-only.
* @param ttl default Time-to-Live duration for the new table.
* Time-To_live for child tables are independent of their parent table.
* @param limits table resource limits, or null. Limits can only be set on
* top-level tables.
* @param description an option description of the table, used for
* human-readable purposes. This string does not affect table records.
*/
/**
* @since 18.1
*/
public int createAddTablePlan(String planName,
String namespace,
String tableName,
String parentName,
FieldMap fieldMap,
List primaryKey,
List primaryKeySizes,
List majorKey,
TimeToLive ttl,
TableLimits limits,
boolean r2compat,
int schemaId,
String description,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* @since 4.4
*/
public int createAddTablePlan(String planName,
String namespace,
String tableName,
String parentName,
FieldMap fieldMap,
List primaryKey,
List primaryKeySizes,
List majorKey,
TimeToLive ttl,
boolean r2compat,
int schemaId,
String description,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* As of 18.1 removeData == false is not supported. A false value will
* throw an IllegalArgumentException.
*
* pre-4.4
*/
@Deprecated
public int createRemoveTablePlan(String planName,
String tableName,
boolean removeData,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* As of 18.1 removeData == false is not supported. A false value will
* throw an IllegalArgumentException.
*
* @since 4.4
*/
public int createRemoveTablePlan(String planName,
String namespace,
String tableName,
boolean removeData,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Deprecated in favor of version that takes an array of types, as of
* release 4.4.
*/
@Deprecated
public int createAddIndexPlan(String planName,
String indexName,
String tableName,
String[] indexedFields,
String description,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* @since 4.4
*/
public int createAddIndexPlan(String planName,
String namespace,
String indexName,
String tableName,
String[] indexedFields,
FieldDef.Type[] indexedTypes,
String description,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* pre-4.4
*/
@Deprecated
public int createRemoveIndexPlan(String planName,
String indexName,
String tableName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* @since 4.4
*/
public int createRemoveIndexPlan(String planName,
String namespace,
String indexName,
String tableName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Deprecated in favor of overloaded method accepting a {@link TimeToLive}
* argument.
* Can be removed after 3.5 compatibility period.
*/
@Deprecated
public int createEvolveTablePlan(String planName,
String tableName,
int tableVersion,
FieldMap fieldMap,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* pre-4.4
*/
public int createEvolveTablePlan(String planName,
String tableName,
int tableVersion,
FieldMap fieldMap,
TimeToLive ttl,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* @since 4.4
*/
public int createEvolveTablePlan(String planName,
String namespace,
String tableName,
int tableVersion,
FieldMap fieldMap,
TimeToLive ttl,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Creates a new plan to perform network restore from source node to target
* node.
*
* @since 4.4
*/
public int createNetworkRestorePlan(String planName,
ResourceId sourceNode,
ResourceId targetNode,
boolean retainOrigLog,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Creates a new plan to enable request type on shards or entire store.
*
* @since 18.1
*/
public int createEnableRequestsPlan(String planName,
String requestType,
Set resIds,
boolean entireStore,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Configure the Admin with a store name. This command can be used only
* when the AdminService is running in bootstrap/configuration mode.
*
* @since 3.0
*/
void configure(String storeName, AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void configure(String storeName, short serialVersion)
throws RemoteException;
/**
* If configured, return the store name, otherwise, null.
*
* @since 3.0
*/
String getStoreName(AuthContext authCtx,
short serialVersion) throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String getStoreName(short serialVersion) throws RemoteException;
/**
* Return the pathname of the KV root directory (KVHOME).
*
* @since 3.0
*/
String getRootDir(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String getRootDir(short serialVersion) throws RemoteException;
/**
* Return the whole Topology for listing or browsing.
*
* @since 3.0
*/
Topology getTopology(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
Topology getTopology(short serialVersion) throws RemoteException;
/**
* Return the specified Metadata for listing or browsing.
*/
@Nullable
> T
getMetadata(final Class returnType,
final MetadataType metadataType,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Saves the specified Metadata
*/
void putMetadata(final Metadata metadata,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Retrieve the topology that corresponds to this candidate name. Invoked
* with the "topology view candidateName" command.
*
* @since 3.0
*/
TopologyCandidate getTopologyCandidate(String candidateName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
TopologyCandidate getTopologyCandidate(String candidateName,
short serialVersion)
throws RemoteException;
/**
* Return the whole Parameters for listing or browsing.
*
* @since 3.0
*/
Parameters getParameters(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
Parameters getParameters(short serialVersion) throws RemoteException;
/**
* Return the RepNodeParameters for the specified node.
*
* @since 3.0
*/
ParameterMap getRepNodeParameters(RepNodeId id,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
ParameterMap getRepNodeParameters(RepNodeId id, short serialVersion)
throws RemoteException;
/**
* Return the Policy parameters from the admin.
*
* @since 3.0
*/
ParameterMap getPolicyParameters(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
ParameterMap getPolicyParameters(short serialVersion)
throws RemoteException;
/**
* Indicates that new parameters are available in the storage node
* configuration file and that these should be reread.
*
* @since 3.0
*/
void newParameters(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void newParameters(short serialVersion) throws RemoteException;
/**
* Indicates that new global parameters are available in the storage node
* configuration file and that these should be reread.
*
* @since 3.0
*/
public void newGlobalParameters(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* Indicates that new security metadata change need to be applied.
*
* @since 3.2
*/
void newSecurityMDChange(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* Stop the admin service.
*
* @since 3.0
*/
void stop(boolean force, AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void stop(boolean force, short serialVersion) throws RemoteException;
/**
* Set the policy parameters.
*
* @since 3.0
*/
void setPolicies(ParameterMap policyParams,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void setPolicies(ParameterMap policyParams, short serialVersion)
throws RemoteException;
/**
* Return the current health status for each component.
*
* @since 3.0
*/
Map getStatusMap(AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
Map getStatusMap(short serialVersion)
throws RemoteException;
/**
* Return the current performance status for each component.
*
* @since 3.0
*/
Map getPerfMap(AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
Map getPerfMap(short serialVersion)
throws RemoteException;
/**
* Return the status reporting events that have occurred since a point in
* time.
*
* @since 3.0
*/
RetrievedEvents getStatusSince(long since,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
RetrievedEvents getStatusSince(long since,
short serialVersion)
throws RemoteException;
/**
* Return the performance reporting events that have occurred since a point
* in time.
*
* @since 3.0
*/
RetrievedEvents getPerfSince(long since,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
RetrievedEvents getPerfSince(long since, short serialVersion)
throws RemoteException;
/**
* Return the log records that have been logged since a point in time.
*
* @since 3.0
*/
RetrievedEvents getLogSince(long since,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
RetrievedEvents getLogSince(long since, short serialVersion)
throws RemoteException;
/**
* Return the plan state change events that have occured since a point in
* time.
*
* @since 3.0
*/
RetrievedEvents getPlanSince(long since,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
RetrievedEvents getPlanSince(long since,
short serialVersion)
throws RemoteException;
/**
* Register a log tracker listener.
*
* @since 3.0
*/
void registerLogTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void registerLogTrackerListener(TrackerListener tl, short serialVersion)
throws RemoteException;
/**
* Remove the registration of a log tracker listener.
*
* @since 3.0
*/
void removeLogTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void removeLogTrackerListener(TrackerListener tl, short serialVersion)
throws RemoteException;
/**
* Register a status tracker listener.
*
* @since 3.0
*/
void registerStatusTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void registerStatusTrackerListener(TrackerListener tl, short serialVersion)
throws RemoteException;
/**
* Remove the registration of a status tracker listener.
*
* @since 3.0
*/
void removeStatusTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void removeStatusTrackerListener(TrackerListener tl, short serialVersion)
throws RemoteException;
/**
* Register a perf tracker listener.
*
* @since 3.0
*/
void registerPerfTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void registerPerfTrackerListener(TrackerListener tl, short serialVersion)
throws RemoteException;
/**
* Remove the registration of a perf tracker listener.
*
* @since 3.0
*/
void removePerfTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void removePerfTrackerListener(TrackerListener tl, short serialVersion)
throws RemoteException;
/**
* Register a plan tracker listener.
*
* @since 3.0
*/
void registerPlanTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void registerPlanTrackerListener(TrackerListener tl, short serialVersion)
throws RemoteException;
/**
* Remove the registration of a plan tracker listener.
*
* @since 3.0
*/
void removePlanTrackerListener(TrackerListener tl,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void removePlanTrackerListener(TrackerListener tl, short serialVersion)
throws RemoteException;
/**
* Get a map of log file names.
*
* @since 3.0
*/
Map getLogFileNames(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
Map getLogFileNames(short serialVersion)
throws RemoteException;
/**
* Get the Admin state.
*
* @since 3.0
* @see #getAdminStatus
* @deprecated
*/
@Deprecated
ReplicatedEnvironment.State getAdminState(AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
ReplicatedEnvironment.State getAdminState(short serialVersion)
throws RemoteException;
/**
* Get the Admin service status.
*
* @since 3.4
*/
AdminStatus getAdminStatus(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* Get the master Admin's RMI address.
*
* @since 3.0
*/
URI getMasterRmiAddress(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* Get the master Admin's web service address.
*/
URI getMasterWebServiceAddress(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
URI getMasterRmiAddress(short serialVersion) throws RemoteException;
/**
* Get a list of critical events.
*
* @since 3.0
*/
List getEvents(long startTime, long endTime,
CriticalEvent.EventType type,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
List getEvents(long startTime, long endTime,
CriticalEvent.EventType type,
short serialVersion)
throws RemoteException;
/**
* Get a single critical event.
*
* @since 3.0
*/
CriticalEvent getOneEvent(String eventId,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
CriticalEvent getOneEvent(String eventId, short serialVersion)
throws RemoteException;
/**
* Start a backup.
*
* @since 3.0
*/
String[] startBackup(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String[] startBackup(short serialVersion) throws RemoteException;
/**
* Stop a backup.
*
* @since 3.0
*/
long stopBackup(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
long stopBackup(short serialVersion) throws RemoteException;
/**
* Update the HA address for an admin member.
*
* @since 3.0
*/
void updateMemberHAAddress(AdminId targetId,
String targetHelperHosts,
String newNodeHostPort,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void updateMemberHAAddress(AdminId targetId,
String targetHelperHosts,
String newNodeHostPort,
short serialVersion)
throws RemoteException;
/**
* Verify store configuration.
*
* @since 3.3
*/
VerifyResults verifyConfiguration(boolean showProgress,
boolean listAll,
boolean json,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* TODO: Remove this overloading without JSON parameter after R3
* compatibility period.
*
* @deprecated
* @since 3.0
*/
@Deprecated
VerifyResults verifyConfiguration(boolean showProgress,
boolean listAll,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
VerifyResults verifyConfiguration(boolean showProgress,
boolean listAll,
short serialVersion)
throws RemoteException;
/**
* Verify upgrade state.
*
* @since 3.5
*/
VerifyResults verifyUpgrade(KVVersion targetVersion,
List snIds,
boolean showProgress,
boolean listAll,
boolean json,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* TODO: Remove this overloading without JSON parameter after R3
* compatibility period.
*
* @deprecated
* @since 3.0
*/
@Deprecated
VerifyResults verifyUpgrade(KVVersion targetVersion,
List snIds,
boolean showProgress,
boolean listAll,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
VerifyResults verifyUpgrade(KVVersion targetVersion,
List snIds,
boolean showProgress,
boolean listAll,
short serialVersion)
throws RemoteException;
/**
* Verify upgrade prerequisites.
*
* @since 3.5
*/
VerifyResults verifyPrerequisite(KVVersion targetVersion,
KVVersion prerequisiteVersion,
List snIds,
boolean showProgress,
boolean listAll,
boolean json,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* TODO: Remove this overloading without JSON parameter after R3
* compatibility period.
*
* @deprecated
* @since 3.0
*/
@Deprecated
VerifyResults verifyPrerequisite(KVVersion targetVersion,
KVVersion prerequisiteVersion,
List snIds,
boolean showProgress,
boolean listAll,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
VerifyResults verifyPrerequisite(KVVersion targetVersion,
KVVersion prerequisiteVersion,
List snIds,
boolean showProgress,
boolean listAll,
short serialVersion)
throws RemoteException;
/**
* Get the Admins configuration parameters.
*
* @since 3.0
*/
LoadParameters getParams(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
LoadParameters getParams(short serialVersion) throws RemoteException;
/**
* Get the name of the store-wide log file.
*
* @since 3.0
*/
String getStorewideLogName(AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String getStorewideLogName(short serialVersion) throws RemoteException;
/**
* List realized topologies with the "show topology history" command.
*
* @since 3.0
*/
List getTopologyHistory(boolean concise,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
List getTopologyHistory(boolean concise, short serialVersion)
throws RemoteException;
/**
* Get schema summary map.
*
* @since 3.0
*/
SortedMap
getSchemaSummaries(boolean includeDisabled,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
SortedMap
getSchemaSummaries(boolean includeDisabled, short serialVersion)
throws RemoteException;
/**
* Get schema details.
*
* @since 3.0
*/
AvroDdl.SchemaDetails getSchemaDetails(int schemaId,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
AvroDdl.SchemaDetails getSchemaDetails(int schemaId, short serialVersion)
throws RemoteException;
/**
* Add a schema definition.
*
* @since 3.0
*/
AvroDdl.AddSchemaResult addSchema(AvroSchemaMetadata metadata,
String schemaText,
AvroDdl.AddSchemaOptions options,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
AvroDdl.AddSchemaResult addSchema(AvroSchemaMetadata metadata,
String schemaText,
AvroDdl.AddSchemaOptions options,
short serialVersion)
throws RemoteException;
/**
* Update schema status.
*
* @since 3.0
*/
boolean updateSchemaStatus(int schemaId,
AvroSchemaMetadata newMeta,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
boolean updateSchemaStatus(int schemaId,
AvroSchemaMetadata newMeta,
short serialVersion)
throws RemoteException;
/**
* An unadvertised entry point which lets the caller check that a plan
* succeeded, and provokes an exception containing information about the
* failure if the plan failed. Used for testing and for situations where we
* need to programmatically obtain an exception if the plan failed.
*
* @throws OperationFaultException if the plan did not end successfully.
*
* @since 3.0
*/
void assertSuccess(int planId, AuthContext authCtx, short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void assertSuccess(int planId, short serialVersion)
throws RemoteException;
/**
* Get the status of an Admin plan.
*
* @since 3.5
*/
String getPlanStatus(int planId,
long options,
boolean json,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* TODO: Remove this overloading without JSON parameter after R3
* compatibility period.
*
* @deprecated
* @since 3.0
*/
@Deprecated
String getPlanStatus(int planId,
long options,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String getPlanStatus(int planId, long options, short serialVersion)
throws RemoteException;
/**
* Copy a topolgy within the Admin.
*
* @since 3.0
*/
String copyTopology(String sourceCandidateName,
String targetCandidateName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String copyTopology(String sourceCandidateName,
String targetCandidateName,
short serialVersion)
throws RemoteException;
/**
* Check validity of a topology.
*
* @since 3.0
*/
String validateTopology(String candidateName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Check validity of a topology.
* @param candidateName name of the topology candidate to be validated
* @param jsonVersion specify which version of JSON format to display the
* validation result
* @param authCtx
* @param serialVersion
* @return string result represent the validation. Result will be a JSON
* string if JSON version is specified.
* @throws RemoteException
* @since 18.1
*/
String validateTopology(final String candidateName,
final short jsonVersion,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String validateTopology(String candidateName, short serialVersion)
throws RemoteException;
/**
* Move an RN.
*
* @since 3.0
*/
String moveRN(String candidateName,
RepNodeId rnId,
StorageNodeId snId,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String moveRN(String candidateName,
RepNodeId rnId,
StorageNodeId snId,
short serialVersion)
throws RemoteException;
/**
* Install a receiver for Admin status updates, for delivering service
* change information to the standardized monitoring/management agent.
*
* @since 3.0
*/
void installStatusReceiver(AdminStatusReceiver asr,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
void installStatusReceiver(AdminStatusReceiver asr, short serialVersion)
throws RemoteException;
/**
* Get a list of nodes to upgrade in an order which will maintain
* store availability.
*
* @since 3.0
*/
String getUpgradeOrder(KVVersion targetVersion,
KVVersion prerequisiteVersion,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Get a collection of node sets to upgrade the set of storage node in
* order of the list.
* @param targetVersion target upgrade version
* @param prerequisiteVersion required upgrade version
* @param authCtx
* @param serialVersion
* @return list of storage node sets that to make up the upgrade order
* @throws RemoteException
*/
List>
getUpgradeOrderList(KVVersion targetVersion,
KVVersion prerequisiteVersion,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
String getUpgradeOrder(KVVersion targetVersion,
KVVersion prerequisiteVersion,
short serialVersion)
throws RemoteException;
/**
* Retrieve the beginning plan id and number of plans that satisfy the
* request.
*
* Returns an array of two integers indicating a range of plan id
* numbers. [0] is the first id in the range, and [1] number of
* plan ids in the range.
*
* Operates in three modes:
*
* mode A requests howMany plans ids following startTime
* mode B requests howMany plans ids preceding endTime
* mode C requests a range of plan ids from startTime to endTime.
*
* mode A is signified by endTime == 0
* mode B is signified by startTime == 0
* mode C is signified by neither startTime nor endTime being == 0.
* howMany is ignored in mode C.
* @since 3.0
*/
public int[] getPlanIdRange(final long startTime,
final long endTime,
final int howMany,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
public int[] getPlanIdRange(final long startTime,
final long endTime,
final int howMany,
short serialVersion)
throws RemoteException;
/**
* Returns a map of plans starting at firstPlanId. The number of plans in
* the map is the lesser of howMany, MAXPLANS, or the number of extant
* plans with id numbers following firstPlanId. The range is not
* necessarily fully populated; while plan ids are mostly sequential, it is
* possible for values to be skipped.
*
* @since 3.0
*/
public Map getPlanRange(final int firstPlanId,
final int howMany,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* To be removed after R2 compatibility period.
* @deprecated
*/
@Deprecated
public Map getPlanRange(final int firstPlanId,
final int howMany,
short serialVersion)
throws RemoteException;
/**
* Return the brief and detailed description of all users for display
*
* @since 3.0
*/
Map getUsersDescription(AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Verify if the specified password is correct for the user
*
* @since 3.0
*/
boolean verifyUserPassword(String userName,
char[] password,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Executes snapshot operations, this method is only for backwards
* compatibility.
*
* @param sop snapshot operation
* @param snid id of storage node on which the snapshot will be done
* @param rid the resource that is the snapshot target, a RepNodeId or
* AdminId
* @param sname name of snapshot
* @return operation result as a SnapResult instance
*
* @since 3.0
*/
public SnapResult executeSnapshotOperation(SnapshotOperation sop,
StorageNodeId snid,
ResourceId rid,
String sname,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Executes snapshot operations for one or all datacenters, using the admin
* to coordinate operations and locking.
*
* @param sop snapshot operation
* @param sname name of snapshot
* @param dcId id of datacenter or null for all datacenters
* @return operation result
*
* @since 4.4
*/
public SnapResultSummary executeSnapshotOperation(SnapshotOperation sop,
String sname,
DatacenterId dcId,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Returns an array of names of snapshots from a specified storage node. If
* no storage node id is specified, an arbitrary storage node will be
* chosen.
*
* @param snid id of the storage node. If null, an arbitrary storage node
* will be chosen.
* @return an array of snapshot names
*
* @since 3.0
*/
public String[] listSnapshots(StorageNodeId snid,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Repairs the admin quorum by updating the JE HA rep group membership.
*
* @since 3.4
*/
public Set repairAdminQuorum(Set zoneIds,
Set adminIds,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Creates a plan to inform the Store of the existence of an ES node, and
* stores it by its plan id.
*
* @param planName - the name of the plan
* @param clusterName - the cluster name of the ES cluster.
* @param transportHp - transport host:port of any node in the ES cluster.
* @param secure - ES Cluster is set up as secured or not.
* @param forceClear - if true, allows deletion of an existing ES index.
* @return the plan id of the created plan
* @since 4.0
*/
int createRegisterESClusterPlan(String planName,
String clusterName,
String transportHp,
boolean secure,
boolean forceClear,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* 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.
*
* @param planName the name of the plan
* @return the plan id of the created plan
* @since 4.0
*/
int createDeregisterESClusterPlan(String planName,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Verify data on this admin.
*
* @param verifyBtree verifies the btree of databases
* @param verifyLog verifies log files of databases
* @param verifyIndex verifies the indexes
* @param verifyRecord verifies the data records in disk
* @param btreeDelay delay between batches for btree verification
* @param logDelay delay between log file reads
* @throws RemoteException
* @throws IOException
* @since 18.1
*/
public void verifyData(boolean verifyBtree,
boolean verifyLog,
boolean verifyIndex,
boolean verifyRecord,
long btreeDelay,
long logDelay,
AuthContext authCtx,
short serialVersion)
throws RemoteException, IOException;
/**
* Create a plan to verify data on a node.
*
* @param planName
* @param rid id of the node to be verified
* @param verifyBtree verifies the btree of databases
* @param verifyLog verifies log files of databases
* @param verifyIndex verifies the indexes
* @param verifyRecord verifies the data records in disk
* @param btreeDelay delay between batches for btree verification
* @param logDelay delay between log file reads
* @return plan id
* @throws RemoteException
* @since 18.1
*/
public int createVerifyServicePlan(String planName,
ResourceId rid,
boolean verifyBtree,
boolean verifyLog,
boolean verifyIndex,
boolean verifyRecord,
long btreeDelay,
long logDelay,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a plan to verify data on all admins that are deployed to the
* specified zone or all zones.
*
* @param planName
* @param dcid datacenter id
* @param verifyBtree verifies the btree of databases
* @param verifyLog verifies log files of databases
* @param verifyIndex verifies the indexes
* @param verifyRecord verifies the data records in disk
* @param btreeDelay delay between batches for btree verification
* @param logDelay delay between log file reads
* @return the plan id
* @throws RemoteException
* @since 18.1
*/
public int createVerifyAllAdminsPlan(String planName,
DatacenterId dcid,
boolean verifyBtree,
boolean verifyLog,
boolean verifyIndex,
boolean verifyRecord,
long btreeDelay,
long logDelay,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a plan to verify data on all rns that are deployed to the
* specified zone or all zones.
*
* @param planName
* @param dcid datacenter id
* @param verifyBtree verifies the btree of databases
* @param verifyLog verifies log files of databases
* @param verifyIndex verifies the indexes
* @param verifyRecord verifies the data records in disk
* @param btreeDelay delay between batches for btree verification
* @param logDelay delay between log file reads
* @return the plan id
* @throws RemoteException
* @since 18.1
*/
public int createVerifyAllRepNodesPlan(String planName,
DatacenterId dcid,
boolean verifyBtree,
boolean verifyLog,
boolean verifyIndex,
boolean verifyRecord,
long btreeDelay,
long logDelay,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Create a plan to verify data on all rns and admins that are deployed to
* the specified zone or all zones.
*
* @param planName
* @param dcid datacenter id
* @param verifyBtree verifies the btree of databases
* @param verifyLog verifies log files of databases
* @param verifyIndex verifies the indexes
* @param verifyRecord verifies the data records in disk
* @param btreeDelay delay between batches for btree verification
* @param logDelay delay between log file reads
* @return the plan id
* @throws RemoteException
* @since 18.1
*/
public int createVerifyAllServicesPlan(String planName,
DatacenterId dcid,
boolean verifyBtree,
boolean verifyLog,
boolean verifyIndex,
boolean verifyRecord,
long btreeDelay,
long logDelay,
AuthContext authCtx,
short serialVersion)
throws RemoteException;
/**
* Creates a plan to set limits on a table.
*/
public int createTableLimitPlan(String planName,
String namespace,
String tableName,
TableLimits newLimits,
AuthContext NULL_CTX, short serialVersion)
throws RemoteException;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy