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

Class URLPolicyServiceImpl

java.lang.Object

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

All Implemented Interfaces:

URLPolicyService

public class URLPolicyServiceImpl
extends Object
implements URLPolicyService

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,URLPatternDescriptor>	descriptors
static String	DOWNLOADFILE_PATTERN
static String	NAME
protected StaticNavigationHandler	viewIdManager

Fields inherited from interface org.nuxeo.ecm.platform.ui.web.rest.api.URLPolicyService

DISABLE_ACTION_BINDING_KEY, DISABLE_REDIRECT_REQUEST_KEY, DOCUMENT_VIEW_REQUEST_KEY, FORCE_URL_ENCODING_REQUEST_KEY, POST_OUTCOME_REQUEST_KEY

Constructor Summary

Constructors

Constructor and Description
URLPolicyServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addPatternDescriptor(URLPatternDescriptor pattern)
void	appendParametersToRequest(javax.faces.context.FacesContext facesContext) Appends parameters to request so that the model can be restored after request.
void	appendParametersToRequest(javax.faces.context.FacesContext facesContext, String pattern)
void	applyRequestParameters(javax.faces.context.FacesContext facesContext) Extracts parameters from request attributes.
void	clear()
void	flushCache() Flushes the URLPolicyService cache, to be called when hot reload is performed for instance.
protected URLPatternDescriptor	getDefaultPatternDescriptor()
String	getDefaultPatternName() Returns the default pattern descriptor name
protected static DocumentViewCodecManager	getDocumentViewCodecService()
DocumentView	getDocumentViewFromRequest(javax.servlet.http.HttpServletRequest request) Builds the document view from request information.
DocumentView	getDocumentViewFromRequest(String patternName, javax.servlet.http.HttpServletRequest request) Builds the document view from request information.
String	getOutcomeFromUrl(String url, javax.servlet.http.HttpServletRequest request) Returns an outcome given a url, to fill a document view when parsing a standard JSF URL.
String	getOutcomeFromViewId(String viewId, javax.servlet.http.HttpServletRequest httpRequest) Returns an outcome given a view id, to fill a document view when parsing a standard JSF URL.
protected List<URLPatternDescriptor>	getSortedURLPatternDescriptorsFor(String viewId) Deprecated. since 5.5
String	getUrlFromDocumentView(DocumentView docView, String baseUrl) Returns a URL given a document view.
String	getUrlFromDocumentView(String patternName, DocumentView docView, String baseUrl) Returns a URL given a document view.
protected URLPatternDescriptor	getURLPatternDescriptor(DocumentView docView)
protected URLPatternDescriptor	getURLPatternDescriptor(javax.servlet.http.HttpServletRequest request)
protected URLPatternDescriptor	getURLPatternDescriptor(String patternName)
protected List<URLPatternDescriptor>	getURLPatternDescriptors()
String	getViewIdFromOutcome(String outcome, javax.servlet.http.HttpServletRequest httpRequest) Returns the view id given an outcome, to dispatch to the right view given an outcome.
boolean	hasPattern(String name) Returns true if the service holds a pattern descriptor with given name
void	initViewIdManager(javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Initializes the view id manager StaticNavigationHandler using the given servlet context.
boolean	isCandidateForDecoding(javax.servlet.http.HttpServletRequest httpRequest) Returns true if request is a GET request and filter preprocessing is turned on.
boolean	isCandidateForEncoding(javax.servlet.http.HttpServletRequest httpRequest) Returns true if request is a POST request and filter redirection is turned on.
String	navigate(javax.faces.context.FacesContext facesContext) Performs redirection action.
void	removePatternDescriptor(URLPatternDescriptor pattern)
void	setDocumentViewInRequest(javax.servlet.http.HttpServletRequest request, DocumentView docView) Adds document view to the request for later retrieval.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

DOWNLOADFILE_PATTERN

public static final String DOWNLOADFILE_PATTERN

See Also:

Constant Field Values

descriptors

protected final Map<String,URLPatternDescriptor> descriptors

viewIdManager

protected StaticNavigationHandler viewIdManager

Constructor Detail

URLPolicyServiceImpl

public URLPolicyServiceImpl()

Method Detail

getURLPatternDescriptors

protected List<URLPatternDescriptor> getURLPatternDescriptors()

getDefaultPatternDescriptor

protected URLPatternDescriptor getDefaultPatternDescriptor()

getDefaultPatternName

public String getDefaultPatternName()

Description copied from interface: URLPolicyService

Returns the default pattern descriptor name

Specified by:

getDefaultPatternName in interface URLPolicyService

hasPattern

public boolean hasPattern(String name)

Description copied from interface: URLPolicyService

Returns true if the service holds a pattern descriptor with given name

Specified by:

hasPattern in interface URLPolicyService

getDocumentViewCodecService

protected static DocumentViewCodecManager getDocumentViewCodecService()

getURLPatternDescriptor

protected URLPatternDescriptor getURLPatternDescriptor(String patternName)

isCandidateForDecoding

public boolean isCandidateForDecoding(javax.servlet.http.HttpServletRequest httpRequest)

Description copied from interface: URLPolicyService

Returns true if request is a GET request and filter preprocessing is turned on.

Specified by:

isCandidateForDecoding in interface URLPolicyService

isCandidateForEncoding

public boolean isCandidateForEncoding(javax.servlet.http.HttpServletRequest httpRequest)

Description copied from interface: URLPolicyService

Returns true if request is a POST request and filter redirection is turned on.

Specified by:

isCandidateForEncoding in interface URLPolicyService

setDocumentViewInRequest

public void setDocumentViewInRequest(javax.servlet.http.HttpServletRequest request,
                                     DocumentView docView)

Description copied from interface: URLPolicyService

Adds document view to the request for later retrieval.

Specified by:

setDocumentViewInRequest in interface URLPolicyService

Parameters:

request - the current request.

docView - to save

getURLPatternDescriptor

protected URLPatternDescriptor getURLPatternDescriptor(javax.servlet.http.HttpServletRequest request)

getDocumentViewFromRequest

public DocumentView getDocumentViewFromRequest(javax.servlet.http.HttpServletRequest request)

Description copied from interface: URLPolicyService

Builds the document view from request information.

Delegates call to a document view codec found thanks to the default URL pattern descriptor.

Specified by:

getDocumentViewFromRequest in interface URLPolicyService

getDocumentViewFromRequest

public DocumentView getDocumentViewFromRequest(String patternName,
                                               javax.servlet.http.HttpServletRequest request)

Description copied from interface: URLPolicyService

Builds the document view from request information.

Delegates call to a document view codec found thanks given pattern name.

Specified by:

getDocumentViewFromRequest in interface URLPolicyService

getURLPatternDescriptor

protected URLPatternDescriptor getURLPatternDescriptor(DocumentView docView)

getUrlFromDocumentView

public String getUrlFromDocumentView(DocumentView docView,
                                     String baseUrl)

Description copied from interface: URLPolicyService

Returns a URL given a document view.

Delegates call to a document view codec found thanks to the default URL pattern descriptor.

Specified by:

getUrlFromDocumentView in interface URLPolicyService

getSortedURLPatternDescriptorsFor

@Deprecated
protected List<URLPatternDescriptor> getSortedURLPatternDescriptorsFor(String viewId)

Deprecated. since 5.5

Returns patterns sorted according to:

• First patterns holding the given view id
• The default pattern if it does not hold this view id
• Other patterns not holding this view id

Parameters:

viewId -

Since:

5.4.2

getUrlFromDocumentView

public String getUrlFromDocumentView(String patternName,
                                     DocumentView docView,
                                     String baseUrl)

Description copied from interface: URLPolicyService

Returns a URL given a document view.

Delegates call to a document view codec found thanks given pattern name.

Specified by:

getUrlFromDocumentView in interface URLPolicyService

applyRequestParameters

public void applyRequestParameters(javax.faces.context.FacesContext facesContext)

Description copied from interface: URLPolicyService

Extracts parameters from request attributes.

Apply them to the model using EL value bindings described on URL pattern descriptors.

We look for binding values to set on the request attribute and on the document view parameters.

Specified by:

applyRequestParameters in interface URLPolicyService

appendParametersToRequest

public void appendParametersToRequest(javax.faces.context.FacesContext facesContext)

Description copied from interface: URLPolicyService

Appends parameters to request so that the model can be restored after request.

Extract them using EL value bindings described on URL pattern descriptors.

If the document view is not null, values are set on its parameters. If the document view is null, values are set on the request parameters.

Specified by:

appendParametersToRequest in interface URLPolicyService

appendParametersToRequest

public void appendParametersToRequest(javax.faces.context.FacesContext facesContext,
                                      String pattern)

navigate

public String navigate(javax.faces.context.FacesContext facesContext)

Description copied from interface: URLPolicyService

Performs redirection action.

Extract it using an EL action binding described on URL pattern descriptors.

The action binding is called using given document view as parameter. If a sub URI is found, do nothing (may be an invalid resource URL).

Specified by:

navigate in interface URLPolicyService

addPatternDescriptor

public void addPatternDescriptor(URLPatternDescriptor pattern)

Specified by:

addPatternDescriptor in interface URLPolicyService

removePatternDescriptor

public void removePatternDescriptor(URLPatternDescriptor pattern)

Specified by:

removePatternDescriptor in interface URLPolicyService

initViewIdManager

public void initViewIdManager(javax.servlet.ServletContext context,
                              javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)

Description copied from interface: URLPolicyService

Initializes the view id manager StaticNavigationHandler using the given servlet context.

Specified by:

initViewIdManager in interface URLPolicyService

getOutcomeFromViewId

public String getOutcomeFromViewId(String viewId,
                                   javax.servlet.http.HttpServletRequest httpRequest)

Description copied from interface: URLPolicyService

Returns an outcome given a view id, to fill a document view when parsing a standard JSF URL.

For instance, will return "view_documents" given "/view_documents.xhtml" or "/view_documents.faces".

Specified by:

getOutcomeFromViewId in interface URLPolicyService

getOutcomeFromUrl

public String getOutcomeFromUrl(String url,
                                javax.servlet.http.HttpServletRequest request)

Description copied from interface: URLPolicyService

Returns an outcome given a url, to fill a document view when parsing a standard JSF URL.

It parses the given url to extract the outcome, and then calls URLPolicyService.getOutcomeFromViewId(String, HttpServletRequest)

Specified by:

getOutcomeFromUrl in interface URLPolicyService

getViewIdFromOutcome

public String getViewIdFromOutcome(String outcome,
                                   javax.servlet.http.HttpServletRequest httpRequest)

Description copied from interface: URLPolicyService

Returns the view id given an outcome, to dispatch to the right view given an outcome.

For instance, will return "/view_documents.xhtml" given "view_documents".

Specified by:

getViewIdFromOutcome in interface URLPolicyService

clear

public void clear()

Specified by:

clear in interface URLPolicyService

flushCache

public void flushCache()

Description copied from interface: URLPolicyService

Flushes the URLPolicyService cache, to be called when hot reload is performed for instance.

Specified by:

flushCache in interface URLPolicyService