org.opencms.ade.publish

类 CmsPublishService

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.publish.CmsPublishService

所有已实现的接口:

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

public class CmsPublishService
extends CmsGwtService
implements I_CmsPublishService

The implementation of the publish service.

从以下版本开始:

8.0.0

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	PARAM_PUBLISH_PROJECT_ID The publish project id parameter name.
static java.lang.String	PARAM_WORKFLOW_ID The workflow id parameter name.

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

perThreadRequest, perThreadResponse

构造器概要

构造器

构造器和说明
CmsPublishService()

方法概要

方法

限定符和类型	方法和说明
protected void	addSiblings(java.util.Set<CmsResource> publishResources) Adds siblings to a set of publish resources.
CmsWorkflowResponse	executeAction(CmsWorkflowAction action, CmsWorkflowActionParams params) Tries to publish a list of resources.
CmsPublishData	getInitData(java.util.HashMap<java.lang.String,java.lang.String> params) Returns the initial publish data.
CmsPublishGroupList	getResourceGroups(CmsWorkflow workflow, CmsPublishOptions options) Retrieves the publish list, subdivided into groups based on the time of their last change.
CmsPublishOptions	getResourceOptions() Retrieves the publish options.
static CmsPublishData	prefetch(javax.servlet.http.HttpServletRequest request) Fetches the publish data.
static java.lang.String	wrapProjectName(CmsObject cms, java.lang.String name) Wraps the project name in a message string.

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

字段详细资料

PARAM_PUBLISH_PROJECT_ID

public static final java.lang.String PARAM_PUBLISH_PROJECT_ID

The publish project id parameter name.

另请参阅:

常量字段值

PARAM_WORKFLOW_ID

public static final java.lang.String PARAM_WORKFLOW_ID

The workflow id parameter name.

另请参阅:

常量字段值

构造器详细资料

CmsPublishService

public CmsPublishService()

方法详细资料

prefetch

public static CmsPublishData prefetch(javax.servlet.http.HttpServletRequest request)
                               throws CmsRpcException

Fetches the publish data.

参数:

request - the servlet request

返回:

the publish data

抛出:

CmsRpcException - if something goes wrong

wrapProjectName

public static java.lang.String wrapProjectName(CmsObject cms,
                               java.lang.String name)

Wraps the project name in a message string.

参数:

cms - the CMS context

name - the project name

返回:

the message for the given project name

executeAction

public CmsWorkflowResponse executeAction(CmsWorkflowAction action,
                                CmsWorkflowActionParams params)
                                  throws CmsRpcException

从接口复制的说明: I_CmsPublishService

Tries to publish a list of resources.

指定者:

executeAction 在接口中 I_CmsPublishService

参数:

action - the work flow action

params - the data on which to perform the workflow action

返回:

the workflow response

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsPublishService.executeAction(org.opencms.ade.publish.shared.CmsWorkflowAction, org.opencms.ade.publish.shared.CmsWorkflowActionParams)

getInitData

public CmsPublishData getInitData(java.util.HashMap<java.lang.String,java.lang.String> params)
                           throws CmsRpcException

从接口复制的说明: I_CmsPublishService

Returns the initial publish data.

指定者:

getInitData 在接口中 I_CmsPublishService

参数:

params - a map of additional publish parameters

返回:

the initial publish data

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsPublishService.getInitData(java.util.HashMap)

getResourceGroups

public CmsPublishGroupList getResourceGroups(CmsWorkflow workflow,
                                    CmsPublishOptions options)
                                      throws CmsRpcException

从接口复制的说明: I_CmsPublishService

Retrieves the publish list, subdivided into groups based on the time of their last change.

指定者:

getResourceGroups 在接口中 I_CmsPublishService

参数:

workflow - the selected workflow

options - the publish options for which the publish list should be fetched

返回:

the publish list groups

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsPublishService.getResourceGroups(org.opencms.ade.publish.shared.CmsWorkflow,org.opencms.ade.publish.shared.CmsPublishOptions)

getResourceOptions

public CmsPublishOptions getResourceOptions()
                                     throws CmsRpcException

Retrieves the publish options.

返回:

the publish options last used

抛出:

CmsRpcException - if something goes wrong

addSiblings

protected void addSiblings(java.util.Set<CmsResource> publishResources)

Adds siblings to a set of publish resources.

参数:

publishResources - the set to which siblings should be added