org.opencms.ade.contenteditor

类 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

所有已实现的接口:

com.alkacon.acacia.shared.rpc.I_ContentService, com.google.gwt.user.client.rpc.RemoteService, com.google.gwt.user.server.rpc.SerializationPolicyProvider, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, I_CmsContentService

public class CmsContentService
extends CmsGwtService
implements I_CmsContentService

Service to provide entity persistence within OpenCms.

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
protected static org.apache.commons.logging.Log	LOG The logger for this class.

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

perThreadRequest, perThreadResponse

从接口继承的字段 org.opencms.ade.contenteditor.shared.rpc.I_CmsContentService

DICT_CONTENT_DEFINITION, PARAM_BACKLINK

构造器概要

构造器

构造器和说明
CmsContentService()

方法概要

方法

限定符和类型	方法和说明
protected java.lang.String	decodeNewLink(java.lang.String newLink) Decodes the newlink request parameter if possible.
static java.lang.String	getAttributeName(I_CmsXmlContentValue contentValue) Returns the entity attribute name representing the given content value.
static java.lang.String	getAttributeName(java.lang.String elementName, java.lang.String parentType) Returns the entity attribute name to use for this element.
protected java.lang.String	getElementName(java.lang.String attributeName) Returns the element name to the given element.
static java.lang.String	getEntityId(I_CmsXmlContentValue contentValue) Returns the entity id to the given content value.
protected java.lang.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 java.lang.String	getRdfaAttributes(I_CmsXmlContentValue parentValue, java.lang.String childNames) Returns the RDF annotations required for in line editing.
static java.lang.String	getRdfaAttributes(I_CmsXmlDocument document, java.util.Locale contentLocale, java.lang.String childName) Returns the RDF annotations required for in line editing.
static java.lang.String	getTypeUri(CmsXmlContentDefinition xmlContentDefinition) Returns the type URI.
com.alkacon.acacia.shared.ContentDefinition	loadContentDefinition(java.lang.String entityId)
CmsContentDefinition	loadDefinition(java.lang.String entityId) Loads the content definition for a given entity.
CmsContentDefinition	loadDefinition(java.lang.String entityId, java.lang.String newLink, CmsUUID modelFileId, java.lang.String editContext) Loads the content definition for a given entity.
CmsContentDefinition	loadNewDefinition(java.lang.String entityId) 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 com.alkacon.acacia.shared.Entity	readEntity(CmsXmlContent content, org.dom4j.Element element, java.util.Locale locale, java.lang.String entityId, java.lang.String parentPath, java.lang.String typeName, java.util.Map<java.lang.String,com.alkacon.vie.shared.I_Type> registeredTypes) Parses the element into an entity.
protected java.util.Map<java.lang.String,com.alkacon.vie.shared.I_Type>	readTypes(CmsXmlContentDefinition xmlContentDefinition, java.util.Locale locale) Reads the types from the given content definition and adds the to the map of already registered types if necessary.
com.alkacon.acacia.shared.ValidationResult	saveAndDeleteEntities(java.util.List<com.alkacon.acacia.shared.Entity> changedEntities, java.util.List<java.lang.String> deletedEntities, boolean clearOnSuccess) Saves and deletes the given entities.
com.alkacon.acacia.shared.ValidationResult	saveEntities(java.util.List<com.alkacon.acacia.shared.Entity> entities)
com.alkacon.acacia.shared.ValidationResult	saveEntity(com.alkacon.acacia.shared.Entity entity)
com.alkacon.acacia.shared.EntityHtml	updateEntityHtml(com.alkacon.acacia.shared.Entity entity, java.lang.String contextUri, java.lang.String htmlContextInfo)
com.alkacon.acacia.shared.ValidationResult	validateEntities(java.util.List<com.alkacon.acacia.shared.Entity> changedEntities)

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

字段详细资料

LOG

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

The logger for this class.

构造器详细资料

CmsContentService

public CmsContentService()

方法详细资料

