Package org.opencms.ade.contenteditor

Class CmsContentService

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.contenteditor.CmsContentService

All Implemented Interfaces:

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

public class CmsContentService
extends CmsGwtService
implements I_CmsContentService

Service to provide entity persistence within OpenCms.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_EDITOR_SAVING	Request context attribute to mark a writeFile() triggered by the user saving in the content editor.
protected static final org.apache.commons.logging.Log	LOG	The logger for this class.

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

perThreadRequest, perThreadResponse

Fields inherited from interface org.opencms.ade.contenteditor.shared.rpc.I_CmsContentService

DICT_CONTENT_DEFINITION, PARAM_BACKLINK

Constructor Summary

Constructors

Constructor	Description
CmsContentService()

Method Summary

Modifier and Type	Method	Description
CmsContentDefinition	callEditorChangeHandlers(String entityId, CmsEntity editedLocaleEntity, Collection<String> skipPaths, Collection<String> changedScopes)	Calls the editor change handlers.
void	copyLocale(Collection<String> locales, CmsEntity sourceLocale)	Copies the given source locale to the target locales.
protected String	decodeNewLink(String newLink)	Decodes the newlink request parameter if possible.
static String	defaultCreateResourceToEdit(CmsObject cms, String newLink, Locale locale, String referenceSitePath, String modelFileSitePath, String mode, String postCreateHandler)	Creates a new resource to edit, delegating to an edit handler if edit handler data is passed in.
static String	getAttributeName(String elementName, String parentType)	Returns the entity attribute name to use for this element.
static String	getAttributeName(I_CmsXmlContentValue contentValue)	Returns the entity attribute name representing the given content value.
CmsObject	getCmsObject()	Returns the current cms context.
protected String	getElementName(String attributeName)	Returns the element name to the given element.
static String	getEntityId(I_CmsXmlContentValue contentValue)	Returns the entity id to the given content value.
protected String	getFileEncoding(CmsObject cms, CmsResource file)	Helper method to determine the encoding of the given file in the VFS, which must be set using the "content-encoding" property.
static String	getRdfaAttributes(I_CmsXmlDocument document, Locale contentLocale, String elementPath)	Returns the RDF annotations required for in line editing.
static String	getRdfaAttributes(I_CmsXmlContentValue value)	Returns the RDF annotations required for in line editing.
static String	getRdfaAttributes(I_CmsXmlContentValue parentValue, String childNames)	Returns the RDF annotations required for in line editing.
static String	getTypeUri(CmsXmlContentDefinition xmlContentDefinition)	Returns the type URI.
CmsContentDefinition	loadContentDefinition(String entityId)	Loads the content definition for a given entity.
CmsContentDefinition	loadDefinition(String entityId, String clientId, CmsEntity editedLocaleEntity, Collection<String> skipPaths, Map<String,String> settingPresets)	Loads the content definition for a given entity.
CmsContentDefinition	loadInitialDefinition(String entityId, String clientId, String newLink, CmsUUID modelFileId, String editContext, String mainLocale, String mode, String postCreateHandler, CmsEditHandlerData editHandlerDataForNew, Map<String,String> settingPresets, String editorStylesheet)	Loads the content definition for a given entity.
CmsContentDefinition	loadNewDefinition(String entityId, String clientId, CmsEntity editedLocaleEntity, Collection<String> skipPaths, Map<String,String> settingPresets)	Loads new entity definition.
CmsContentDefinition	prefetch()	Returns the content definition of the resource requested through parameter 'resource'.
static CmsContentDefinition	prefetch(javax.servlet.http.HttpServletRequest request)	Fetches the initial content definition.
protected CmsEntity	readEntity(CmsXmlContent content, org.dom4j.Element element, Locale locale, String entityId, String parentPath, String typeName, CmsContentTypeVisitor visitor, boolean includeInvisible, CmsEntity editedLocalEntity)	Parses the element into an entity.
protected Map<String,CmsType>	readTypes(CmsXmlContentDefinition xmlContentDefinition, Locale locale)	Reads the types from the given content definition and adds the to the map of already registered types if necessary.
CmsSaveResult	saveAndDeleteEntities(CmsEntity lastEditedEntity, String clientId, List<String> deletedEntities, Collection<String> skipPaths, String lastEditedLocale, boolean clearOnSuccess)	Saves and deletes the given entities.
CmsValidationResult	saveEntities(List<CmsEntity> entities)	Saves the given entities and returns a validation result in case of invalid entities.
CmsValidationResult	saveEntity(CmsEntity entity)	Saves the given entity and returns a validation result in case of invalid entities.
String	saveValue(String contentId, String contentPath, String localeString, String newValue)	Saves a value in an existing XML content.
protected void	synchronizeLocaleIndependentFields(CmsFile file, CmsXmlContent content, Collection<String> skipPaths, Collection<CmsEntity> entities, Locale lastEdited)	Synchronizes the locale independent fields.
protected void	transferInvisibleValues(CmsEntity original, CmsEntity target, CmsContentTypeVisitor visitor)	Transfers values marked as invisible from the original entity to the target entity.
CmsEntityHtml	updateEntityHtml(CmsEntity entity, String contextUri, String htmlContextInfo)	Retrieves the updated entity HTML representation.
CmsValidationResult	validateEntity(CmsEntity changedEntity)	Validates the given entity and returns maps of error and warning messages in case of invalid attributes.

