com.seeyon.ctp.rest.resources

类 BaseResource

java.lang.Object

com.seeyon.ctp.rest.resources.BaseResource

直接已知子类:

ApplogResource, ArchiveResource, AttachmentResource, CmpBaseResource, CommonImageResource, CtpFormComponentResource, EnumReferenceResource, GlobalResource, JavaScriptStubResource, MediaResource, MetricsResource, NodePrintResource, OfficeTransResource, OfficeTransTypeResource, PerformanceConfigResource, ProductResource, PublicQrCodeResource, RecordLogResource, SearchHistoryResource, SecretLevelBaseResource, SessionResource, TestResource, TokenResource, TransSecurityEnvResource, WaterMarkResource

public class BaseResource
extends java.lang.Object

构造器概要

构造器

构造器和说明
BaseResource()

方法概要

限定符和类型	方法和说明
protected <T> T	copyProperties(java.util.Map data, T bean)
protected java.lang.String	decode(java.lang.String in)
protected javax.ws.rs.core.Response	error(java.lang.Throwable e)
protected javax.ws.rs.core.Response	fail(java.lang.String message)
protected javax.ws.rs.core.Response	fail(java.lang.String message, int code) 调整 rest 返回的格式方式: 之前只是处理了正常情况，不能访问的情况(缺少权限)， 一些错误的情况没做返回，比如报 404、500 会致使返回的信息不友好，调用方适配困难; 调整之后，会对所有失败(权限、404、500等等)的信息进行格式统一的返回 by helgen 20191107
protected com.seeyon.ctp.util.FlipInfo	getFlipInfo()
protected com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
protected java.lang.String	getToken()
protected <T> T	judgeSortId(java.util.Map data, com.seeyon.ctp.organization.bo.V3xOrgEntity bean) 判断当前对象是否设置了sortId,如果没有设置设置为NULL(因为创建对象判断根据NULL判断设置最大sortId)
protected javax.ws.rs.core.Response	noContent()
protected javax.ws.rs.core.Response	ok(java.lang.Object o) 已过时。 请使用success方法。
protected void	required(java.lang.Object o, java.lang.String fieldName)
protected void	required(java.lang.Object o, java.lang.String[] fieldNames)
protected void	setCurrentUser(java.lang.Long memberid) 已过时。 废弃不再使用 @since v8.1SP2
protected void	setPagination()
protected com.seeyon.ctp.common.authenticate.domain.User	setVirtualUser() 设置Rest接口上下文虚拟账号
protected javax.ws.rs.core.Response	status(int status)
protected javax.ws.rs.core.Response	status(int status, java.lang.Object entity)
protected javax.ws.rs.core.Response	success(java.lang.Object o) 成功
protected javax.ws.rs.core.Response	success(java.lang.Object o, java.lang.String message)
protected javax.ws.rs.core.Response	success(java.lang.Object o, java.lang.String message, int code)
protected java.lang.String	toJSON(java.lang.Object bean)
protected java.lang.String	toJSON(java.lang.Object bean, java.lang.String... ignoreProperties) 过滤指定属性列表。

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

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

构造器详细资料

BaseResource

public BaseResource()

方法详细资料

success

protected javax.ws.rs.core.Response success(java.lang.Object o)

成功

参数:

o -

返回:

success

protected javax.ws.rs.core.Response success(java.lang.Object o,
                                            java.lang.String message)

success

protected javax.ws.rs.core.Response success(java.lang.Object o,
                                            java.lang.String message,
                                            int code)

fail

protected javax.ws.rs.core.Response fail(java.lang.String message,
                                         int code)

调整 rest 返回的格式方式: 之前只是处理了正常情况，不能访问的情况(缺少权限)， 一些错误的情况没做返回，比如报 404、500 会致使返回的信息不友好，调用方适配困难; 调整之后，会对所有失败(权限、404、500等等)的信息进行格式统一的返回 by helgen 20191107

参数:

message -

code -

返回:

fail

protected javax.ws.rs.core.Response fail(java.lang.String message)

ok

protected javax.ws.rs.core.Response ok(java.lang.Object o)

已过时。 请使用success方法。

参数:

o -

返回:

error

protected javax.ws.rs.core.Response error(java.lang.Throwable e)

status

protected javax.ws.rs.core.Response status(int status)

status

protected javax.ws.rs.core.Response status(int status,
                                           java.lang.Object entity)

noContent

protected javax.ws.rs.core.Response noContent()

getToken

protected java.lang.String getToken()

copyProperties

protected <T> T copyProperties(java.util.Map data,
                               T bean)

decode

protected java.lang.String decode(java.lang.String in)
                           throws com.seeyon.ctp.common.exceptions.BusinessException

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

required

protected void required(java.lang.Object o,
                        java.lang.String fieldName)
                 throws com.seeyon.ctp.common.exceptions.BusinessException,
                        java.lang.IllegalAccessException,
                        java.lang.reflect.InvocationTargetException,
                        java.lang.NoSuchMethodException

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.NoSuchMethodException

required

protected void required(java.lang.Object o,
                        java.lang.String[] fieldNames)
                 throws com.seeyon.ctp.common.exceptions.BusinessException,
                        java.lang.IllegalAccessException,
                        java.lang.reflect.InvocationTargetException,
                        java.lang.NoSuchMethodException

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.NoSuchMethodException

setPagination

protected void setPagination()

getFlipInfo

protected com.seeyon.ctp.util.FlipInfo getFlipInfo()

getObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

toJSON

protected java.lang.String toJSON(java.lang.Object bean)

toJSON

protected java.lang.String toJSON(java.lang.Object bean,
                                  java.lang.String... ignoreProperties)

过滤指定属性列表。

参数:

bean -

ignoreProperties -

返回:

setCurrentUser

protected void setCurrentUser(java.lang.Long memberid)
                       throws com.seeyon.ctp.common.exceptions.BusinessException

已过时。 废弃不再使用 @since v8.1SP2

设置当前人员

参数:

memberid -

抛出:

com.seeyon.ctp.common.exceptions.BusinessException

另请参阅:

setVirtualUser(), UserUtil#buildVirtualUser(VirtualUser), UserUtil.buildMocklUser(long)

setVirtualUser

protected com.seeyon.ctp.common.authenticate.domain.User setVirtualUser()

设置Rest接口上下文虚拟账号

从以下版本开始:

V5 V8.2

judgeSortId

protected <T> T judgeSortId(java.util.Map data,
                            com.seeyon.ctp.organization.bo.V3xOrgEntity bean)

判断当前对象是否设置了sortId,如果没有设置设置为NULL(因为创建对象判断根据NULL判断设置最大sortId)