com.staros.client

Class StarClient

java.lang.Object

com.staros.client.StarClient

public class StarClient
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	StarClient.IpcCallable<V>
protected static interface	StarClient.RpcCallable<V>

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_ID
static FileStoreType	FS_NOT_SET
static int	GRPC_CHANNEL_MAX_MESSAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
StarClient()
StarClient(StarManagerServer server)

Method Summary

Modifier and Type	Method and Description
java.lang.String	addFileStore(FileStoreInfo info, java.lang.String serviceId)
long	addWorker(java.lang.String serviceId, java.lang.String workerIpPort)
long	addWorker(java.lang.String serviceId, java.lang.String workerIpPort, long workerGroupId)
static java.lang.String	allocateFilePath(FilePathInfo fromInfo, int seed) Convenient help function to ease the client to generate the filepath with partitioned prefix feature enabled.
FilePathInfo	allocateFilePath(java.lang.String serviceId, FileStoreType fsType, java.lang.String suffix)
FilePathInfo	allocateFilePath(java.lang.String serviceId, java.lang.String fsKey, java.lang.String suffix)
WorkerGroupDetailInfo	alterWorkerGroupSpec(java.lang.String serviceId, long groupId, WorkerGroupSpec spec) Specific interface for change WorkerGroup spec only.
java.lang.String	bootstrapService(java.lang.String serviceTemplateName, java.lang.String serviceName)
void	connectServer(java.lang.String serverIpPort)
MetaGroupInfo	createMetaGroup(java.lang.String serviceId, CreateMetaGroupInfo info)
java.util.List<ShardInfo>	createShard(java.lang.String serviceId, java.util.List<CreateShardInfo> createShardInfos)
java.util.List<ShardGroupInfo>	createShardGroup(java.lang.String serviceId, java.util.List<CreateShardGroupInfo> createShardGroupInfos)
WorkerGroupDetailInfo	createWorkerGroup(java.lang.String serviceId, java.lang.String owner, WorkerGroupSpec spec, java.util.Map<java.lang.String,java.lang.String> labels, java.util.Map<java.lang.String,java.lang.String> properties)
void	deleteMetaGroup(java.lang.String serviceId, DeleteMetaGroupInfo info)
void	deleteShard(java.lang.String serviceId, java.util.Set<java.lang.Long> shardIds)
void	deleteShardGroup(java.lang.String serviceId, java.util.List<java.lang.Long> groupIds, boolean deleteShards)
void	deleteWorkerGroup(java.lang.String serviceId, long groupId)
void	deregisterService(java.lang.String serviceTemplateName)
java.lang.String	dump()
FileStoreInfo	getFileStore(java.lang.String fsKey, java.lang.String serviceId)
FileStoreInfo	getFileStoreByName(java.lang.String fsName, java.lang.String serviceId)
MetaGroupInfo	getMetaGroupInfo(java.lang.String serviceId, long metaGroupId)
ServiceInfo	getServiceInfoById(java.lang.String serviceId)
ServiceInfo	getServiceInfoByName(java.lang.String serviceName)
java.util.List<ShardGroupInfo>	getShardGroup(java.lang.String serviceId, java.util.List<java.lang.Long> groupIds)
java.util.List<ShardInfo>	getShardInfo(java.lang.String serviceId, java.util.List<java.lang.Long> shardIds)
java.util.List<ShardInfo>	getShardInfo(java.lang.String serviceId, java.util.List<java.lang.Long> shardIds, long workerGroupId) Get shard info of the specific service for the list of shards, optionally in specific worker group
WorkerInfo	getWorkerInfo(java.lang.String serviceId, long workerId)
WorkerInfo	getWorkerInfo(java.lang.String serviceId, java.lang.String ipPort)
java.util.List<FileStoreInfo>	listFileStore(java.lang.String serviceId)
java.util.List<FileStoreInfo>	listFileStore(java.lang.String serviceId, FileStoreType fsType)
java.util.List<MetaGroupInfo>	listMetaGroup(java.lang.String serviceId)
java.util.List<java.util.List<ShardInfo>>	listShard(java.lang.String serviceId, java.util.List<java.lang.Long> groupIds)
java.util.List<java.util.List<ShardInfo>>	listShard(java.lang.String serviceId, java.util.List<java.lang.Long> groupIds, long workerGroupId, boolean withoutReplicaInfo) List shard info of the specific service for the list of shard groups, optionally in specific worker group
java.util.List<ShardGroupInfo>	listShardGroup(java.lang.String serviceId)
org.apache.commons.lang3.tuple.Pair<java.util.List<ShardGroupInfo>,java.lang.Long>	listShardGroup(java.lang.String serviceId, long startGroupId)
java.util.List<WorkerGroupDetailInfo>	listWorkerGroup(java.lang.String serviceId, java.util.List<java.lang.Long> groupIds, boolean includeWorkersInfo)
java.util.List<WorkerGroupDetailInfo>	listWorkerGroup(java.lang.String serviceId, java.util.Map<java.lang.String,java.lang.String> filterLabels)
boolean	queryMetaGroupStable(java.lang.String serviceId, long metaGroupId)
boolean	queryMetaGroupStable(java.lang.String serviceId, long metaGroupId, long workerGroupId)
void	registerService(java.lang.String serviceTemplateName)
void	removeFileStore(java.lang.String fsKey, java.lang.String serviceId)
void	removeFileStoreByName(java.lang.String fsName, java.lang.String serviceId)
void	removeWorker(java.lang.String serviceId, long workerId)
void	removeWorker(java.lang.String serviceId, long workerId, long workerGroupId)
void	shutdownService(java.lang.String serviceId)
void	stop()
void	updateFileStore(FileStoreInfo info, java.lang.String serviceId)
void	updateMetaGroup(java.lang.String serviceId, UpdateMetaGroupInfo info)
void	updateShard(java.lang.String serviceId, java.util.List<UpdateShardInfo> updateShardInfos)
void	updateShardGroup(java.lang.String serviceId, java.util.List<UpdateShardGroupInfo> updateShardGroupInfos)
WorkerGroupDetailInfo	updateWorkerGroup(java.lang.String serviceId, long groupId, java.util.Map<java.lang.String,java.lang.String> labels, java.util.Map<java.lang.String,java.lang.String> properties)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ID

