org.opencms.ade.sitemap

类 CmsVfsSitemapService

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.sitemap.CmsVfsSitemapService

所有已实现的接口:

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

public class CmsVfsSitemapService
extends CmsGwtService
implements I_CmsSitemapService

Handles all RPC services related to the vfs sitemap.

从以下版本开始:

8.0.0

另请参阅:

I_CmsSitemapService, I_CmsSitemapServiceAsync, 序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
protected class	CmsVfsSitemapService.LockInfo Helper class for representing information about a lock.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	ALIAS_DOWNLOAD_PATH The path of the JSP used to download aliases.
static java.lang.String	ALIAS_IMPORT_PATH The path to the JSP used to upload aliases.
static java.lang.String	KEY_FUNCTION_DETAIL The configuration key for the functionDetail attribute in the container.info property.

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

perThreadRequest, perThreadResponse

构造器概要

构造器

构造器和说明
CmsVfsSitemapService()

方法概要

方法

限定符和类型	方法和说明
static java.lang.String	addAliasImportResult(java.util.List<CmsAliasImportResult> results) Adds an alias import result.
protected CmsBrokenLinkBean	createSitemapBrokenLinkBean(CmsResource resource) Creates a "broken link" bean based on a resource.
CmsSitemapChange	createSubSitemap(CmsUUID entryId) Creates a sub-sitemap of the given sitemap starting from the given entry.
protected CmsVfsSitemapService.LockInfo	ensureLockAndGetInfo(CmsResource resource) Locks the given resource with a temporary, if not already locked by the current user.
java.util.List<CmsAliasImportResult>	getAliasImportResult(java.lang.String resultKey) Gets the alias import results from the server.
CmsAliasInitialFetchResult	getAliasTable() Gets the initial data for the bulk alias editor.
CmsClientSitemapEntry	getChildren(java.lang.String entryPointUri, CmsUUID entryId, int levels) Returns the sitemap children for the given path.
CmsSitemapChange	mergeSubSitemap(java.lang.String entryPoint, CmsUUID subSitemapId) Merges a sub-sitemap into it's parent sitemap.
static CmsSitemapData	prefetch(javax.servlet.http.HttpServletRequest request, java.lang.String sitemapUri) Fetches the sitemap data.
CmsSitemapData	prefetch(java.lang.String sitemapUri) Returns the initialization data for the given sitemap.
CmsSitemapChange	save(java.lang.String entryPoint, CmsSitemapChange change) Saves the change to the given sitemap.
CmsAliasEditValidationReply	saveAliases(CmsAliasSaveValidationRequest saveRequest) Saves the aliases for the bulk alias editor.
protected CmsSitemapChange	saveInternal(java.lang.String entryPoint, CmsSitemapChange change) Internal method for saving a sitemap.
CmsSitemapChange	saveSync(java.lang.String entryPoint, CmsSitemapChange change) Saves the change to the given sitemap.
void	updateAliasEditorStatus(boolean editing) Updates the alias editor status.
CmsAliasEditValidationReply	validateAliases(CmsAliasEditValidationRequest validationRequest) Validates the aliases for the bulk alias editor.
CmsRewriteAliasValidationReply	validateRewriteAliases(CmsRewriteAliasValidationRequest validationRequest) Validates rewrite aliases.

从类继承的方法 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

字段详细资料

ALIAS_DOWNLOAD_PATH

public static final java.lang.String ALIAS_DOWNLOAD_PATH

The path of the JSP used to download aliases.

另请参阅:

常量字段值

ALIAS_IMPORT_PATH

public static final java.lang.String ALIAS_IMPORT_PATH

The path to the JSP used to upload aliases.

另请参阅:

常量字段值

KEY_FUNCTION_DETAIL

public static final java.lang.String KEY_FUNCTION_DETAIL

The configuration key for the functionDetail attribute in the container.info property.

另请参阅:

常量字段值

构造器详细资料

CmsVfsSitemapService

public CmsVfsSitemapService()

方法详细资料

addAliasImportResult

public static java.lang.String addAliasImportResult(java.util.List<CmsAliasImportResult> results)

Adds an alias import result.

参数:

results - the list of alias import results to add

返回:

the key to retrieve the alias import results

prefetch

public static CmsSitemapData prefetch(javax.servlet.http.HttpServletRequest request,
                      java.lang.String sitemapUri)
                               throws CmsRpcException

Fetches the sitemap data.

参数:

request - the current request

sitemapUri - the site relative path

返回:

the sitemap data

抛出:

CmsRpcException - if something goes wrong

createSubSitemap

public CmsSitemapChange createSubSitemap(CmsUUID entryId)
                                  throws CmsRpcException

从接口复制的说明: I_CmsSitemapService

Creates a sub-sitemap of the given sitemap starting from the given entry.

指定者:

createSubSitemap 在接口中 I_CmsSitemapService

参数:

entryId - the structure id of the sitemap entry to create a sub sitemap of

返回:

the sub-sitemap creation result

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsSitemapService.createSubSitemap(org.opencms.util.CmsUUID)

getAliasImportResult

public java.util.List<CmsAliasImportResult> getAliasImportResult(java.lang.String resultKey)

从接口复制的说明: I_CmsSitemapService

Gets the alias import results from the server.

指定者:

getAliasImportResult 在接口中 I_CmsSitemapService

参数:

resultKey - the key which identifies the alias import results to get

返回:

the list of alias import results

另请参阅:

I_CmsSitemapService.getAliasImportResult(java.lang.String)

getAliasTable

public CmsAliasInitialFetchResult getAliasTable()
                                         throws CmsRpcException

从接口复制的说明: I_CmsSitemapService

Gets the initial data for the bulk alias editor.

指定者:

getAliasTable 在接口中 I_CmsSitemapService

返回:

the initial data for the alias editor

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsSitemapService.getAliasTable()

getChildren

public CmsClientSitemapEntry getChildren(java.lang.String entryPointUri,
                                CmsUUID entryId,
                                int levels)
                                  throws CmsRpcException

从接口复制的说明: I_CmsSitemapService

Returns the sitemap children for the given path.

指定者:

getChildren 在接口中 I_CmsSitemapService

参数:

entryPointUri - the URI of the sitemap entry point

entryId - the entry id

levels - the count of child levels to read

返回:

the sitemap children

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsSitemapService.getChildren(java.lang.String, org.opencms.util.CmsUUID, int)

mergeSubSitemap

public CmsSitemapChange mergeSubSitemap(java.lang.String entryPoint,
                               CmsUUID subSitemapId)
                                 throws CmsRpcException

从接口复制的说明: I_CmsSitemapService

Merges a sub-sitemap into it's parent sitemap.

指定者:

mergeSubSitemap 在接口中 I_CmsSitemapService

参数:

entryPoint - the sitemap entry point

subSitemapId - the structure id of the sub sitemap folder

返回:

the result of the merge operation

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsSitemapService.mergeSubSitemap(java.lang.String, org.opencms.util.CmsUUID)

prefetch

public CmsSitemapData prefetch(java.lang.String sitemapUri)
                        throws CmsRpcException

从接口复制的说明: I_CmsSitemapService

Returns the initialization data for the given sitemap.

指定者:

prefetch 在接口中 I_CmsSitemapService

参数:

sitemapUri - the site relative path

返回:

the initialization data

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsSitemapService.prefetch(java.lang.String)

save

public CmsSitemapChange save(java.lang.String entryPoint,
                    CmsSitemapChange change)
                      throws CmsRpcException

从接口复制的说明: I_CmsSitemapService

Saves the change to the given sitemap.

指定者:

save 在接口中 I_CmsSitemapService

参数:

entryPoint - the sitemap URI

change - the change to save

返回:

the updated change

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsSitemapService.save(java.lang.String, org.opencms.ade.sitemap.shared.CmsSitemapChange)

saveAliases

public CmsAliasEditValidationReply saveAliases(CmsAliasSaveValidationRequest saveRequest)
                                        throws CmsRpcException

从接口复制的说明: I_CmsSitemapService

Saves the aliases for the bulk alias editor.

指定者:

saveAliases 在接口中 I_CmsSitemapService

参数:

saveRequest - the object containing the data to save

返回:

the result of saving the aliases

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsSitemapService.saveAliases(org.opencms.gwt.shared.alias.CmsAliasSaveValidationRequest)

saveSync

public CmsSitemapChange saveSync(java.lang.String entryPoint,
                        CmsSitemapChange change)
                          throws CmsRpcException

从接口复制的说明: I_CmsSitemapService

Saves the change to the given sitemap.

指定者:

saveSync 在接口中 I_CmsSitemapService

参数:

entryPoint - the sitemap URI

change - the change to save

返回:

the updated change

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsSitemapService.saveSync(java.lang.String, org.opencms.ade.sitemap.shared.CmsSitemapChange)

updateAliasEditorStatus

public void updateAliasEditorStatus(boolean editing)

从接口复制的说明: I_CmsSitemapService

Updates the alias editor status.

This is used to keep two users from editing the alias table for a site root concurrently.

指定者:

updateAliasEditorStatus 在接口中 I_CmsSitemapService

参数:

editing - true to indicate that the table is still being edited, false to indicate that the table isn't being edited anymore

另请参阅:

I_CmsSitemapService.updateAliasEditorStatus(boolean)

validateAliases

public CmsAliasEditValidationReply validateAliases(CmsAliasEditValidationRequest validationRequest)

从接口复制的说明: I_CmsSitemapService

Validates the aliases for the bulk alias editor.

指定者:

validateAliases 在接口中 I_CmsSitemapService

参数:

validationRequest - an object indicating the type of validation to perform

返回:

the validation result

另请参阅:

I_CmsSitemapService.validateAliases(org.opencms.gwt.shared.alias.CmsAliasEditValidationRequest)

validateRewriteAliases

public CmsRewriteAliasValidationReply validateRewriteAliases(CmsRewriteAliasValidationRequest validationRequest)

从接口复制的说明: I_CmsSitemapService

Validates rewrite aliases.

指定者:

validateRewriteAliases 在接口中 I_CmsSitemapService

参数:

validationRequest - the rewrite alias data to validate

返回:

the validation result

另请参阅:

I_CmsSitemapService.validateRewriteAliases(org.opencms.gwt.shared.alias.CmsRewriteAliasValidationRequest)

createSitemapBrokenLinkBean

protected CmsBrokenLinkBean createSitemapBrokenLinkBean(CmsResource resource)
                                                 throws CmsException

Creates a "broken link" bean based on a resource.

参数:

resource - the resource

返回:

the "broken link" bean with the data from the resource

抛出:

CmsException - if something goes wrong

ensureLockAndGetInfo

protected CmsVfsSitemapService.LockInfo ensureLockAndGetInfo(CmsResource resource)
                                                      throws CmsException

Locks the given resource with a temporary, if not already locked by the current user. Will throw an exception if the resource could not be locked for the current user.

参数:

resource - the resource to lock

返回:

the assigned lock

抛出:

CmsException - if the resource could not be locked

saveInternal

protected CmsSitemapChange saveInternal(java.lang.String entryPoint,
                            CmsSitemapChange change)
                                 throws CmsException

Internal method for saving a sitemap.

参数:

entryPoint - the URI of the sitemap to save

change - the change to save

返回:

list of changed sitemap entries

抛出:

CmsException