org.opencms.ade.galleries

类 CmsGalleryService

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

com.google.gwt.user.server.rpc.RemoteServiceServlet

org.opencms.gwt.CmsGwtService

org.opencms.ade.galleries.CmsGalleryService

所有已实现的接口:

com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, I_CmsGalleryService

public class CmsGalleryService
extends CmsGwtService
implements I_CmsGalleryService

Handles all RPC services related to the gallery dialog.

从以下版本开始:

8.0.0

另请参阅:

CmsGalleryService, I_CmsGalleryService, I_CmsGalleryServiceAsync, 序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
protected class	CmsGalleryService.CmsGalleryTypeInfo Gallery info object.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	KEY_LAST_USED_GALLERY_ADEVIEW The key used for storing the last used gallery in adeview mode.

从类继承的字段 com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

perThreadRequest, perThreadResponse

构造器概要

构造器

构造器和说明
CmsGalleryService()

方法概要

方法

限定符和类型	方法和说明
void	deleteResource(java.lang.String resourcePath) Deletes the given resource.
CmsGalleryConfiguration	getAdeViewModeConfiguration() Loads the gallery configuration for the adeView mode.
java.util.List<CmsGalleryFolderBean>	getGalleries(java.util.List<java.lang.String> resourceTypes) Returns the available galleries depending on the given resource types.
CmsResultItemBean	getInfoForResource(java.lang.String linkPath, java.lang.String locale) Returns the resource info for a single resource.
CmsGalleryDataBean	getInitialSettings(CmsGalleryConfiguration conf) Returns the initial data for the given gallery mode.
static CmsGalleryDataBean	getInitialSettings(javax.servlet.http.HttpServletRequest request, CmsGalleryConfiguration config) Returns the initial gallery settings.
CmsGallerySearchBean	getSearch(CmsGalleryDataBean data) Performs an initial search based on the given data bean and the available parameters of the request.
CmsGallerySearchBean	getSearch(CmsGallerySearchBean searchObj) Returns the gallery search object containing search results and the currant search parameter.
static CmsGallerySearchBean	getSearch(javax.servlet.http.HttpServletRequest request, CmsGalleryDataBean config) Returns the initial search data.
protected java.util.List<CmsResource>	getSitemapSubEntryResources(java.lang.String rootPath) Gets the sitemap sub entries for a given path as resources.
java.util.List<CmsSitemapEntryBean>	getSubEntries(java.lang.String rootPath, boolean isRoot) Returns the sub entries to the given sitemap path.
protected java.util.List<CmsSitemapEntryBean>	getSubEntriesInternal(java.lang.String rootPath, boolean isRoot) Internal method for getting sitemap sub entries for a given root path.
java.util.List<CmsVfsEntryBean>	getSubFolders(java.lang.String rootPath) Gets the sub-folders of a folder.
protected java.util.List<java.lang.String>	getTypeNames(CmsGalleryDataBean data) Gets the type names from the gallery data bean.
protected boolean	isSitemapEntry(CmsObject cms, CmsResource resource) Checks whether a given resource is a sitemap entry.
CmsVfsEntryBean	loadVfsEntryBean(java.lang.String path) Loads the root VFS entry bean for the given site root.
protected java.util.List<CmsResource>	readAll(java.util.Collection<CmsUUID> structureIds, CmsResourceFilter filter) Reads the resources for a collection of structure ids and returns the list of resources which could be read.
void	saveTreeOpenState(java.lang.String treeName, java.lang.String treeToken, java.lang.String siteRoot, java.util.Set<CmsUUID> openItems) Saves the tree open state for a tree tab.
void	updateIndex() Updates the offline indices.

从类继承的方法 org.opencms.gwt.CmsGwtService

checkPermissions, clearThreadStorage, doGetSerializationPolicy, doUnexpectedFailure, ensureLock, ensureLock, ensureLock, ensureSession, error, getCmsObject, getPropertiesByName, getRequest, getResponse, log, log, logError, service, setCms, setContext, setRequest, setResponse, tryUnlock

从类继承的方法 com.google.gwt.user.server.rpc.RemoteServiceServlet