Methods inherited from class org.opencms.gwt.CmsGwtService

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

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

checkPermutationStrongName, getCodeServerPolicyUrl, getRequestModuleBasePath, getSerializationPolicy, init, loadPolicyFromCodeServer, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, 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

Methods inherited from class java.lang.Object

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

Field Details

ATTR_EDITOR_SAVING

public static final String ATTR_EDITOR_SAVING

Request context attribute to mark a writeFile() triggered by the user saving in the content editor.

See Also:

• Constant Field Values

LOG

protected static final org.apache.commons.logging.Log LOG

The logger for this class.

Constructor Details

CmsContentService

public CmsContentService()

Method Details

defaultCreateResourceToEdit

public static String defaultCreateResourceToEdit(CmsObject cms,
 String newLink,
 Locale locale,
 String referenceSitePath,
 String modelFileSitePath,
 String mode,
 String postCreateHandler)
                                          throws CmsException

Creates a new resource to edit, delegating to an edit handler if edit handler data is passed in.

Parameters:

cms - The CmsObject of the current request context.

newLink - A string, specifying where which new content should be created.

locale - The locale for which the

referenceSitePath - site path of the currently edited content.

modelFileSitePath - site path of the model file

mode - optional creation mode

postCreateHandler - optional class name of an I_CmsCollectorPostCreateHandler which is invoked after the content has been created.

Returns:

The site-path of the newly created resource.

Throws:

CmsException - if something goes wrong

getAttributeName

public static String getAttributeName(I_CmsXmlContentValue contentValue)

Returns the entity attribute name representing the given content value.

Parameters:

contentValue - the content value

Returns:

the attribute name

getAttributeName

public static String getAttributeName(String elementName,
 String parentType)

Returns the entity attribute name to use for this element.

Parameters:

elementName - the element name

parentType - the parent type

Returns:

the attribute name

getEntityId

public static String getEntityId(I_CmsXmlContentValue contentValue)

Returns the entity id to the given content value.

Parameters:

contentValue - the content value

Returns:

the entity id

getRdfaAttributes

public static String getRdfaAttributes(I_CmsXmlContentValue value)

Returns the RDF annotations required for in line editing.

Parameters:

value - the XML content value

Returns:

the RDFA

getRdfaAttributes

public static String getRdfaAttributes(I_CmsXmlContentValue parentValue,
 String childNames)

Returns the RDF annotations required for in line editing.

Parameters:

parentValue - the parent XML content value

childNames - the child attribute names separated by '|'

Returns:

the RDFA

getRdfaAttributes