public static final long DEFAULT_ID

See Also:

Constant Field Values

GRPC_CHANNEL_MAX_MESSAGE_SIZE

public static final int GRPC_CHANNEL_MAX_MESSAGE_SIZE

See Also:

Constant Field Values

FS_NOT_SET

public static final FileStoreType FS_NOT_SET

Constructor Detail

StarClient

public StarClient()

StarClient

public StarClient(StarManagerServer server)

Method Detail

connectServer

public void connectServer(java.lang.String serverIpPort)

stop

public void stop()

registerService

public void registerService(java.lang.String serviceTemplateName)
                     throws StarClientException

Throws:

StarClientException

deregisterService

public void deregisterService(java.lang.String serviceTemplateName)
                       throws StarClientException

Throws:

StarClientException

bootstrapService

public java.lang.String bootstrapService(java.lang.String serviceTemplateName,
                                         java.lang.String serviceName)
                                  throws StarClientException

Throws:

StarClientException

shutdownService

public void shutdownService(java.lang.String serviceId)
                     throws StarClientException

Throws:

StarClientException

getServiceInfoById

public ServiceInfo getServiceInfoById(java.lang.String serviceId)
                               throws StarClientException

Throws:

StarClientException

getServiceInfoByName

public ServiceInfo getServiceInfoByName(java.lang.String serviceName)
                                 throws StarClientException

Throws:

StarClientException

createWorkerGroup

public WorkerGroupDetailInfo createWorkerGroup(java.lang.String serviceId,
                                               java.lang.String owner,
                                               WorkerGroupSpec spec,
                                               java.util.Map<java.lang.String,java.lang.String> labels,
                                               java.util.Map<java.lang.String,java.lang.String> properties)
                                        throws StarClientException

Throws:

StarClientException

listWorkerGroup

public java.util.List<WorkerGroupDetailInfo> listWorkerGroup(java.lang.String serviceId,
                                                             java.util.List<java.lang.Long> groupIds,
                                                             boolean includeWorkersInfo)
                                                      throws StarClientException

Throws:

StarClientException

listWorkerGroup

public java.util.List<WorkerGroupDetailInfo> listWorkerGroup(java.lang.String serviceId,
                                                             java.util.Map<java.lang.String,java.lang.String> filterLabels)
                                                      throws StarClientException

Throws:

StarClientException

updateWorkerGroup

public WorkerGroupDetailInfo updateWorkerGroup(java.lang.String serviceId,
                                               long groupId,
                                               java.util.Map<java.lang.String,java.lang.String> labels,
                                               java.util.Map<java.lang.String,java.lang.String> properties)
                                        throws StarClientException

