com.meituan.lyrebird.client

Class LyrebirdClient

java.lang.Object

com.meituan.lyrebird.client.LyrebirdClient

public class LyrebirdClient
extends Object

Constructor Summary

Constructors

Constructor and Description
LyrebirdClient(String lyrebirdRemoteAddress)

Method Summary

Modifier and Type	Method and Description
void	activate(Method method) Activate lyrebird mock data group by @MockData annotation
void	activate(String groupID) Activate lyrebird mock data group by group ID
void	clearFlowList() Clear all flow data
void	deactivate() Deactivate lyrebird mock data group
Events	getEventList(String channel) Get event list by channel
FlowDetail	getFlowDetail(String flowId) Get Lyrebird flow data detail
Flow[]	getFlowList() Get a set of flow data from lyrebird API
LBMockData	getMockData(String dataId) get mock data by data id
io.socket.client.Socket	getSocketInstance(String lyrebirdRemoteAddress) Get an object of socket io
SpeedLimit	getSpeedLimit() get the speed limit bandwidth
void	setSpeedLimit(Bandwidth bandwidth) set the speed limit
Status	status() Get lyrebird services status

Methods inherited from class java.lang.Object

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

Constructor Detail

LyrebirdClient

public LyrebirdClient(String lyrebirdRemoteAddress)

Method Detail

status

public Status status()
              throws LyrebirdClientException

Get lyrebird services status

Returns:

Status

Throws:

LyrebirdClientException

activate

public void activate(String groupID)
              throws LyrebirdClientException

Activate lyrebird mock data group by group ID

Parameters:

groupID -

Throws:

LyrebirdClientException

activate

public void activate(Method method)
              throws LyrebirdClientException

Activate lyrebird mock data group by @MockData annotation

Parameters:

method - test method

Throws:

LyrebirdClientException

deactivate

public void deactivate()
                throws LyrebirdClientException

Deactivate lyrebird mock data group

Throws:

LyrebirdClientException

getFlowList

public Flow[] getFlowList()
                   throws LyrebirdClientException

Get a set of flow data from lyrebird API

Returns:

An array list contains Flows data

Throws:

LyrebirdClientException

getFlowDetail

public FlowDetail getFlowDetail(String flowId)
                         throws LyrebirdClientException

Get Lyrebird flow data detail

Parameters:

flowId - 每条flow data都对应一个ID标识，通过ID可以查询该条数据的详细信息

Returns:

A flow which found by ID

Throws:

LyrebirdClientException

clearFlowList

public void clearFlowList()
                   throws LyrebirdClientException

Clear all flow data

Throws:

LyrebirdClientException

getEventList

public Events getEventList(String channel)
                    throws LyrebirdClientException

Get event list by channel

Parameters:

channel - channel name

Returns:

Events a list of event

Throws:

LyrebirdClientException

getMockData

public LBMockData getMockData(String dataId)
                       throws LyrebirdClientException

get mock data by data id

Parameters:

dataId - mock data id

Returns:

Throws:

LyrebirdClientException

setSpeedLimit

public void setSpeedLimit(Bandwidth bandwidth)
                   throws LyrebirdClientException

set the speed limit

Parameters:

bandwidth - an enum of Bandwidth

Throws:

LyrebirdClientException

getSpeedLimit

public SpeedLimit getSpeedLimit()
                         throws LyrebirdClientException

get the speed limit bandwidth

Returns:

Throws:

LyrebirdClientException

getSocketInstance

public io.socket.client.Socket getSocketInstance(String lyrebirdRemoteAddress)
                                          throws URISyntaxException

Get an object of socket io

Parameters:

lyrebirdRemoteAddress -

Returns:

Throws:

URISyntaxException