smartbi.sdk

类 ClientConnector

java.lang.Object

smartbi.sdk.ClientConnector

直接已知子类:

CASClientConnector

public class ClientConnector
extends java.lang.Object

Smartbi应用连接类，所有的客户端应用都通过该类提供的remoteInvoke接口，访问Smartbi服务。
例如：
ClientConnector conn = new ClientConnector("http://hostname:port/smartbi" );
boolean loginOK = conn.open("admin", "manager");
conn.remoteInvoke("ServiceClassName", "MethodName", new Object[]{"p1", "p2"});
conn.close();

字段概要

字段

限定符和类型	字段和说明
protected java.lang.String	cookie
protected java.util.Locale	locale
protected java.lang.String	servletUrl
protected HttpSession	session
protected java.lang.String	smartbiUrl

构造器概要

构造器

构造器和说明
ClientConnector(java.lang.String smartbiUrl) 构造函数
ClientConnector(java.lang.String smartbiUrl, java.lang.String servletRelativePath, boolean needNoopTask)

方法概要

限定符和类型	方法和说明
void	close() 关闭Smartbi连接
boolean	download(java.lang.String url, java.lang.String postData, java.io.OutputStream os) 用于报表导出
boolean	download(java.lang.String url, java.lang.String postData, java.io.OutputStream os, boolean throwExceptionIfError) 用于报表导出
java.lang.String	getCookie()
java.util.Locale	getLocale() 获取语言环境
HttpSession	getSession()
static boolean	getTrustAny()
protected InvokeResult	internalInvoke(java.lang.String classname, java.lang.String method, java.lang.String params) 此方法为测试目标，如果改变返回值或方法签名，需要修改相应的测试代码。
void	noop()
protected java.lang.String	obj2JsonStr(java.lang.Object obj) 此方法为测试目标，如果改变返回值或方法签名，需要修改相应的测试代码。
boolean	open(java.lang.String user, java.lang.String password) 打开Smartbi连接
boolean	openFromDB(java.lang.String user, java.lang.String password) 打开Smartbi连接, 直接从数据库登陆
InvokeResult	remoteInvoke(java.lang.String classname, java.lang.String method, java.lang.Object[] params) 远程调用接口
InvokeResult	remoteMultipartInvoke(java.lang.String classname, java.lang.String method, java.lang.Object[] params) 远程调用接口，参数使用Multipart data提交。
void	setCookie(java.lang.String cookie)
void	setLocale(java.util.Locale locale) 设置语言环境
protected void	setSSL(java.net.HttpURLConnection conn)
static void	setTrustAny(boolean trustAny)
static void	shutdown()
boolean	switchUser(java.lang.String user) 切换用户
boolean	test()
boolean	testConnection(java.lang.String url, boolean needOk) 测试url页面的连通性

从类继承的方法 java.lang.Object

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

字段详细资料

session

protected HttpSession session

smartbiUrl

protected java.lang.String smartbiUrl

servletUrl

protected java.lang.String servletUrl

locale

protected java.util.Locale locale

cookie

protected java.lang.String cookie

构造器详细资料

ClientConnector

public ClientConnector(java.lang.String smartbiUrl)

构造函数

参数:

smartbiUrl - 连接Smartbi应用的URL，如："http://hostname:port/smartbi"

ClientConnector

public ClientConnector(java.lang.String smartbiUrl,
                       java.lang.String servletRelativePath,
                       boolean needNoopTask)

参数:

smartbiUrl - url

servletRelativePath - 相对路径

needNoopTask - 是否需要心跳任务

方法详细资料

getSession

public HttpSession getSession()

getTrustAny

public static boolean getTrustAny()

返回:

是否信任任何人

setTrustAny

public static void setTrustAny(boolean trustAny)

参数:

trustAny - 是否信任任何人

getLocale

public java.util.Locale getLocale()

获取语言环境

返回:

locale

setLocale

public void setLocale(java.util.Locale locale)

设置语言环境

参数:

locale - locale

open

public boolean open(java.lang.String user,
                    java.lang.String password)

打开Smartbi连接

参数:

user - 用户名

password - 密码

返回:

连接成功返回true，否则返回false

testConnection

public boolean testConnection(java.lang.String url,
                              boolean needOk)

测试url页面的连通性

参数:

url - 待测试的url地址，为null时使用构造函数的参数进行测试

needOk - 是否需要检查返回值200(OK)

返回:

true/false

setSSL

protected void setSSL(java.net.HttpURLConnection conn)

openFromDB

public boolean openFromDB(java.lang.String user,
                          java.lang.String password)

打开Smartbi连接, 直接从数据库登陆

参数:

user - 用户名

password - 密码

返回:

连接成功返回true，否则返回false

switchUser

public boolean switchUser(java.lang.String user)

切换用户

参数:

user - 用户名

返回:

是否切换成功

close

public void close()

关闭Smartbi连接

remoteInvoke

public InvokeResult remoteInvoke(java.lang.String classname,
                                 java.lang.String method,
                                 java.lang.Object[] params)

远程调用接口

参数:

classname - 调用的Smartbi接口类名

method - 调用的方法名

params - 需要的参数

返回:

InvokeResult对象

remoteMultipartInvoke

public InvokeResult remoteMultipartInvoke(java.lang.String classname,
                                          java.lang.String method,
                                          java.lang.Object[] params)

远程调用接口，参数使用Multipart data提交。

参数:

classname - 调用的Smartbi接口类名

method - 调用的方法名

params - 需要的参数

返回:

InvokeResult对象

download

public boolean download(java.lang.String url,
                        java.lang.String postData,
                        java.io.OutputStream os)

用于报表导出

参数:

url - 处理导出Servlet的URL

postData - 指定导出参数

os - 存放导出内容

返回:

true/false

download

public boolean download(java.lang.String url,
                        java.lang.String postData,
                        java.io.OutputStream os,
                        boolean throwExceptionIfError)

用于报表导出

参数:

url - 处理导出Servlet的URL

postData - 指定导出参数

os - 存放导出内容

throwExceptionIfError - 错误是否是否抛出异常

返回:

true/false

noop

public void noop()

test

public boolean test()

返回:

true/false

internalInvoke

protected InvokeResult internalInvoke(java.lang.String classname,
                                      java.lang.String method,
                                      java.lang.String params)

此方法为测试目标，如果改变返回值或方法签名，需要修改相应的测试代码。

obj2JsonStr

protected java.lang.String obj2JsonStr(java.lang.Object obj)

此方法为测试目标，如果改变返回值或方法签名，需要修改相应的测试代码。

getCookie

public java.lang.String getCookie()

返回:

cookie

setCookie

public void setCookie(java.lang.String cookie)

参数:

cookie - cookie

shutdown

public static void shutdown()