getAttributeName

public static java.lang.String getAttributeName(I_CmsXmlContentValue contentValue)

Returns the entity attribute name representing the given content value.

参数:

contentValue - the content value

返回:

the attribute name

getAttributeName

public static java.lang.String getAttributeName(java.lang.String elementName,
                                java.lang.String parentType)

Returns the entity attribute name to use for this element.

参数:

elementName - the element name

parentType - the parent type

返回:

the attribute name

getEntityId

public static java.lang.String getEntityId(I_CmsXmlContentValue contentValue)

Returns the entity id to the given content value.

参数:

contentValue - the content value

返回:

the entity id

getRdfaAttributes

public static java.lang.String getRdfaAttributes(I_CmsXmlContentValue parentValue,
                                 java.lang.String childNames)

Returns the RDF annotations required for in line editing.

参数:

parentValue - the parent XML content value

childNames - the child attribute names separated by '|'

返回:

the RDFA

getRdfaAttributes

public static java.lang.String getRdfaAttributes(I_CmsXmlDocument document,
                                 java.util.Locale contentLocale,
                                 java.lang.String childName)

Returns the RDF annotations required for in line editing.

参数:

document - the parent XML document

contentLocale - the content locale

childName - the child attribute name

返回:

the RDFA

getTypeUri

public static java.lang.String getTypeUri(CmsXmlContentDefinition xmlContentDefinition)

Returns the type URI.

参数:

xmlContentDefinition - the type content definition

返回:

the type URI

prefetch

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

Fetches the initial content definition.

参数:

request - the current request

返回:

the initial content definition

抛出:

CmsRpcException - if something goes wrong

loadContentDefinition

public com.alkacon.acacia.shared.ContentDefinition loadContentDefinition(java.lang.String entityId)
                                                                  throws CmsRpcException

指定者:

loadContentDefinition 在接口中 com.alkacon.acacia.shared.rpc.I_ContentService

抛出:

CmsRpcException

另请参阅:

I_ContentService.loadContentDefinition(java.lang.String)

loadDefinition

public CmsContentDefinition loadDefinition(java.lang.String entityId)
                                    throws CmsRpcException

从接口复制的说明: I_CmsContentService

Loads the content definition for a given entity.

指定者:

loadDefinition 在接口中 I_CmsContentService

参数:

entityId - the entity id/URI

返回:

the content definition

抛出:

CmsRpcException

另请参阅:

I_CmsContentService.loadDefinition(java.lang.String)

loadDefinition

public CmsContentDefinition loadDefinition(java.lang.String entityId,
                                  java.lang.String newLink,
                                  CmsUUID modelFileId,
                                  java.lang.String editContext)
                                    throws CmsRpcException

从接口复制的说明: I_CmsContentService

Loads the content definition for a given entity.

指定者:

loadDefinition 在接口中 I_CmsContentService

参数:

entityId - the entity id/URI

newLink - the new link

modelFileId - the optional model file id

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

返回:

the content definition

抛出:

CmsRpcException - if something goes wrong processing the request

另请参阅:

I_CmsContentService.loadDefinition(java.lang.String, java.lang.String, org.opencms.util.CmsUUID, java.lang.String)

loadNewDefinition

public CmsContentDefinition loadNewDefinition(java.lang.String entityId)
                                       throws CmsRpcException

从接口复制的说明: I_CmsContentService

Loads new entity definition.

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

指定者:

loadNewDefinition 在接口中 I_CmsContentService

参数:

entityId - the entity id/URI

返回:

the content definition

抛出:

CmsRpcException - if something goes wrong processing the request

另请参阅:

I_CmsContentService.loadNewDefinition(java.lang.String)

prefetch

public CmsContentDefinition prefetch()
                              throws CmsRpcException

从接口复制的说明: I_CmsContentService

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

指定者:

prefetch 在接口中 I_CmsContentService

返回:

the content definition

抛出:

CmsRpcException - if something goes wrong

