Package org.opencms.ade.galleries

Class CmsPreviewService

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

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

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

org.opencms.gwt.CmsGwtService

org.opencms.ade.galleries.CmsPreviewService

All Implemented Interfaces:

com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable, I_CmsPreviewService

public class CmsPreviewService
extends CmsGwtService
implements I_CmsPreviewService

Handles all RPC services related to the gallery preview dialog.

Since:

8.0.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	PATTERN_FOCAL_POINT	Regex used to parse the image.focalpoint property.

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

perThreadRequest, perThreadResponse

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
CmsPreviewService()

Method Summary

Modifier and Type	Method	Description
CmsImageInfoBean	getImageInfo(String resourcePath, String locale)	Returns the image resource data to be displayed in the preview dialog.
static String	getPreviewContent(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, CmsObject cms, CmsResource resource, Locale locale)	Renders the preview content for the given resource and locale.
CmsResourceInfoBean	getResourceInfo(String resourcePath, String locale)	Returns the data to be displayed in the preview dialog.
static CmsPoint	readFocalPoint(CmsObject cms, CmsResource resource)	Reads the focal point from a resource.
void	readResourceInfo(CmsObject cms, CmsResource resource, CmsResourceInfoBean resInfo, String locale)	Retrieves the resource information and puts it into the provided resource info bean.
CmsImageInfoBean	updateImageProperties(String resourcePath, String locale, Map<String,String> properties)	Saves the given properties to the resource and returns the data to be displayed in the preview dialog.
CmsResourceInfoBean	updateResourceProperties(String resourcePath, String locale, Map<String,String> properties)	Saves the given properties to the resource and returns the data to be displayed in the preview dialog.

Methods inherited from class org.opencms.gwt.CmsGwtService

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

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

checkPermutationStrongName, getCodeServerPolicyUrl, getRequestModuleBasePath, getSerializationPolicy, init, loadPolicyFromCodeServer, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processCall, processPost, shouldCompressResponse

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

doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent

Methods inherited from class jakarta.servlet.http.HttpServlet

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

Methods inherited from class jakarta.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Details

PATTERN_FOCAL_POINT

public static final Pattern PATTERN_FOCAL_POINT

Regex used to parse the image.focalpoint property.

Constructor Details

CmsPreviewService

public CmsPreviewService()

Method Details

getPreviewContent

public static String getPreviewContent(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 CmsObject cms,
 CmsResource resource,
 Locale locale)

Renders the preview content for the given resource and locale.

Parameters:

request - the current servlet request

response - the current servlet response

cms - the cms context

resource - the resource

locale - the content locale

Returns:

the rendered HTML preview content

readFocalPoint

public static CmsPoint readFocalPoint(CmsObject cms,
 CmsResource resource)
                               throws CmsException

Reads the focal point from a resource.

Parameters:

cms - the CMS context to use

resource - the resource

Returns:

the focal point (or null, if the focal point property is not set or contains an invalid value)

Throws:

CmsException - if something goes wrong

getImageInfo

public CmsImageInfoBean getImageInfo(String resourcePath,
 String locale)
                              throws CmsRpcException

Description copied from interface: I_CmsPreviewService

Returns the image resource data to be displayed in the preview dialog.

Specified by:

getImageInfo in interface I_CmsPreviewService

Parameters:

resourcePath - the resource path

locale - the content locale

Returns:

the image resource data

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsPreviewService.getImageInfo(java.lang.String, java.lang.String)

getResourceInfo

public CmsResourceInfoBean getResourceInfo(String resourcePath,
 String locale)
                                    throws CmsRpcException

Description copied from interface: I_CmsPreviewService

Returns the data to be displayed in the preview dialog.

Specified by:

getResourceInfo in interface I_CmsPreviewService

Parameters:

resourcePath - the path to the selected resource

locale - the content locale

Returns:

the preview data

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsPreviewService.getResourceInfo(java.lang.String, java.lang.String)

readResourceInfo

public void readResourceInfo(CmsObject cms,
 CmsResource resource,
 CmsResourceInfoBean resInfo,
 String locale)
                      throws CmsException

Retrieves the resource information and puts it into the provided resource info bean.

Parameters:

cms - the initialized cms object

resource - the resource

resInfo - the resource info bean

locale - the content locale

Throws:

CmsException - if something goes wrong

updateImageProperties

public CmsImageInfoBean updateImageProperties(String resourcePath,
 String locale,
 Map<String,String> properties)
                                       throws CmsRpcException

Description copied from interface: I_CmsPreviewService

Saves the given properties to the resource and returns the data to be displayed in the preview dialog.

Specified by:

updateImageProperties in interface I_CmsPreviewService

Parameters:

resourcePath - the path to the selected resource

locale - the content locale

properties - a map with the key/value pairs of the properties to be updated

Returns:

the updates preview data

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsPreviewService.updateImageProperties(java.lang.String, java.lang.String, java.util.Map)

updateResourceProperties

public CmsResourceInfoBean updateResourceProperties(String resourcePath,
 String locale,
 Map<String,String> properties)
                                             throws CmsRpcException

Description copied from interface: I_CmsPreviewService

Saves the given properties to the resource and returns the data to be displayed in the preview dialog.

Specified by:

updateResourceProperties in interface I_CmsPreviewService

Parameters:

resourcePath - the path to the selected resource

locale - the content locale

properties - a map with the key/value pairs of the properties to be updated

Returns:

the updates preview data

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsPreviewService.updateResourceProperties(java.lang.String, java.lang.String, java.util.Map)