public static String getRdfaAttributes(I_CmsXmlDocument document,
 Locale contentLocale,
 String elementPath)

Returns the RDF annotations required for in line editing.

Parameters:

document - the parent XML document

contentLocale - the content locale

elementPath - the element xpath to get the RDF annotation for

Returns:

the RDFA

getTypeUri

public static String getTypeUri(CmsXmlContentDefinition xmlContentDefinition)

Returns the type URI.

Parameters:

xmlContentDefinition - the type content definition

Returns:

the type URI

prefetch

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

Fetches the initial content definition.

Parameters:

request - the current request

Returns:

the initial content definition

Throws:

CmsRpcException - if something goes wrong

callEditorChangeHandlers

public CmsContentDefinition callEditorChangeHandlers(String entityId,
 CmsEntity editedLocaleEntity,
 Collection<String> skipPaths,
 Collection<String> changedScopes)
                                              throws CmsRpcException

Description copied from interface: I_CmsContentService

Calls the editor change handlers.

Specified by:

callEditorChangeHandlers in interface I_CmsContentService

Parameters:

entityId - the edited entity id

editedLocaleEntity - the edited entity

skipPaths - the locale synchronization value paths to skip

changedScopes - the changed content value paths

Returns:

the changed content

Throws:

CmsRpcException - in case anything goes wrong

See Also:

• I_CmsContentService.callEditorChangeHandlers(java.lang.String, org.opencms.acacia.shared.CmsEntity, java.util.Collection, java.util.Collection)

copyLocale

public void copyLocale(Collection<String> locales,
 CmsEntity sourceLocale)
                throws CmsRpcException

Description copied from interface: I_CmsContentService

Copies the given source locale to the target locales.

Specified by:

copyLocale in interface I_CmsContentService

Parameters:

locales - the target locales

sourceLocale - the source locale

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContentService.copyLocale(java.util.Collection, org.opencms.acacia.shared.CmsEntity)

getCmsObject

public CmsObject getCmsObject()

Description copied from class: CmsGwtService

Returns the current cms context.

Overrides:

getCmsObject in class CmsGwtService

Returns:

the current cms context

See Also:

• CmsGwtService.getCmsObject()

loadContentDefinition

public CmsContentDefinition loadContentDefinition(String entityId)
                                           throws CmsRpcException

Description copied from interface: I_CmsContentService

Loads the content definition for a given entity.

Specified by:

loadContentDefinition in interface I_CmsContentService

Parameters:

entityId - the entity id/URI

Returns:

the content type definition

Throws:

CmsRpcException

See Also:

• I_CmsContentService.loadContentDefinition(java.lang.String)

loadDefinition

public CmsContentDefinition loadDefinition(String entityId,
 String clientId,
 CmsEntity editedLocaleEntity,
 Collection<String> skipPaths,
 Map<String,String> settingPresets)
                                    throws CmsRpcException

Description copied from interface: I_CmsContentService

Loads the content definition for a given entity.

Specified by:

loadDefinition in interface I_CmsContentService

Parameters:

entityId - the entity id/URI

clientId - the container element client id if available

editedLocaleEntity - the edited locale entity

skipPaths - the paths to skip during locale synchronization

settingPresets - the presets for container element settings

Returns:

the content definition

Throws:

CmsRpcException

See Also:

• I_CmsContentService.loadDefinition(java.lang.String, java.lang.String, org.opencms.acacia.shared.CmsEntity, java.util.Collection, java.util.Map)

loadInitialDefinition

public CmsContentDefinition loadInitialDefinition(String entityId,
 String clientId,
 String newLink,
 CmsUUID modelFileId,
 String editContext,
 String mainLocale,
 String mode,
 String postCreateHandler,
 CmsEditHandlerData editHandlerDataForNew,
 Map<String,String> settingPresets,
 String editorStylesheet)
                                           throws CmsRpcException

Description copied from interface: I_CmsContentService

Loads the content definition for a given entity.

Specified by:

loadInitialDefinition in interface I_CmsContentService

