smartbi.sdk

类 ClientConnector

java.lang.Object

smartbi.sdk.ClientConnector

所有已实现的接口:

smartbi.sdk.IClientConnector

直接已知子类:

CASClientConnector

public class ClientConnector
extends java.lang.Object
implements smartbi.sdk.IClientConnector

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();

构造器概要

构造器

构造器和说明
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() 获取语言环境
java.util.Map<java.lang.String,java.lang.String>	getRequestParams()
javax.servlet.http.HttpSession	getSession()
java.lang.String	getSmartbiUrl()
int	getTimeout() 超时时间
static boolean	getTrustAny()
void	noop()
boolean	open(java.lang.String user, java.lang.String password) 打开Smartbi连接
boolean	openFromDB(java.lang.String user, java.lang.String password) 打开Smartbi连接, 直接从数据库登陆
boolean	openFromToken(java.util.Map<java.lang.String,java.lang.String> params) Open from token.
boolean	openFromToken(java.lang.String loginToken) Open from token.
smartbi.sdk.InvokeResult	remoteInvoke(java.lang.String classname, java.lang.String method, java.lang.Object[] params) 远程调用接口
smartbi.sdk.InvokeResult	remoteMultipartInvoke(java.lang.String classname, java.lang.String method, java.lang.Object[] params) 远程调用接口，参数使用Multipart data提交。
void	setCookie(java.lang.String cookie)
void	setDefaultRequestHeader(java.lang.String key, java.lang.String value) 设置请求头信息
void	setLocale(java.util.Locale locale) 设置语言环境
void	setRequestParams(java.util.Map<java.lang.String,java.lang.String> requestParams)
void	setTimeout(int timeout) 超时时间
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.String	upload(java.lang.String src, java.util.Map<java.lang.String,java.lang.String> params, java.util.Map<java.lang.String,java.io.File> fileMap)

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

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

构造器详细资料

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 javax.servlet.http.HttpSession getSession()

指定者:

getSession 在接口中 smartbi.sdk.IClientConnector

getTrustAny

public static boolean getTrustAny()

返回:

是否信任任何人

setTrustAny

public static void setTrustAny(boolean trustAny)

参数:

trustAny - 是否信任任何人

getLocale

public java.util.Locale getLocale()

获取语言环境

指定者:

getLocale 在接口中 smartbi.sdk.IClientConnector

返回:

locale

setLocale

public void setLocale(java.util.Locale locale)

设置语言环境

指定者:

setLocale 在接口中 smartbi.sdk.IClientConnector

参数:

locale - locale

getSmartbiUrl

public java.lang.String getSmartbiUrl()

open

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

打开Smartbi连接

指定者:

open 在接口中 smartbi.sdk.IClientConnector

参数:

user - 用户名

password - 密码

返回:

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

openFromToken

public boolean openFromToken(java.lang.String loginToken)

Open from token.

参数:

loginToken - the login token

返回:

true, if successful

openFromToken

public boolean openFromToken(java.util.Map<java.lang.String,java.lang.String> params)

Open from token.

参数:

params - loginToken and extra parameters

返回:

true, if successful

setDefaultRequestHeader

public void setDefaultRequestHeader(java.lang.String key,
                                    java.lang.String value)

设置请求头信息

指定者:

setDefaultRequestHeader 在接口中 smartbi.sdk.IClientConnector

参数:

key - key

value - value

testConnection

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

测试url页面的连通性

指定者:

testConnection 在接口中 smartbi.sdk.IClientConnector

参数:

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

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

返回:

true/false

openFromDB

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

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

指定者:

openFromDB 在接口中 smartbi.sdk.IClientConnector

参数:

user - 用户名

password - 密码

返回:

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

switchUser

public boolean switchUser(java.lang.String user)

切换用户

指定者:

switchUser 在接口中 smartbi.sdk.IClientConnector

参数:

user - 用户名

返回:

是否切换成功

close

public void close()

关闭Smartbi连接

指定者:

close 在接口中 smartbi.sdk.IClientConnector

remoteInvoke

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

远程调用接口

指定者:

remoteInvoke 在接口中 smartbi.sdk.IClientConnector

参数:

classname - 调用的Smartbi接口类名

method - 调用的方法名

params - 需要的参数

返回:

InvokeResult对象

remoteMultipartInvoke

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

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

指定者:

remoteMultipartInvoke 在接口中 smartbi.sdk.IClientConnector

参数:

classname - 调用的Smartbi接口类名

method - 调用的方法名

params - 需要的参数

返回:

InvokeResult对象

download

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

用于报表导出

指定者:

download 在接口中 smartbi.sdk.IClientConnector

参数:

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)

用于报表导出

指定者:

download 在接口中 smartbi.sdk.IClientConnector

参数:

url - 处理导出Servlet的URL

postData - 指定导出参数

os - 存放导出内容

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

返回:

true/false

noop

public void noop()

指定者:

noop 在接口中 smartbi.sdk.IClientConnector

test

public boolean test()

指定者:

test 在接口中 smartbi.sdk.IClientConnector

返回:

true/false

getTimeout

public int getTimeout()

超时时间

返回:

超时时间

setTimeout

public void setTimeout(int timeout)

超时时间

参数:

timeout - 超时时间

getCookie

public java.lang.String getCookie()

指定者:

getCookie 在接口中 smartbi.sdk.IClientConnector

返回:

cookie

setCookie

public void setCookie(java.lang.String cookie)

指定者:

setCookie 在接口中 smartbi.sdk.IClientConnector

参数:

cookie - cookie

shutdown

public static void shutdown()

getRequestParams

public java.util.Map<java.lang.String,java.lang.String> getRequestParams()

指定者:

getRequestParams 在接口中 smartbi.sdk.IClientConnector

setRequestParams

public void setRequestParams(java.util.Map<java.lang.String,java.lang.String> requestParams)

指定者:

setRequestParams 在接口中 smartbi.sdk.IClientConnector

upload

public java.lang.String upload(java.lang.String src,
                               java.util.Map<java.lang.String,java.lang.String> params,
                               java.util.Map<java.lang.String,java.io.File> fileMap)

指定者:

upload 在接口中 smartbi.sdk.IClientConnector