com.alipay.sofa.runtime.api.client.param

Class ReferenceParam<T>

java.lang.Object

com.alipay.sofa.runtime.api.client.param.ReferenceParam<T>

public class ReferenceParam<T>
extends Object

Parameter class used when using ReferenceClient to create a SOFA reference.

Author:

xuanbei 18/2/28

Constructor Summary

Constructors

Constructor and Description
ReferenceParam()

Method Summary

Modifier and Type	Method and Description
BindingParam	getBindingParam() The BindingParam of the SOFA reference to be created.
Class<T>	getInterfaceType() Get the interface type of the SOFA reference to be created.
String	getUniqueId() Get the unique id of the SOFA reference to be created.
boolean	isJvmFirst() Get the jvm-first parameter of the SOFA reference.
boolean	isJvmService() Deprecated.
boolean	isLocalFirst() Deprecated.
void	setBindingParam(BindingParam bindingParam) Set the BindingParam of the SOFA reference to be created.
void	setInterfaceType(Class<T> interfaceType) The interface type of the SOFA reference to be created.
void	setJvmFirst(boolean jvmFirst) Set whether the SOFA reference should invoke the SOFA service in the same JVM when available.
void	setJvmService(boolean jvmService) Deprecated.
void	setLocalFirst(boolean localFirst) Deprecated.
void	setUniqueId(String uniqueId) Set the unique id of the SOFA reference to be created.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceParam

public ReferenceParam()

Method Detail

getUniqueId

public String getUniqueId()

Get the unique id of the SOFA reference to be created.

Returns:

The unique id of the SOFA reference to be created.

setUniqueId

public void setUniqueId(String uniqueId)

Set the unique id of the SOFA reference to be created.

Parameters:

uniqueId - The unique id of the SOFA reference.

getInterfaceType

public Class<T> getInterfaceType()

Get the interface type of the SOFA reference to be created.

Returns:

The interface type of the SOFA reference to be created.

setInterfaceType

public void setInterfaceType(Class<T> interfaceType)

The interface type of the SOFA reference to be created.

Parameters:

interfaceType - The interface type of the SOFA reference.

getBindingParam

public BindingParam getBindingParam()

The BindingParam of the SOFA reference to be created.

Returns:

The BindingParam of the SOFA reference to be created.

setBindingParam

public void setBindingParam(BindingParam bindingParam)

Set the BindingParam of the SOFA reference to be created. When creating a JVM SOFA reference, you should not set BindingParam; When creating a RPC SOFA reference, you must set BindingParam.

Parameters:

bindingParam - The BindingParam of the SOFA reference.

isJvmFirst

public boolean isJvmFirst()

Get the jvm-first parameter of the SOFA reference.

Returns:

The jvm-first parameter of the SOFA reference.

setJvmFirst

public void setJvmFirst(boolean jvmFirst)

Set whether the SOFA reference should invoke the SOFA service in the same JVM when available. This value is default to true.

Parameters:

jvmFirst - Set whether the SOFA reference should invoke the SOFA service in the same JVM when available.

isLocalFirst

@Deprecated
public boolean isLocalFirst()

Deprecated.

Get the local-first parameter of the SOFA reference. Deprecated, you should use $isJvmFirst().

Returns:

The local-first parameter of the SOFA reference.

setLocalFirst

@Deprecated
public void setLocalFirst(boolean localFirst)

Deprecated.

Set whether the SOFA reference should invoke the SOFA service in the same JVM when available. This value is default to true. Deprecated, you should use $setJvmFirst(boolean).

Parameters:

localFirst - Set whether the SOFA reference should invoke the SOFA service in the same JVM when available.

isJvmService

@Deprecated
public boolean isJvmService()

Deprecated.

Get the jvm-service parameter of the SOFA reference. Deprecated, will do nothing, please don't use.

Returns:

The jvm-service parameter of the SOFA reference.

setJvmService

@Deprecated
public void setJvmService(boolean jvmService)

Deprecated.

Set whether expose the SOFA reference to be created to a JVM SOFA service. This parameter only works when creating a RPC SOFA reference. This parameter is default to false. Deprecated, will do nothing, please don't use.

Parameters:

jvmService - The jvm-service parameter of the SOFA reference.