Throws:

StarClientException

alterWorkerGroupSpec

public WorkerGroupDetailInfo alterWorkerGroupSpec(java.lang.String serviceId,
                                                  long groupId,
                                                  WorkerGroupSpec spec)
                                           throws StarClientException

Specific interface for change WorkerGroup spec only. This will usually involve resource change.

Parameters:

serviceId - service id

groupId - group id

spec - new group spec

Returns:

WorkerGroup detail info after spec changed.

Throws:

StarClientException - throw StarClientException when the server responds error

deleteWorkerGroup

public void deleteWorkerGroup(java.lang.String serviceId,
                              long groupId)
                       throws StarClientException

Throws:

StarClientException

addWorker

public long addWorker(java.lang.String serviceId,
                      java.lang.String workerIpPort)
               throws StarClientException

Throws:

StarClientException

addWorker

public long addWorker(java.lang.String serviceId,
                      java.lang.String workerIpPort,
                      long workerGroupId)
               throws StarClientException

Throws:

StarClientException

removeWorker

public void removeWorker(java.lang.String serviceId,
                         long workerId)
                  throws StarClientException

Throws:

StarClientException

removeWorker

public void removeWorker(java.lang.String serviceId,
                         long workerId,
                         long workerGroupId)
                  throws StarClientException

Throws:

StarClientException

getWorkerInfo

public WorkerInfo getWorkerInfo(java.lang.String serviceId,
                                long workerId)
                         throws StarClientException

Throws:

StarClientException

getWorkerInfo

public WorkerInfo getWorkerInfo(java.lang.String serviceId,
                                java.lang.String ipPort)
                         throws StarClientException

Throws:

StarClientException

createShard

public java.util.List<ShardInfo> createShard(java.lang.String serviceId,
                                             java.util.List<CreateShardInfo> createShardInfos)
                                      throws StarClientException

Throws:

StarClientException

updateShard

public void updateShard(java.lang.String serviceId,
                        java.util.List<UpdateShardInfo> updateShardInfos)
                 throws StarClientException

Throws:

StarClientException

deleteShard

public void deleteShard(java.lang.String serviceId,
                        java.util.Set<java.lang.Long> shardIds)
                 throws StarClientException

Throws:

StarClientException

getShardInfo

public java.util.List<ShardInfo> getShardInfo(java.lang.String serviceId,
                                              java.util.List<java.lang.Long> shardIds)
                                       throws StarClientException

Throws:

StarClientException

getShardInfo

public java.util.List<ShardInfo> getShardInfo(java.lang.String serviceId,
                                              java.util.List<java.lang.Long> shardIds,
                                              long workerGroupId)
                                       throws StarClientException

Get shard info of the specific service for the list of shards, optionally in specific worker group

Parameters:

serviceId - target service id

shardIds - list of shards

workerGroupId - target worker group.

Returns:

shard info, includes replica info in the specific worker group

Throws:

StarClientException - StarClientException

listShard

public java.util.List<java.util.List<ShardInfo>> listShard(java.lang.String serviceId,
                                                           java.util.List<java.lang.Long> groupIds)
                                                    throws StarClientException

Throws:

StarClientException

listShard

public java.util.List<java.util.List<ShardInfo>> listShard(java.lang.String serviceId,
                                                           java.util.List<java.lang.Long> groupIds,
                                                           long workerGroupId,
                                                           boolean withoutReplicaInfo)
                                                    throws StarClientException

List shard info of the specific service for the list of shard groups, optionally in specific worker group

Parameters:

serviceId - target service id

groupIds - list of shard group id

workerGroupId - target worker group.

Returns:

shard info, includes replica info in the specific worker group

Throws:

StarClientException - StarClientException

createShardGroup

public java.util.List<ShardGroupInfo> createShardGroup(java.lang.String serviceId,
                                                       java.util.List<CreateShardGroupInfo> createShardGroupInfos)
                                                throws StarClientException

Throws:

StarClientException

deleteShardGroup

public void deleteShardGroup(java.lang.String serviceId,
                             java.util.List<java.lang.Long> groupIds,
                             boolean deleteShards)
                      throws StarClientException

Throws:

StarClientException

updateShardGroup

public void updateShardGroup(java.lang.String serviceId,
                             java.util.List<UpdateShardGroupInfo> updateShardGroupInfos)
                      throws StarClientException

