org.nuxeo.ecm.webapp.liveedit

Class LiveEditClientConfig

java.lang.Object

org.nuxeo.ecm.webapp.liveedit.LiveEditClientConfig

All Implemented Interfaces:

Serializable

@Scope(value=SESSION)
 @Name(value="liveEditClientConfig")
 @Install(precedence=10)
public class LiveEditClientConfig
extends Object
implements Serializable

This Seam component is used to represent the client configuration for LiveEdit.

On the client side, the LiveEdit plugin advertise its feature via the Accept Header of the browser. This information may be used to decide if LiveEdit links must be displayed or not.

The behavior can be configured via the property: org.nuxeo.ecm.platform.liveedit.config

There are 3 possible values :

• client : let the client choose what is live editable => use the mime-types send by the client to define what must be live editable
• server : let the server decide => use the mime-type registry define what types are liveEditable
• both : use client and server intersection => in order to be liveEditable a type must be advertised by the client and set to liveEditable in the mimetypeRegistry

Client advertising is done in the Accept header: Accept : application/x-nuxeo-liveedit:mimetype1;mimetype2 Starting the 5.2, the addon can send the standardized accept header, as Accept : application/x-nuxeo-liveedit;ext0="mimetype1";ext1="mimetype2".. Also, the addon can still send the old way, so the both forms are accepted. See NXP-3257

Author:

Thierry Delprat, rux

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	advertizedLiveEditableMimeTypes
protected Boolean	clientHasLiveEditInstalled
static String	LE_CONFIG_BOTHSIDES
static String	LE_CONFIG_CLIENTSIDE
static String	LE_CONFIG_PROPERTY
static String	LE_CONFIG_SERVERSIDE
static String	LE_MIME_TYPE
protected static String	liveEditConfigPolicy

Constructor Summary

Constructors

Constructor and Description
LiveEditClientConfig()

Method Summary

Modifier and Type	Method and Description
protected void	detectLiveEditClientConfig()
String	getLiveEditConfigurationPolicy()
boolean	isLiveEditInstalled()
boolean	isMimeTypeLiveEditable(String mimetype)

Methods inherited from class java.lang.Object

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

Field Detail

clientHasLiveEditInstalled

protected Boolean clientHasLiveEditInstalled

advertizedLiveEditableMimeTypes

protected List<String> advertizedLiveEditableMimeTypes

liveEditConfigPolicy

protected static String liveEditConfigPolicy

LE_MIME_TYPE

public static final String LE_MIME_TYPE

See Also:

Constant Field Values

LE_CONFIG_PROPERTY

public static final String LE_CONFIG_PROPERTY

See Also:

Constant Field Values

LE_CONFIG_CLIENTSIDE

public static final String LE_CONFIG_CLIENTSIDE

See Also:

Constant Field Values

LE_CONFIG_SERVERSIDE

public static final String LE_CONFIG_SERVERSIDE

See Also:

Constant Field Values

LE_CONFIG_BOTHSIDES

public static final String LE_CONFIG_BOTHSIDES

See Also:

Constant Field Values

Constructor Detail

LiveEditClientConfig

public LiveEditClientConfig()

Method Detail

detectLiveEditClientConfig

protected void detectLiveEditClientConfig()

isLiveEditInstalled

public boolean isLiveEditInstalled()

getLiveEditConfigurationPolicy

public String getLiveEditConfigurationPolicy()

isMimeTypeLiveEditable

public boolean isMimeTypeLiveEditable(String mimetype)