org.apache.servicecomb.service.center.client

Interface ServiceCenterOperation

All Known Implementing Classes:

ServiceCenterClient

public interface ServiceCenterOperation

Method Summary

Modifier and Type	Method and Description
boolean	batchUpdateServiceSchemaContext(String serviceId, ModifySchemasRequest modifySchemasRequest) batch update schema context of service
void	deleteMicroserviceInstance(String serviceId, String instanceId) Delete a microservice instance
FindMicroserviceInstancesResponse	findMicroserviceInstance(String consumerId, String appId, String serviceName, String versionRule, String revision) Find MicroserviceInstance by properties.
Microservice	getMicroserviceByServiceId(String serviceId) Get microservice information by service id.
MicroserviceInstance	getMicroserviceInstance(String serviceId, String instanceId) Get microservice instance by id
MicroserviceInstancesResponse	getMicroserviceInstanceList(String serviceId) Find microservice instances of service-center
MicroservicesResponse	getMicroserviceList() find all registered microservice of service-center.
MicroserviceInstancesResponse	getServiceCenterInstances() Query service center instances.
List<SchemaInfo>	getServiceSchemasList(String serviceId, boolean withContent) Get schemas list of service
RegisteredMicroserviceResponse	queryServiceId(Microservice microservice) query Microservice ID by appId, serviceName, version and environment.
RbacTokenResponse	queryToken(RbacTokenRequest request) query token using user confidential
RegisteredMicroserviceResponse	registerMicroservice(Microservice microservice) Register microservcie.
RegisteredMicroserviceInstanceResponse	registerMicroserviceInstance(MicroserviceInstance microserviceInstance) Register microservice instances to service-center Notice: microserviceInstance' service id must be set before calling this method.
boolean	registerSchema(String serviceId, String schemaId, CreateSchemaRequest schema) register schema.
boolean	sendHeartBeat(String serviceId, String instanceId) send heart beat of this instance.
void	sendHeartBeats(HeartbeatsRequest heartbeatsRequest) Batch send heartbeats to service-center
boolean	updateMicroserviceInstanceStatus(String serviceId, String instanceId, MicroserviceInstanceStatus status) Update status of microservice Instance
boolean	updateMicroserviceProperties(String microserviceId, Map<String,String> serviceProperties) Update properties of microservice
boolean	updateServiceSchemaContext(String serviceId, SchemaInfo schemaInfo) update schema context of service

Method Detail

getServiceCenterInstances

MicroserviceInstancesResponse getServiceCenterInstances()

Query service center instances. In configuration file, only one address of service center instances can be configured, and other instances can be discovered by calling this method.

Returns:

MicroserviceInstancesResponse

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

registerMicroservice

RegisteredMicroserviceResponse registerMicroservice(Microservice microservice)

Register microservcie.

Returns:

RegisterMicroserviceResponse

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

getMicroserviceList

MicroservicesResponse getMicroserviceList()

find all registered microservice of service-center.

Returns:

MicroserviceResponse

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

getMicroserviceByServiceId

Microservice getMicroserviceByServiceId(String serviceId)

Get microservice information by service id.

Returns:

Microservice

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

queryServiceId

RegisteredMicroserviceResponse queryServiceId(Microservice microservice)

query Microservice ID by appId, serviceName, version and environment.

Returns:

Microservice ID, null if microservice does not exists.

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

registerMicroserviceInstance

RegisteredMicroserviceInstanceResponse registerMicroserviceInstance(MicroserviceInstance microserviceInstance)

Register microservice instances to service-center Notice: microserviceInstance' service id must be set before calling this method.

Returns:

instanceId

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

getMicroserviceInstanceList

MicroserviceInstancesResponse getMicroserviceInstanceList(String serviceId)

Find microservice instances of service-center

Returns:

MicroserviceInstancesResponse

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

getMicroserviceInstance

MicroserviceInstance getMicroserviceInstance(String serviceId,
                                             String instanceId)

Get microservice instance by id

Returns:

MicroserviceInstance

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

findMicroserviceInstance

FindMicroserviceInstancesResponse findMicroserviceInstance(String consumerId,
                                                           String appId,
                                                           String serviceName,
                                                           String versionRule,
                                                           String revision)

Find MicroserviceInstance by properties.

Returns:

FindMicroserviceInstancesResponse

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.n

deleteMicroserviceInstance

void deleteMicroserviceInstance(String serviceId,
                                String instanceId)

Delete a microservice instance

Throws:

OperationException

updateMicroserviceInstanceStatus

boolean updateMicroserviceInstanceStatus(String serviceId,
                                         String instanceId,
                                         MicroserviceInstanceStatus status)

Update status of microservice Instance

Returns:

if update is successful

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

registerSchema

boolean registerSchema(String serviceId,
                       String schemaId,
                       CreateSchemaRequest schema)

register schema.

Returns:

if register is successful

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

updateServiceSchemaContext

boolean updateServiceSchemaContext(String serviceId,
                                   SchemaInfo schemaInfo)

update schema context of service

Returns:

if update is successful

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

batchUpdateServiceSchemaContext

boolean batchUpdateServiceSchemaContext(String serviceId,
                                        ModifySchemasRequest modifySchemasRequest)

batch update schema context of service

Returns:

if update is successful

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

sendHeartBeats

void sendHeartBeats(HeartbeatsRequest heartbeatsRequest)

Batch send heartbeats to service-center

Parameters:

heartbeatsRequest -

Throws:

OperationException

sendHeartBeat

boolean sendHeartBeat(String serviceId,
                      String instanceId)

send heart beat of this instance.

Returns:

if heartbeat is successful

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

getServiceSchemasList

List<SchemaInfo> getServiceSchemasList(String serviceId,
                                       boolean withContent)

Get schemas list of service

Throws:

OperationException

queryToken

RbacTokenResponse queryToken(RbacTokenRequest request)

query token using user confidential

Returns:

if heartbeat is successful

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.

updateMicroserviceProperties

boolean updateMicroserviceProperties(String microserviceId,
                                     Map<String,String> serviceProperties)

Update properties of microservice

Returns:

if update is successful

Throws:

OperationException - If some problems happened to contact service center or non http 200 returned.