com.alipay.sofa.runtime.api.client

Interface ReferenceClient

All Known Implementing Classes:

ReferenceClientImpl

public interface ReferenceClient

This class is used to create a SOFA reference. There are to ways to get an instance of this class in a Spring bean:

1. Get the instance of ClientFactory, then invoke ClientFactory.getClient(Class) to get the instance of this class.
2. Annotate a field of type ReferenceClient with annotation SofaClientFactory.

Author:

xuanbei 18/2/28

Method Summary

Modifier and Type	Method and Description
<T> T	reference(ReferenceParam<T> referenceParam) Create a SOFA reference, sample usage:
void	removeReference(Class<?> interfaceClass) Remove SOFA references on service dimension
void	removeReference(Class<?> interfaceClass, String uniqueId) Remove SOFA references on service dimension
<T> void	removeReference(ReferenceParam<T> referenceParam) Remove a specified SOFA reference

Method Detail

reference

<T> T reference(ReferenceParam<T> referenceParam)

Create a SOFA reference, sample usage:

 ReferenceParam<SampleService> referenceParam = new ReferenceParam<SampleService>();
 referenceParam3.setInterfaceType(SampleService.class);
 SampleService sampleService3 = referenceClient.reference(referenceParam);
 

Type Parameters:

T - The type of the SOFA reference to create.

Parameters:

referenceParam - The parameter of the SOFA reference to create.

Returns:

The SOFA reference to create.

removeReference

<T> void removeReference(ReferenceParam<T> referenceParam)

Remove a specified SOFA reference

Type Parameters:

T - The type of the SOFA reference to remove

Parameters:

referenceParam - The parameter of the SOFA reference to remove

removeReference

void removeReference(Class<?> interfaceClass)

Remove SOFA references on service dimension

Parameters:

interfaceClass - the interface type of the reference component

removeReference

void removeReference(Class<?> interfaceClass,
                     String uniqueId)

Remove SOFA references on service dimension

Parameters:

interfaceClass - the interface type of the reference component

uniqueId - the uniqueId of the reference component