Throws:

StarClientException

listShardGroup

public org.apache.commons.lang3.tuple.Pair<java.util.List<ShardGroupInfo>,java.lang.Long> listShardGroup(java.lang.String serviceId,
                                                                                                         long startGroupId)
                                                                                                  throws StarClientException

Throws:

StarClientException

listShardGroup

public java.util.List<ShardGroupInfo> listShardGroup(java.lang.String serviceId)
                                              throws StarClientException

Throws:

StarClientException

getShardGroup

public java.util.List<ShardGroupInfo> getShardGroup(java.lang.String serviceId,
                                                    java.util.List<java.lang.Long> groupIds)
                                             throws StarClientException

Throws:

StarClientException

createMetaGroup

public MetaGroupInfo createMetaGroup(java.lang.String serviceId,
                                     CreateMetaGroupInfo info)
                              throws StarClientException

Throws:

StarClientException

deleteMetaGroup

public void deleteMetaGroup(java.lang.String serviceId,
                            DeleteMetaGroupInfo info)
                     throws StarClientException

Throws:

StarClientException

updateMetaGroup

public void updateMetaGroup(java.lang.String serviceId,
                            UpdateMetaGroupInfo info)
                     throws StarClientException

Throws:

StarClientException

getMetaGroupInfo

public MetaGroupInfo getMetaGroupInfo(java.lang.String serviceId,
                                      long metaGroupId)
                               throws StarClientException

Throws:

StarClientException

listMetaGroup

public java.util.List<MetaGroupInfo> listMetaGroup(java.lang.String serviceId)
                                            throws StarClientException

Throws:

StarClientException

queryMetaGroupStable

public boolean queryMetaGroupStable(java.lang.String serviceId,
                                    long metaGroupId)
                             throws StarClientException

Throws:

StarClientException

queryMetaGroupStable

public boolean queryMetaGroupStable(java.lang.String serviceId,
                                    long metaGroupId,
                                    long workerGroupId)
                             throws StarClientException

Throws:

StarClientException

allocateFilePath

public FilePathInfo allocateFilePath(java.lang.String serviceId,
                                     FileStoreType fsType,
                                     java.lang.String suffix)
                              throws StarClientException

Throws:

StarClientException

allocateFilePath

public FilePathInfo allocateFilePath(java.lang.String serviceId,
                                     java.lang.String fsKey,
                                     java.lang.String suffix)
                              throws StarClientException

Throws:

StarClientException

addFileStore

public java.lang.String addFileStore(FileStoreInfo info,
                                     java.lang.String serviceId)
                              throws StarClientException

Throws:

StarClientException

removeFileStore

public void removeFileStore(java.lang.String fsKey,
                            java.lang.String serviceId)
                     throws StarClientException

Throws:

StarClientException

removeFileStoreByName

public void removeFileStoreByName(java.lang.String fsName,
                                  java.lang.String serviceId)
                           throws StarClientException

Throws:

StarClientException

updateFileStore

public void updateFileStore(FileStoreInfo info,
                            java.lang.String serviceId)
                     throws StarClientException

Throws:

StarClientException

listFileStore

public java.util.List<FileStoreInfo> listFileStore(java.lang.String serviceId)
                                            throws StarClientException

Throws:

StarClientException

listFileStore

public java.util.List<FileStoreInfo> listFileStore(java.lang.String serviceId,
                                                   FileStoreType fsType)
                                            throws StarClientException

Throws:

StarClientException

getFileStore

public FileStoreInfo getFileStore(java.lang.String fsKey,
                                  java.lang.String serviceId)
                           throws StarClientException

Throws:

StarClientException

getFileStoreByName

public FileStoreInfo getFileStoreByName(java.lang.String fsName,
                                        java.lang.String serviceId)
                                 throws StarClientException

Throws:

StarClientException

dump

public java.lang.String dump()
                      throws StarClientException

Throws:

StarClientException

allocateFilePath

public static java.lang.String allocateFilePath(FilePathInfo fromInfo,
                                                int seed)

Convenient help function to ease the client to generate the filepath with partitioned prefix feature enabled.

Parameters:

fromInfo - the original FilePathInfo allocated by StarManager

seed - the seed (hashcode) to calculate the prefix for the path

Returns:

the full path from @fromInfo - return the @fromInfo.getFullPath() if the partitioned prefix is not enabled - return the full path with prefix inserted who is generated from @seed when the partitioned prefix is enabled.