org.nuxeo.ecm.webapp.liveedit

Class LiveEditBootstrapHelper

java.lang.Object

org.nuxeo.ecm.webapp.liveedit.LiveEditBootstrapHelper

All Implemented Interfaces:

Serializable, LiveEditConstants

@Scope(value=EVENT)
 @Name(value="liveEditHelper")
public class LiveEditBootstrapHelper
extends Object
implements Serializable, LiveEditConstants

The LiveEdit bootstrap procedure works as follows:

• browsed page calls a JSF function from the DocumentModelFunctions class (edit a document, create new document, etc.) to generate;
• composing a specific URL as result, triggering the bootstrap addon to popup;
• the addon come back with the URL composed allowing the present seam component to create the bootstrap file. The file contains various data as requested in the URL;
• the XML file is now available to addon which presents it to the client plugin.

Please refer to the nuxeo book chapter on desktop integration for details on the format of the nxedit URLs and the XML bootstrap file.

Author:

Thierry Delprat NXP-1959 the bootstrap file is managing the 'create new document [from template]' case too. The URL is containing an action identifier., Rux rdarlea@nuxeo.com, Olivier Grisel ogrisel@nuxeo.com (split url functions into JSF DocumentModelFunctions module)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	action
protected String	blobField Deprecated. use blobPropertyField instead
protected String	blobPropertyName
protected Map<String,Boolean>	cachedEditableBlobs
protected Map<String,Boolean>	cachedEditableStates
protected String	docRef
protected String	docType
protected CoreSession	documentManager
protected static String	DUBLINCORE_SCHEMA
protected String	filenameField Deprecated. use filenamePropertyField instead
protected String	filenamePropertyName
protected LiveEditClientConfig	liveEditClientConfig
protected String	mimetype
protected MimetypeRegistry	mimetypeRegistry
protected static String	MODIFIED_FIELD
protected NavigationContext	navigationContext
protected String	repoID
protected String	schema Deprecated. use blobPropertyField and filenamePropertyField instead
protected String	templateBlobField
protected String	templateDocRef
protected String	templateRepoID
protected String	templateSchema

Fields inherited from interface org.nuxeo.ecm.platform.ui.web.tag.fn.LiveEditConstants

ACTION, ACTION_CREATE_DOCUMENT, ACTION_CREATE_DOCUMENT_FROM_TEMPLATE, ACTION_EDIT_DOCUMENT, actionSelectorTag, BLOB_FIELD, BLOB_PROPERTY_NAME, DEFAULT_BLOB_FIELD, DEFAULT_DOCTYPE, DEFAULT_FILENAME_FIELD, DEFAULT_SCHEMA, DEFAULT_SUB_BLOB_FIELD, DOC_REF, DOC_TYPE, docBlobFieldNameTag, docBlobFieldPathTag, docFieldNameTag, docfieldPathTag, docFileAuthorizedExtensionsTag, docFileAuthorizedExtensionTag, docFileExtensionTag, docFilenameFieldNameTag, docFilenameFieldPathTag, docfileNameTag, docIsLockedTag, docIsVersionTag, docMimetypeTag, docPathTag, docRefTag, docRepositoryTag, docSchemaNameTag, docTitleTag, docTypeTag, documentTag, editIdTag, FILENAME_FIELD, FILENAME_PROPERTY_NAME, liveEditTag, MIMETYPE, REPO_ID, requestBaseURLTag, requestCookiesTag, requestCookieTag, requestHeadersTag, requestHeaderTag, requestInfoTag, SCHEMA, serverInfoTag, serverVersionTag, TEMPLATE_BLOB_FIELD, TEMPLATE_DOC_REF, TEMPLATE_REPO_ID, TEMPLATE_SCHEMA, templateDocumentTag, URL_ENCODE_CHARSET, userInfoTag, userLocaleTag, userNameTag, userPasswordTag, userTokenTag, wsdlAccessWebServiceTag, wsdlLEWebServiceTag, wsdlLocationsTag, XML_LE_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
LiveEditBootstrapHelper()

Method Summary

Modifier and Type	Method and Description
protected static org.dom4j.Element	addTextElement(org.dom4j.Element parent, org.dom4j.QName newElementName, String value)
protected boolean	cacheBlobToFalse(String cacheKey)
void	getBootstrap() Creates the bootstrap file.
protected static String	getEditId(DocumentModel doc, CoreSession session, String userName)
protected String	getFileExtension(String mimetype)
protected List<String>	getFileExtensions(String mimetype)
protected MimetypeRegistry	getMimetypeRegistry()
boolean	isCurrentDocumentLiveEditable()
boolean	isCurrentDocumentLiveEditable(String propertyName)
boolean	isCurrentDocumentLiveEditable(String schemaName, String fieldName)
boolean	isDocumentLiveEditable(DocumentModel documentModel, String propertyName)
boolean	isDocumentLiveEditable(DocumentModel documentModel, String schemaName, String fieldName)
boolean	isLiveEditable(Blob blob) Deprecated. use #isLiveEditable(DocumentModel doc, String blobXpath)
boolean	isLiveEditable(DocumentModel document, Blob blob)
boolean	isMimeTypeLiveEditable(Blob blob)
boolean	isMimeTypeLiveEditable(String mimetype)
boolean	isMSExcelLiveEdititable()
boolean	isMSPowerpointLiveEdititable()
boolean	isMSWordLiveEdititable()
boolean	isOOCalcLiveEdititable()
boolean	isOOPresentationLiveEdititable()
boolean	isOOTextLiveEdititable()

