org.opencms.ade.publish
Class 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

All Implemented Interfaces:

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.

Since:

8.0.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

perThreadRequest, perThreadResponse

Constructor Summary

CmsPublishService()

Method Summary

CmsPublishData	getInitData() Returns the initial publish data.
java.util.List<CmsProjectBean>	getProjects() Gets a list of projects from the server.
java.util.List<CmsPublishGroup>	getPublishGroups(CmsPublishOptions options) Retrieves the publish list, subdivided into groups based on the time of their last change.
CmsPublishOptions	getPublishOptions() Retrieves the publish options.
java.util.List<CmsPublishResource>	publishResources(java.util.List<CmsUUID> toPublish, java.util.List<CmsUUID> toRemove, boolean force) Tries to publish a list of resources.

Methods inherited from class org.opencms.gwt.CmsGwtService

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

Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet

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

Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet

doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsPublishService

public CmsPublishService()

Method Detail

getInitData

public CmsPublishData getInitData()
                           throws CmsRpcException

Description copied from interface: I_CmsPublishService

Returns the initial publish data.

Specified by:

getInitData in interface I_CmsPublishService

Returns:

the initial publish data

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsPublishService.getInitData()

getProjects

public java.util.List<CmsProjectBean> getProjects()
                                           throws CmsRpcException

Description copied from interface: I_CmsPublishService

Gets a list of projects from the server.

Specified by:

getProjects in interface I_CmsPublishService

Returns:

a list of projects

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsPublishService.getProjects()

getPublishGroups

public java.util.List<CmsPublishGroup> getPublishGroups(CmsPublishOptions options)
                                                 throws CmsRpcException

Description copied from interface: I_CmsPublishService

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

Specified by:

getPublishGroups in interface I_CmsPublishService

Parameters:

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

Returns:

the publish list groups

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsPublishService.getPublishGroups(org.opencms.ade.publish.shared.CmsPublishOptions)

getPublishOptions

public CmsPublishOptions getPublishOptions()
                                    throws CmsRpcException

Description copied from interface: I_CmsPublishService

Retrieves the publish options.

Specified by:

getPublishOptions in interface I_CmsPublishService

Returns:

the publish options last used

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsPublishService.getPublishOptions()

publishResources

public java.util.List<CmsPublishResource> publishResources(java.util.List<CmsUUID> toPublish,
                                                           java.util.List<CmsUUID> toRemove,
                                                           boolean force)
                                                    throws CmsRpcException

Description copied from interface: I_CmsPublishService

Tries to publish a list of resources.

Specified by:

publishResources in interface I_CmsPublishService

Parameters:

toPublish - list of IDs of resources to publish

toRemove - list of IDs of resources to remove from the publish list

force - if true, ignore "broken link" problems

Returns:

the resources with problems

Throws:

CmsRpcException - if something goes wrong

See Also:

I_CmsPublishService.publishResources(java.util.List, java.util.List, boolean)