org.nuxeo.ecm.platform.ui.web.rest

Class RestHelper

java.lang.Object

org.nuxeo.ecm.platform.ui.web.rest.RestHelper

All Implemented Interfaces:

Serializable

@Name(value="restHelper")
 @Scope(value=EVENT)
public class RestHelper
extends Object
implements Serializable

Helper for generation of URLs and related update of document context.

Author:

tiry, Anahide Tchertchian, Florent Guillaume

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	baseURL
protected DocumentView	docView
protected org.jboss.seam.international.LocaleSelector	localeSelector
protected NavigationContext	navigationContext
static Pattern	VALID_LOCALE
protected WebActions	webActions

Constructor Summary

Constructors

Constructor and Description
RestHelper()

Method Summary

Modifier and Type	Method and Description
protected static String	addConversationRequestParameters(String url, org.jboss.seam.core.Manager conversationManager, String conversationId)
static String	addCurrentConversationParameters(String url) Adds current conversation request parameters to the given url.
static String	addMainConversationParameters(String url) Adds main conversation request parameters to the given url.
String	doPrint(DocumentModel doc, String defaultTheme)
String	doPrint(String defaultTheme)
String	getBaseURL()
String	getContextPath()
static org.jboss.seam.core.Manager	getConversationManager()
String	getDocumentUrl(DocumentModel doc)
String	getDocumentUrl(DocumentModel doc, String viewId, boolean newConversation)
String	getDocumentUrl(String patternName, DocumentModel doc, String viewId, Map<String,String> parameters, boolean newConversation)
DocumentView	getDocumentView()
static javax.servlet.http.HttpServletRequest	getHttpServletRequest()
static javax.servlet.http.HttpServletResponse	getHttpServletResponse()
String	getLocaleString() Returns the locale string.
DocumentView	getNewDocumentView()
DocumentView	getNewDocumentView(String mainTabId)
String	getPrintUrl(DocumentModel doc, String defaultTheme)
String	getPrintUrl(String defaultTheme)
static void	handleRedirect(javax.servlet.http.HttpServletResponse response, String url)
String	initContextFromRestRequest(DocumentView docView) Sets current server location (core repository) and core document as provided by the document view.
void	setDocumentView(DocumentView docView)
void	setLocaleString(String localeString) Sets the locale string if given string is not null and not empty, as well as on faces context view root in case it was already created so that it holds the new locale for future lookups by JSF components.

Methods inherited from class java.lang.Object

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

Field Detail

navigationContext

@In(create=true)
protected transient NavigationContext navigationContext

webActions

@In(create=true)
protected transient WebActions webActions

docView

protected DocumentView docView

baseURL

protected String baseURL

localeSelector

@In(create=true)
protected transient org.jboss.seam.international.LocaleSelector localeSelector

VALID_LOCALE

public static final Pattern VALID_LOCALE

Constructor Detail

RestHelper

public RestHelper()

Method Detail

initContextFromRestRequest

@Begin(id="#{conversationIdGenerator.currentOrNewMainConversationId}",
       join=true)
public String initContextFromRestRequest(DocumentView docView)

Sets current server location (core repository) and core document as provided by the document view.

Only sets current server location if the document reference is null.

setDocumentView

public void setDocumentView(DocumentView docView)

getNewDocumentView

public DocumentView getNewDocumentView(String mainTabId)

getNewDocumentView

public DocumentView getNewDocumentView()

getDocumentView

public DocumentView getDocumentView()

getConversationManager

public static org.jboss.seam.core.Manager getConversationManager()

Returns:

the Seam conversation manager.

addConversationRequestParameters

protected static String addConversationRequestParameters(String url,
                                                         org.jboss.seam.core.Manager conversationManager,
                                                         String conversationId)

addCurrentConversationParameters

public static String addCurrentConversationParameters(String url)

Adds current conversation request parameters to the given url.

Parameters:

url -

Returns:

the url with additional conversation request parameters

addMainConversationParameters

public static String addMainConversationParameters(String url)

Adds main conversation request parameters to the given url.

Parameters:

url -

Returns:

the url with additional conversation request parameters

getDocumentUrl

public String getDocumentUrl(DocumentModel doc)

getDocumentUrl

public String getDocumentUrl(DocumentModel doc,
                             String viewId,
                             boolean newConversation)

getDocumentUrl

public String getDocumentUrl(String patternName,
                             DocumentModel doc,
                             String viewId,
                             Map<String,String> parameters,
                             boolean newConversation)

getBaseURL

@Factory(value="baseURL",
         scope=CONVERSATION)
public String getBaseURL()

getContextPath

@Factory(value="contextPath",
         scope=CONVERSATION)
public String getContextPath()

doPrint

public String doPrint(String defaultTheme)
               throws IOException

Throws:

IOException

doPrint

public String doPrint(DocumentModel doc,
                      String defaultTheme)
               throws IOException

Throws:

IOException

getPrintUrl

public String getPrintUrl(String defaultTheme)

getPrintUrl

public String getPrintUrl(DocumentModel doc,
                          String defaultTheme)

getHttpServletResponse

public static javax.servlet.http.HttpServletResponse getHttpServletResponse()

getHttpServletRequest

public static javax.servlet.http.HttpServletRequest getHttpServletRequest()

handleRedirect

public static void handleRedirect(javax.servlet.http.HttpServletResponse response,
                                  String url)
                           throws IOException

Throws:

IOException

getLocaleString

public String getLocaleString()

Returns the locale string.

Useful for url pattern bindings.

Since:

5.4.2

setLocaleString

public void setLocaleString(String localeString)

Sets the locale string if given string is not null and not empty, as well as on faces context view root in case it was already created so that it holds the new locale for future lookups by JSF components.

Useful for url pattern bindings.