Parameters:

entityId - the entity id/URI

clientId - the container element client id if available

newLink - the new link

modelFileId - the optional model file id

editContext - the container page currently being edited (may be null)

mainLocale - the main language to copy in case the element language node does not exist yet

mode - the content creation mode

postCreateHandler - the post-create handler class name

editHandlerDataForNew - the edit handler data, if an edit handler is used for creating a new element; null otherwise

settingPresets - the presets for container element settings

editorStylesheet - the path of the editor style sheet (may be null)

Returns:

the content definition

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContentService.loadInitialDefinition(java.lang.String, java.lang.String, java.lang.String, org.opencms.util.CmsUUID, java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.opencms.ade.contenteditor.shared.CmsEditHandlerData, java.util.Map, java.lang.String)

loadNewDefinition

public CmsContentDefinition loadNewDefinition(String entityId,
 String clientId,
 CmsEntity editedLocaleEntity,
 Collection<String> skipPaths,
 Map<String,String> settingPresets)
                                       throws CmsRpcException

Description copied from interface: I_CmsContentService

Loads new entity definition.

This will load the entity representation of a new locale node.

Specified by:

loadNewDefinition in interface I_CmsContentService

Parameters:

entityId - the entity id/URI

clientId - the container element client id if available

editedLocaleEntity - the edited locale entity

skipPaths - the paths to skip during locale synchronization

settingPresets - the presets for container element settings

Returns:

the content definition

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContentService.loadNewDefinition(java.lang.String, java.lang.String, org.opencms.acacia.shared.CmsEntity, java.util.Collection, java.util.Map)

prefetch

public CmsContentDefinition prefetch()
                              throws CmsRpcException

Description copied from interface: I_CmsContentService

Returns the content definition of the resource requested through parameter 'resource'.

Specified by:

prefetch in interface I_CmsContentService

Returns:

the content definition

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContentService.prefetch()

saveAndDeleteEntities

public CmsSaveResult saveAndDeleteEntities(CmsEntity lastEditedEntity,
 String clientId,
 List<String> deletedEntities,
 Collection<String> skipPaths,
 String lastEditedLocale,
 boolean clearOnSuccess)
                                    throws CmsRpcException

Description copied from interface: I_CmsContentService

Saves and deletes the given entities. Returns the editor save result information.

Specified by:

saveAndDeleteEntities in interface I_CmsContentService

Parameters:

lastEditedEntity - the last edited entity

clientId - the container element client id if available

deletedEntities - the entity id's to delete

skipPaths - the paths to skip during locale synchronization

lastEditedLocale - the last edited locale

clearOnSuccess - true to unlock resource after saving

Returns:

the editor save result information

Throws:

CmsRpcException - if something goes wrong processing the request

See Also:

• I_CmsContentService.saveAndDeleteEntities(org.opencms.acacia.shared.CmsEntity, java.lang.String, java.util.List, java.util.Collection, java.lang.String, boolean)

saveEntities

public CmsValidationResult saveEntities(List<CmsEntity> entities)

Description copied from interface: I_CmsContentService

Saves the given entities and returns a validation result in case of invalid entities.

Invalid entities will not be saved.

Specified by:

saveEntities in interface I_CmsContentService

Parameters:

entities - the entities to save

Returns:

the validation result in case of invalid entities

See Also:

• I_CmsContentService.saveEntities(java.util.List)

saveEntity

public CmsValidationResult saveEntity(CmsEntity entity)

Description copied from interface: I_CmsContentService

Saves the given entity and returns a validation result in case of invalid entities.

Invalid entities will not be saved.

Specified by:

saveEntity in interface I_CmsContentService

Parameters:

entity - the entity to save

Returns:

the validation result in case of invalid entities

See Also:

• I_CmsContentService.saveEntity(org.opencms.acacia.shared.CmsEntity)

saveValue

public String saveValue(String contentId,
 String contentPath,
 String localeString,
 String newValue)
                 throws CmsRpcException