Methods inherited from class java.lang.Object

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

Field Detail

MODIFIED_FIELD

protected static final String MODIFIED_FIELD

See Also:

Constant Field Values

DUBLINCORE_SCHEMA

protected static final String DUBLINCORE_SCHEMA

See Also:

Constant Field Values

navigationContext

@In(create=true)
protected transient NavigationContext navigationContext

documentManager

@In(create=true,
    required=false)
protected transient CoreSession documentManager

action

@RequestParameter
protected String action

repoID

@RequestParameter
protected String repoID

templateRepoID

@RequestParameter
protected String templateRepoID

docRef

@RequestParameter
protected String docRef

templateDocRef

@RequestParameter
protected String templateDocRef

liveEditClientConfig

@In(create=true)
protected LiveEditClientConfig liveEditClientConfig

schema

@Deprecated
 @RequestParameter
protected String schema

Deprecated. use blobPropertyField and filenamePropertyField instead

templateSchema

@RequestParameter
protected String templateSchema

blobField

@Deprecated
 @RequestParameter
protected String blobField

Deprecated. use blobPropertyField instead

blobPropertyName

@RequestParameter
protected String blobPropertyName

templateBlobField

@RequestParameter
protected String templateBlobField

filenameField

@Deprecated
 @RequestParameter
protected String filenameField

Deprecated. use filenamePropertyField instead

filenamePropertyName

@RequestParameter
protected String filenamePropertyName

mimetype

@RequestParameter
protected String mimetype

docType

@RequestParameter
protected String docType

mimetypeRegistry

protected MimetypeRegistry mimetypeRegistry

cachedEditableStates

protected final Map<String,Boolean> cachedEditableStates

cachedEditableBlobs

protected final Map<String,Boolean> cachedEditableBlobs

Constructor Detail

LiveEditBootstrapHelper

public LiveEditBootstrapHelper()

Method Detail

getBootstrap

public void getBootstrap()
                  throws IOException

Creates the bootstrap file. It is called from the browser's addon. The URL composition tells the case and what to create. The structure is depicted in the NXP-1881. Rux NXP-1959: add new tag on root level describing the action: actionEdit, actionNew or actionFromTemplate.

Throws:

IOException

getFileExtension

protected String getFileExtension(String mimetype)

getFileExtensions

protected List<String> getFileExtensions(String mimetype)

addTextElement

protected static org.dom4j.Element addTextElement(org.dom4j.Element parent,
                                                  org.dom4j.QName newElementName,
                                                  String value)

getEditId

protected static String getEditId(DocumentModel doc,
                                  CoreSession session,
                                  String userName)

isLiveEditable

@Deprecated
public boolean isLiveEditable(Blob blob)

Deprecated. use #isLiveEditable(DocumentModel doc, String blobXpath)

isLiveEditable

public boolean isLiveEditable(DocumentModel document,
                              Blob blob)

Parameters:

document - the document to edit.

blobXPath - XPath to the blob property

Returns:

true if the document is immutable and the blob's mime type is supported, false otherwise.

Since:

5.4

isMimeTypeLiveEditable

public boolean isMimeTypeLiveEditable(Blob blob)

isMimeTypeLiveEditable

public boolean isMimeTypeLiveEditable(String mimetype)

isMSWordLiveEdititable

@Factory(value="msword_liveeditable",
         scope=SESSION)
public boolean isMSWordLiveEdititable()

isMSExcelLiveEdititable

@Factory(value="msexcel_liveeditable",
         scope=SESSION)
public boolean isMSExcelLiveEdititable()

isMSPowerpointLiveEdititable

@Factory(value="mspowerpoint_liveeditable",
         scope=SESSION)
public boolean isMSPowerpointLiveEdititable()

isOOTextLiveEdititable

@Factory(value="ootext_liveeditable",
         scope=SESSION)
public boolean isOOTextLiveEdititable()

isOOCalcLiveEdititable

@Factory(value="oocalc_liveeditable",
         scope=SESSION)
public boolean isOOCalcLiveEdititable()

isOOPresentationLiveEdititable

@Factory(value="oopresentation_liveeditable",
         scope=SESSION)
public boolean isOOPresentationLiveEdititable()

isCurrentDocumentLiveEditable

public boolean isCurrentDocumentLiveEditable()

isCurrentDocumentLiveEditable

public boolean isCurrentDocumentLiveEditable(String schemaName,
                                             String fieldName)

isCurrentDocumentLiveEditable

public boolean isCurrentDocumentLiveEditable(String propertyName)

isDocumentLiveEditable

public boolean isDocumentLiveEditable(DocumentModel documentModel,
                                      String schemaName,
                                      String fieldName)

isDocumentLiveEditable

public boolean isDocumentLiveEditable(DocumentModel documentModel,
                                      String propertyName)

cacheBlobToFalse

protected boolean cacheBlobToFalse(String cacheKey)

getMimetypeRegistry

protected MimetypeRegistry getMimetypeRegistry()