checkPermutationStrongName, getSerializationPolicy, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processPost, shouldCompressResponse

从类继承的方法 com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

从类继承的方法 javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service

从类继承的方法 javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init

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

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

字段详细资料

KEY_LAST_USED_GALLERY_ADEVIEW

public static final java.lang.String KEY_LAST_USED_GALLERY_ADEVIEW

The key used for storing the last used gallery in adeview mode.

另请参阅:

常量字段值

构造器详细资料

CmsGalleryService

public CmsGalleryService()

方法详细资料

getInitialSettings

public static CmsGalleryDataBean getInitialSettings(javax.servlet.http.HttpServletRequest request,
                                    CmsGalleryConfiguration config)
                                             throws CmsRpcException

Returns the initial gallery settings.

参数:

request - the current request

config - the gallery configuration

返回:

the initial gallery settings

抛出:

CmsRpcException - if something goes wrong

getSearch

public static CmsGallerySearchBean getSearch(javax.servlet.http.HttpServletRequest request,
                             CmsGalleryDataBean config)

Returns the initial search data.

参数:

request - the current request

config - the gallery configuration

返回:

the search data

deleteResource

public void deleteResource(java.lang.String resourcePath)
                    throws CmsRpcException

从接口复制的说明: I_CmsGalleryService

Deletes the given resource.

指定者:

deleteResource 在接口中 I_CmsGalleryService

参数:

resourcePath - the resource path of the resource to delete

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsGalleryService.deleteResource(java.lang.String)

getAdeViewModeConfiguration

public CmsGalleryConfiguration getAdeViewModeConfiguration()

从接口复制的说明: I_CmsGalleryService

Loads the gallery configuration for the adeView mode.

指定者:

getAdeViewModeConfiguration 在接口中 I_CmsGalleryService

返回:

the gallery configuration

另请参阅:

I_CmsGalleryService.getAdeViewModeConfiguration()

getGalleries

public java.util.List<CmsGalleryFolderBean> getGalleries(java.util.List<java.lang.String> resourceTypes)

从接口复制的说明: I_CmsGalleryService

Returns the available galleries depending on the given resource types.

指定者:

getGalleries 在接口中 I_CmsGalleryService

参数:

resourceTypes - the resource types

返回:

the galleries

另请参阅:

I_CmsGalleryService.getGalleries(java.util.List)

getInfoForResource

public CmsResultItemBean getInfoForResource(java.lang.String linkPath,
                                   java.lang.String locale)
                                     throws CmsRpcException

从接口复制的说明: I_CmsGalleryService

Returns the resource info for a single resource.

指定者:

getInfoForResource 在接口中 I_CmsGalleryService

参数:

linkPath - the resource path

locale - the content locale

返回:

the resource info

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsGalleryService.getInfoForResource(java.lang.String, java.lang.String)

getInitialSettings

public CmsGalleryDataBean getInitialSettings(CmsGalleryConfiguration conf)
                                      throws CmsRpcException

从接口复制的说明: I_CmsGalleryService

Returns the initial data for the given gallery mode.

指定者:

getInitialSettings 在接口中 I_CmsGalleryService

参数:

conf - the gallery configuration

返回:

the data bean

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsGalleryService.getInitialSettings(org.opencms.ade.galleries.shared.CmsGalleryConfiguration)

getSearch

public CmsGallerySearchBean getSearch(CmsGalleryDataBean data)

从接口复制的说明: I_CmsGalleryService

Performs an initial search based on the given data bean and the available parameters of the request.

指定者:

getSearch 在接口中 I_CmsGalleryService

参数:

data - the data bean

返回:

the search result

另请参阅:

I_CmsGalleryService.getSearch(org.opencms.ade.galleries.shared.CmsGalleryDataBean)

getSearch

public CmsGallerySearchBean getSearch(CmsGallerySearchBean searchObj)
                               throws CmsRpcException

从接口复制的说明: I_CmsGalleryService

Returns the gallery search object containing search results and the currant search parameter.

指定者:

getSearch 在接口中 I_CmsGalleryService

参数:

searchObj - the current search object

返回:

the search object containing search results

抛出:

CmsRpcException - is something goes wrong

另请参阅:

I_CmsGalleryService.getSearch(CmsGallerySearchBean)

getSubEntries

public java.util.List<CmsSitemapEntryBean> getSubEntries(java.lang.String rootPath,
                                                boolean isRoot)
                                                  throws CmsRpcException

从接口复制的说明: I_CmsGalleryService

Returns the sub entries to the given sitemap path.

指定者:

getSubEntries 在接口中 I_CmsGalleryService

参数:

rootPath - the root path

isRoot - true if the requested entry is the root entry

返回:

the sub entries

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsGalleryService.getSubEntries(java.lang.String, boolean)

getSubFolders

public java.util.List<CmsVfsEntryBean> getSubFolders(java.lang.String rootPath)
                                              throws CmsRpcException

从接口复制的说明: I_CmsGalleryService

Gets the sub-folders of a folder.

指定者:

getSubFolders 在接口中 I_CmsGalleryService

参数:

rootPath - the path of a folder

返回:

beans representing the sub-folders of the folder

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsGalleryService.getSubFolders(java.lang.String)

loadVfsEntryBean

public CmsVfsEntryBean loadVfsEntryBean(java.lang.String path)
                                 throws CmsRpcException

从接口复制的说明: I_CmsGalleryService

Loads the root VFS entry bean for the given site root.

指定者:

loadVfsEntryBean 在接口中 I_CmsGalleryService

参数:

path - the site root

返回:

the root VFS entry bean for the given site root

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsGalleryService.loadVfsEntryBean(java.lang.String)

saveTreeOpenState

public void saveTreeOpenState(java.lang.String treeName,
                     java.lang.String treeToken,
                     java.lang.String siteRoot,
                     java.util.Set<CmsUUID> openItems)
                       throws CmsRpcException

从接口复制的说明: I_CmsGalleryService

Saves the tree open state for a tree tab.

指定者:

saveTreeOpenState 在接口中 I_CmsGalleryService

参数:

treeName - the tree name for which to save the tree state

treeToken - the tree token for which to save the tree state

siteRoot - the site root

openItems - the set of structure ids of open tree items

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsGalleryService.saveTreeOpenState(java.lang.String, java.lang.String, java.lang.String, java.util.Set)

updateIndex

public void updateIndex()
                 throws CmsRpcException

从接口复制的说明: I_CmsGalleryService

Updates the offline indices.

指定者:

updateIndex 在接口中 I_CmsGalleryService

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsGalleryService.updateIndex()

getSitemapSubEntryResources

protected java.util.List<CmsResource> getSitemapSubEntryResources(java.lang.String rootPath)
                                                           throws CmsException

Gets the sitemap sub entries for a given path as resources.

参数:

rootPath - the root path

返回:

the sitemap sub entry resources

抛出:

CmsException - if something goes wrong

getSubEntriesInternal

protected java.util.List<CmsSitemapEntryBean> getSubEntriesInternal(java.lang.String rootPath,
                                                        boolean isRoot)
                                                             throws CmsException

Internal method for getting sitemap sub entries for a given root path.

参数:

rootPath - the root path

isRoot - true if this method is used to get the root entries of a sitemap

返回:

the list of sitemap sub-entry beans

抛出:

CmsException - if something goes wrong

getTypeNames

protected java.util.List<java.lang.String> getTypeNames(CmsGalleryDataBean data)

Gets the type names from the gallery data bean.

参数:

data - the gallery data bean

返回:

the type names

isSitemapEntry

protected boolean isSitemapEntry(CmsObject cms,
                     CmsResource resource)
                          throws CmsException

Checks whether a given resource is a sitemap entry.

This is used for preselected entries in the gallery widget.

参数:

cms - the current CMS context

resource - the resource to check

返回:

true if the resource is a sitemap entry

抛出:

CmsException - if something goes wrong

readAll

protected java.util.List<CmsResource> readAll(java.util.Collection<CmsUUID> structureIds,
                                  CmsResourceFilter filter)

Reads the resources for a collection of structure ids and returns the list of resources which could be read.

参数:

structureIds - the structure ids for which we want to read the resources

filter - the filter used to read the resource

返回:

the list of resources for the given structure id