Description copied from interface: I_CmsContentService

Saves a value in an existing XML content.

Specified by:

saveValue in interface I_CmsContentService

Parameters:

contentId - the structure id of the content

contentPath - the xpath of the value to set

localeString - the locale in which to set the value

newValue - the value to set

Returns:

not used

Throws:

CmsRpcException - if something goes wrong

See Also:

• I_CmsContentService.saveValue(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

updateEntityHtml

public CmsEntityHtml updateEntityHtml(CmsEntity entity,
 String contextUri,
 String htmlContextInfo)
                               throws Exception

Description copied from interface: I_CmsContentService

Retrieves the updated entity HTML representation.

The entity data will be validated but not persisted on the server.

Specified by:

updateEntityHtml in interface I_CmsContentService

Parameters:

entity - the entity

contextUri - the context URI

htmlContextInfo - information about the HTML context

Returns:

the HTML representation including the validation result

Throws:

Exception - if something goes wrong processing the request

See Also:

• I_CmsContentService.updateEntityHtml(org.opencms.acacia.shared.CmsEntity, java.lang.String, java.lang.String)

validateEntity

public CmsValidationResult validateEntity(CmsEntity changedEntity)
                                   throws CmsRpcException

Description copied from interface: I_CmsContentService

Validates the given entity and returns maps of error and warning messages in case of invalid attributes.

Specified by:

validateEntity in interface I_CmsContentService

Parameters:

changedEntity - the entity to validate

Returns:

the validation result

Throws:

CmsRpcException

See Also:

• I_CmsContentService.validateEntity(org.opencms.acacia.shared.CmsEntity)

decodeNewLink

protected String decodeNewLink(String newLink)

Decodes the newlink request parameter if possible.

Parameters:

newLink - the parameter to decode

Returns:

the decoded value

getElementName

protected String getElementName(String attributeName)

Returns the element name to the given element.

Parameters:

attributeName - the attribute name

Returns:

the element name

getFileEncoding

protected String getFileEncoding(CmsObject cms,
 CmsResource file)

Helper method to determine the encoding of the given file in the VFS, which must be set using the "content-encoding" property.

Parameters:

cms - the CmsObject

file - the file which is to be checked

Returns:

the encoding for the file

readEntity

protected CmsEntity readEntity(CmsXmlContent content,
 org.dom4j.Element element,
 Locale locale,
 String entityId,
 String parentPath,
 String typeName,
 CmsContentTypeVisitor visitor,
 boolean includeInvisible,
 CmsEntity editedLocalEntity)

Parses the element into an entity.

Parameters:

content - the entity content

element - the current element

locale - the content locale

entityId - the entity id

parentPath - the parent path

typeName - the entity type name

visitor - the content type visitor

includeInvisible - include invisible attributes

editedLocalEntity - the edited locale entity

Returns:

the entity

readTypes

protected Map<String,CmsType> readTypes(CmsXmlContentDefinition xmlContentDefinition,
 Locale locale)

Reads the types from the given content definition and adds the to the map of already registered types if necessary.

Parameters:

xmlContentDefinition - the XML content definition

locale - the messages locale

Returns:

the types of the given content definition

synchronizeLocaleIndependentFields

protected void synchronizeLocaleIndependentFields(CmsFile file,
 CmsXmlContent content,
 Collection<String> skipPaths,
 Collection<CmsEntity> entities,
 Locale lastEdited)
                                           throws CmsXmlException

Synchronizes the locale independent fields.

Parameters:

file - the content file

content - the XML content

skipPaths - the paths to skip during locale synchronization

entities - the edited entities

lastEdited - the last edited locale

Throws:

CmsXmlException - if something goes wrong

transferInvisibleValues

protected void transferInvisibleValues(CmsEntity original,
 CmsEntity target,
 CmsContentTypeVisitor visitor)

Transfers values marked as invisible from the original entity to the target entity.

Parameters:

original - the original entity

target - the target entiy

visitor - the type visitor holding the content type configuration