另请参阅:

I_CmsContentService.prefetch()

saveAndDeleteEntities

public com.alkacon.acacia.shared.ValidationResult saveAndDeleteEntities(java.util.List<com.alkacon.acacia.shared.Entity> changedEntities,
                                                               java.util.List<java.lang.String> deletedEntities,
                                                               boolean clearOnSuccess)
                                                                 throws CmsRpcException

从接口复制的说明: I_CmsContentService

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

指定者:

saveAndDeleteEntities 在接口中 I_CmsContentService

参数:

changedEntities - the changed entities

deletedEntities - the entity id's to delete

clearOnSuccess - true to unlock resource after saving

返回:

the validation result in case of invalid entities

抛出:

CmsRpcException - if something goes wrong processing the request

另请参阅:

I_CmsContentService.saveAndDeleteEntities(java.util.List, java.util.List, boolean)

saveEntities

public com.alkacon.acacia.shared.ValidationResult saveEntities(java.util.List<com.alkacon.acacia.shared.Entity> entities)
                                                        throws CmsRpcException

指定者:

saveEntities 在接口中 com.alkacon.acacia.shared.rpc.I_ContentService

抛出:

CmsRpcException

另请参阅:

I_ContentService.saveEntities(java.util.List)

saveEntity

public com.alkacon.acacia.shared.ValidationResult saveEntity(com.alkacon.acacia.shared.Entity entity)
                                                      throws CmsRpcException

指定者:

saveEntity 在接口中 com.alkacon.acacia.shared.rpc.I_ContentService

抛出:

CmsRpcException

另请参阅:

I_ContentService.saveEntity(com.alkacon.acacia.shared.Entity)

updateEntityHtml

public com.alkacon.acacia.shared.EntityHtml updateEntityHtml(com.alkacon.acacia.shared.Entity entity,
                                                    java.lang.String contextUri,
                                                    java.lang.String htmlContextInfo)
                                                      throws java.lang.Exception

指定者:

updateEntityHtml 在接口中 com.alkacon.acacia.shared.rpc.I_ContentService

抛出:

java.lang.Exception

另请参阅:

I_ContentService.updateEntityHtml(com.alkacon.acacia.shared.Entity, java.lang.String, java.lang.String)

validateEntities

public com.alkacon.acacia.shared.ValidationResult validateEntities(java.util.List<com.alkacon.acacia.shared.Entity> changedEntities)
                                                            throws CmsRpcException

指定者:

validateEntities 在接口中 com.alkacon.acacia.shared.rpc.I_ContentService

抛出:

CmsRpcException

另请参阅:

I_ContentService.validateEntities(java.util.List)

decodeNewLink

protected java.lang.String decodeNewLink(java.lang.String newLink)

Decodes the newlink request parameter if possible.

参数:

newLink - the parameter to decode

返回:

the decoded value

getElementName

protected java.lang.String getElementName(java.lang.String attributeName)

Returns the element name to the given element.

参数:

attributeName - the attribute name

返回:

the element name

getFileEncoding

protected java.lang.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.

参数:

cms - the CmsObject

file - the file which is to be checked

返回:

the encoding for the file

readEntity

protected com.alkacon.acacia.shared.Entity readEntity(CmsXmlContent content,
                                          org.dom4j.Element element,
                                          java.util.Locale locale,
                                          java.lang.String entityId,
                                          java.lang.String parentPath,
                                          java.lang.String typeName,
                                          java.util.Map<java.lang.String,com.alkacon.vie.shared.I_Type> registeredTypes)

Parses the element into an entity.

参数:

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

registeredTypes - the types used within the entity

返回:

the entity

readTypes

protected java.util.Map<java.lang.String,com.alkacon.vie.shared.I_Type> readTypes(CmsXmlContentDefinition xmlContentDefinition,
                                                                      java.util.Locale locale)

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

参数:

xmlContentDefinition - the XML content definition

locale - the messages locale

返回:

the types of the given content definition