org.apache.servicecomb.service.center.client

Class ServiceCenterClient

java.lang.Object

org.apache.servicecomb.service.center.client.ServiceCenterClient

All Implemented Interfaces:

ServiceCenterOperation

public class ServiceCenterClient
extends Object
implements ServiceCenterOperation

Constructor Summary

Constructors

Constructor and Description
ServiceCenterClient(ServiceCenterAddressManager addressManager, HttpConfiguration.SSLProperties sslProperties, RequestAuthHeaderProvider requestAuthHeaderProvider, String tenantName, Map<String,String> extraGlobalHeaders)
ServiceCenterClient(ServiceCenterRawClient httpClient)

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.
String	getServiceSchemaContext(String serviceId, String schemaId) Get one schema context of service
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 instance) 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
ServiceCenterClient	setEventBus(com.google.common.eventbus.EventBus eventBus)
boolean	updateMicroserviceInstanceStatus(String serviceId, String instanceId, MicroserviceInstanceStatus status) Update status of microservice Instance
boolean	updateMicroserviceProperties(String serviceId, Map<String,String> serviceProperties) Update properties of microservice
boolean	updateServiceSchemaContext(String serviceId, SchemaInfo schemaInfo) update schema context of service

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceCenterClient

public ServiceCenterClient(ServiceCenterRawClient httpClient)

ServiceCenterClient

public ServiceCenterClient(ServiceCenterAddressManager addressManager,
                           HttpConfiguration.SSLProperties sslProperties,
                           RequestAuthHeaderProvider requestAuthHeaderProvider,
                           String tenantName,
                           Map<String,String> extraGlobalHeaders)

Method Detail

setEventBus

public ServiceCenterClient setEventBus(com.google.common.eventbus.EventBus eventBus)

getServiceCenterInstances

public MicroserviceInstancesResponse getServiceCenterInstances()

Description copied from interface: ServiceCenterOperation

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.

Specified by:

getServiceCenterInstances in interface ServiceCenterOperation

Returns:

MicroserviceInstancesResponse

registerMicroservice

public RegisteredMicroserviceResponse registerMicroservice(Microservice microservice)

Description copied from interface: ServiceCenterOperation

Register microservcie.

Specified by:

registerMicroservice in interface ServiceCenterOperation

Returns:

RegisterMicroserviceResponse

getMicroserviceList

public MicroservicesResponse getMicroserviceList()

Description copied from interface: ServiceCenterOperation

find all registered microservice of service-center.

Specified by:

getMicroserviceList in interface ServiceCenterOperation

Returns:

MicroserviceResponse

queryServiceId

public RegisteredMicroserviceResponse queryServiceId(Microservice microservice)

Description copied from interface: ServiceCenterOperation

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

Specified by:

queryServiceId in interface ServiceCenterOperation

Returns:

Microservice ID, null if microservice does not exists.

getMicroserviceByServiceId

public Microservice getMicroserviceByServiceId(String serviceId)

Description copied from interface: ServiceCenterOperation

Get microservice information by service id.

Specified by:

getMicroserviceByServiceId in interface ServiceCenterOperation

Returns:

Microservice

registerMicroserviceInstance

public RegisteredMicroserviceInstanceResponse registerMicroserviceInstance(MicroserviceInstance instance)

Description copied from interface: ServiceCenterOperation

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

Specified by:

registerMicroserviceInstance in interface ServiceCenterOperation

Returns:

instanceId

findMicroserviceInstance

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

Description copied from interface: ServiceCenterOperation

Find MicroserviceInstance by properties.

Specified by:

findMicroserviceInstance in interface ServiceCenterOperation

Returns:

FindMicroserviceInstancesResponse

getMicroserviceInstanceList

public MicroserviceInstancesResponse getMicroserviceInstanceList(String serviceId)

Description copied from interface: ServiceCenterOperation

Find microservice instances of service-center

Specified by:

getMicroserviceInstanceList in interface ServiceCenterOperation

Returns:

MicroserviceInstancesResponse

getMicroserviceInstance

public MicroserviceInstance getMicroserviceInstance(String serviceId,
                                                    String instanceId)

Description copied from interface: ServiceCenterOperation

Get microservice instance by id

Specified by:

getMicroserviceInstance in interface ServiceCenterOperation

Returns:

MicroserviceInstance

deleteMicroserviceInstance

public void deleteMicroserviceInstance(String serviceId,
                                       String instanceId)

Description copied from interface: ServiceCenterOperation

Delete a microservice instance

Specified by:

deleteMicroserviceInstance in interface ServiceCenterOperation

updateMicroserviceInstanceStatus

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

Description copied from interface: ServiceCenterOperation

Update status of microservice Instance

Specified by:

updateMicroserviceInstanceStatus in interface ServiceCenterOperation

Returns:

if update is successful

sendHeartBeats

public void sendHeartBeats(HeartbeatsRequest heartbeatsRequest)

Description copied from interface: ServiceCenterOperation

Batch send heartbeats to service-center

Specified by:

sendHeartBeats in interface ServiceCenterOperation

sendHeartBeat

public boolean sendHeartBeat(String serviceId,
                             String instanceId)

Description copied from interface: ServiceCenterOperation

send heart beat of this instance.

Specified by:

sendHeartBeat in interface ServiceCenterOperation

Returns:

if heartbeat is successful

getServiceSchemasList

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

Description copied from interface: ServiceCenterOperation

Get schemas list of service

Specified by:

getServiceSchemasList in interface ServiceCenterOperation

getServiceSchemaContext

public String getServiceSchemaContext(String serviceId,
                                      String schemaId)

Get one schema context of service

Parameters:

serviceId -

schemaId -

Returns:

Throws:

OperationException

registerSchema

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

Description copied from interface: ServiceCenterOperation

register schema.

Specified by:

registerSchema in interface ServiceCenterOperation

Returns:

if register is successful

updateServiceSchemaContext

public boolean updateServiceSchemaContext(String serviceId,
                                          SchemaInfo schemaInfo)

Description copied from interface: ServiceCenterOperation

update schema context of service

Specified by:

updateServiceSchemaContext in interface ServiceCenterOperation

Returns:

if update is successful

batchUpdateServiceSchemaContext

public boolean batchUpdateServiceSchemaContext(String serviceId,
                                               ModifySchemasRequest modifySchemasRequest)

Description copied from interface: ServiceCenterOperation

batch update schema context of service

Specified by:

batchUpdateServiceSchemaContext in interface ServiceCenterOperation

Returns:

if update is successful

queryToken

public RbacTokenResponse queryToken(RbacTokenRequest request)

Description copied from interface: ServiceCenterOperation

query token using user confidential

Specified by:

queryToken in interface ServiceCenterOperation

Returns:

if heartbeat is successful

updateMicroserviceProperties

public boolean updateMicroserviceProperties(String serviceId,
                                            Map<String,String> serviceProperties)

Description copied from interface: ServiceCenterOperation

Update properties of microservice

Specified by:

updateMicroserviceProperties in interface ServiceCenterOperation

Returns:

if update is successful