cn.leancloud

Class LeanEngine

java.lang.Object

cn.leancloud.LeanEngine

public class LeanEngine
extends Object

Constructor Summary

Constructors

Constructor and Description
LeanEngine() 使用默认参数初始化 Leanngine 对象，applicationId，appKey，masterKey 将从环境变量获取。
LeanEngine(String appId, String appKey, String masterKey, String hookKey, int port, String appEnv) 初始eanngine 对象。

Method Summary

Modifier and Type	Method and Description
String	getAppEnv()
String	getAppId()
String	getAppKey()
String	getMasterKey()
protected Set<String>	getMetaData()
LeanEngine	register(Class[] clazzs) 批量注册云函数或 hook 函数的 class，这些 class 中带有云函数和 hook 函数注解的方法将会在服务启动后生效。
LeanEngine	register(Class<?> clazz) 注册云函数或 hook 函数的 class，这些 class 中带有云函数和 hook 函数注解的方法将会在服务启动后生效。
LeanEngine	setLocalEngineCallEnabled(boolean enabled) 本方法用于本地调试期间，设置为 true 后所有的云函数调用都直接调用本地而非 LeanCloud 上已经部署的项目
LeanEngine	setPort(int port)
LeanEngine	setUseMasterKey(boolean useMasterKey) 设置在与 LeanCloud 服务器进行沟通的时候是否使用 masterKey
LeanEngine	start() 开始监听端口并提供云函数服务。请在所有配置设置完成，所有云函数 class 都注册之后调用该方法。
void	stop()
LeanEngine	useAVCloudCN() 可以通过改方法明确设置 SDK 调用国内节点服务，否则将根据 appId 自动判断。
LeanEngine	useAVCloudUS() 可以通过改方法明确设置 SDK 调用北美节点服务，否则将根据 appId 自动判断。

Methods inherited from class java.lang.Object

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

Constructor Detail

LeanEngine

public LeanEngine()

使用默认参数初始化 Leanngine 对象，applicationId，appKey，masterKey 将从环境变量获取。

LeanEngine

public LeanEngine(String appId,
                  String appKey,
                  String masterKey,
                  String hookKey,
                  int port,
                  String appEnv)

初始eanngine 对象。

Parameters:

appId - 从 LeanCloud 控制台获取 appId。

appKey - 从 LeanCloud 控制台获取 appKey。

masterKey - 从 LeanCloud 控制台获取 masterKey。

hookKey - 从云引擎环境变量 LEANCLOUD_APP_HOOK_KEY 中获取。

port - 云函数服务监听的端口。

appEnv - 运行环境，development 为开发环境；production 为生产环境。

Method Detail

register

public LeanEngine register(Class[] clazzs)

批量注册云函数或 hook 函数的 class，这些 class 中带有云函数和 hook 函数注解的方法将会在服务启动后生效。

Parameters:

clazzs - 有云函数方法的 class 数组

Returns:

self

register

public LeanEngine register(Class<?> clazz)

注册云函数或 hook 函数的 class，这些 class 中带有云函数和 hook 函数注解的方法将会在服务启动后生效。

Parameters:

clazz - 有云函数方法的 class

Returns:

self

setPort

public LeanEngine setPort(int port)

start

public LeanEngine start()
                 throws Exception

开始监听端口并提供云函数服务。请在所有配置设置完成，所有云函数 class 都注册之后调用该方法。

Returns:

self

Throws:

Exception

stop

public void stop()
          throws Exception

Throws:

Exception

setLocalEngineCallEnabled

public LeanEngine setLocalEngineCallEnabled(boolean enabled)

本方法用于本地调试期间，设置为 true 后所有的云函数调用都直接调用本地而非 LeanCloud 上已经部署的项目

Parameters:

enabled - true 为调用本地云函数; false 为调用服务端云函数

Returns:

self

setUseMasterKey

public LeanEngine setUseMasterKey(boolean useMasterKey)

设置在与 LeanCloud 服务器进行沟通的时候是否使用 masterKey

使用 masterKey 时， API 将拥有全部权限，不再受到权限的限制

Parameters:

useMasterKey - true 为使用 masterKey 发送请求

Returns:

self

getMetaData

protected Set<String> getMetaData()

getAppId

public String getAppId()

getAppKey

public String getAppKey()

getMasterKey

public String getMasterKey()

getAppEnv

public String getAppEnv()

useAVCloudUS

public LeanEngine useAVCloudUS()

可以通过改方法明确设置 SDK 调用北美节点服务，否则将根据 appId 自动判断。

Returns:

self

useAVCloudCN

public LeanEngine useAVCloudCN()

可以通过改方法明确设置 SDK 调用国内节点服务，否则将根据 appId 自动判断。

Returns:

self