com.communote.server.web.commons.helper

Class ControllerHelper

java.lang.Object

com.communote.server.web.commons.helper.ControllerHelper

public class ControllerHelper
extends Object

Helper class for common controller functionality.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_NAME_ERROR_PAGE_CUSTOM_MESSAGE Name of the request attribute to provide a custom localized error message.
static String	ATTRIBUTE_NAME_ERROR_PAGE_NEXT_TARGET Name of the request attribute to provide the target URL for the "Next" button on the error page

Method Summary

Modifier and Type	Method and Description
static String	appendTimestamp(String url, String urlPath) Append a timestamp to the given URL.
static void	dumpSession(javax.servlet.http.HttpServletRequest request) Dumps the session.
static void	forwardRequest(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, String urlPath) Makes a forward on the current client to the specified relative URL path.
static String	getRssFeedLink(RssSupportWidget rssSupportWidget) Gets the rss feed link.
static org.springframework.web.servlet.ModelAndView	prepareModelAndViewForJsonResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.codehaus.jackson.node.ObjectNode json, boolean writeJsonDirectly) Prepare a model and view with a view named "core.ajax.response".
static String	renderAbsoluteUrl(javax.servlet.http.HttpServletRequest request, String clientId, String urlPath, boolean forceHttps, boolean staticResource, boolean staticResourceByDispatcher) Renders an absolute URL for the provided URL path.
static String	renderAbsoluteUrl(javax.servlet.http.HttpServletRequest request, String clientId, String urlPath, boolean forceHttps, ChannelType channelTyp, boolean staticResource, boolean staticResourceByDispatcher) Renders an absolute URL for the provided URL path.
static String	renderAbsoluteUrlIgnoreRequestProtocol(javax.servlet.http.HttpServletRequest request, String clientId, String urlPath, boolean forceHttps, boolean staticResource, boolean staticResourceByDispatcher) Renders an absolute URL for the provided URL path.
static String	renderRelativeUrl(javax.servlet.http.HttpServletRequest request, String urlPath, boolean staticResource, boolean staticResourceByDispatcher) Renders a relative URL for the provided URL path that leads to the referenced resource on the current client.
static String	renderRelativeUrl(javax.servlet.http.HttpServletRequest request, String clientId, String urlPath, boolean staticResource, boolean staticResourceByDispatcher) Renders a relative URL for the provided URL path that leads to the referenced resource on the given client.
static String	renderUrl(javax.servlet.http.HttpServletRequest request, String urlPath, String baseUrl, boolean absolute, boolean secure, Boolean renderSessionId, String clientId, boolean staticResource, boolean staticResourceByDispatcher) Renders the URL for the specified urlPath.
static org.springframework.web.servlet.ModelAndView	replaceModuleInMAV(org.springframework.web.servlet.ModelAndView mav) Replace 'MODULE' in the view name of the MAV with the current module.
static String	replaceModuleInViewName(String viewName) Replace the module in the view name.
static void	sendInternalRedirect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String relativeUrl) Send a redirect within the web application.
static void	sendInternalRedirect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String clientId, String relativeUrl) Send a redirect within the web application.
static void	sendInternalRedirectToLogoutUrl(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Sends a redirect to the logout URL of the current client.
static void	sendInternalRedirectToStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Send a redirect within the web application.
static void	sendRedirect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String url) Send a redirect using the provided URL.
static void	setApplicationFailure(javax.servlet.http.HttpServletResponse response) Sets the application failure.
static void	setApplicationSuccess(javax.servlet.http.HttpServletResponse response) Sets the application success.

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_NAME_ERROR_PAGE_NEXT_TARGET

public static final String ATTRIBUTE_NAME_ERROR_PAGE_NEXT_TARGET

Name of the request attribute to provide the target URL for the "Next" button on the error page

See Also:

Constant Field Values

ATTRIBUTE_NAME_ERROR_PAGE_CUSTOM_MESSAGE

public static final String ATTRIBUTE_NAME_ERROR_PAGE_CUSTOM_MESSAGE

Name of the request attribute to provide a custom localized error message.

See Also:

Constant Field Values

Method Detail

appendTimestamp

public static String appendTimestamp(String url,
                                     String urlPath)

Append a timestamp to the given URL. If the given urlPath refers to an existing file, the last modification date of this file will be used. Otherwise the build timestamp of the current Communote version is used.

Parameters:

url - The URL to append the timestamp to.

urlPath - The URL path which was used for generating the URL. Can be null to force usage of the build timestamp.

Returns:

The URL including a timestamp.

dumpSession

public static void dumpSession(javax.servlet.http.HttpServletRequest request)

Dumps the session.

Parameters:

request - the request

forwardRequest

public static void forwardRequest(javax.servlet.ServletRequest request,
                                  javax.servlet.ServletResponse response,
                                  String urlPath)
                           throws javax.servlet.ServletException,
                                  IOException

Makes a forward on the current client to the specified relative URL path.

Parameters:

request - the current request to be forwarded

response - the response for forwarding

urlPath - path leading to the target resource. Client and module information will be added.

Throws:

IOException - in case the forward fails

javax.servlet.ServletException - in case the forward fails

getRssFeedLink

public static String getRssFeedLink(RssSupportWidget rssSupportWidget)

Gets the rss feed link.

Parameters:

rssSupportWidget - the rss support widget

Returns:

the rss link for the rss widget

prepareModelAndViewForJsonResponse

public static org.springframework.web.servlet.ModelAndView prepareModelAndViewForJsonResponse(javax.servlet.http.HttpServletRequest request,
                                                                                              javax.servlet.http.HttpServletResponse response,
                                                                                              org.codehaus.jackson.node.ObjectNode json,
                                                                                              boolean writeJsonDirectly)
                                                                                       throws IOException

Prepare a model and view with a view named "core.ajax.response". The method will set a request attribute htmlResponse to true if the Accept header does not contain application/json. In case it contains application/json the content-type will be set to application/json and the attribute will be set to false or the response is written directly if writeJsonDirectly is true. The view can access the jsonObject via the request attribute jsonResponse.

Parameters:

request - the current request

response - the response

json - the JSON to write

writeJsonDirectly - whether to write the JSON directly or let the view handle it. In case this is false the view must check for the attribute htmlResponse and if set to false directly write the JSON object.

Returns:

the model and view or null if the response has been written directly

Throws:

IOException - in case of an exception while serializing the JSON object to the response

renderAbsoluteUrl

public static String renderAbsoluteUrl(javax.servlet.http.HttpServletRequest request,
                                       String clientId,
                                       String urlPath,
                                       boolean forceHttps,
                                       boolean staticResource,
                                       boolean staticResourceByDispatcher)

Renders an absolute URL for the provided URL path. The returned URL will be a using the HTTPS protocol if the forceHttps parameter is true or ChannelManagement.isForceSsl() returns true or the current request was received via HTTPS. If the latter condition does not hold but one of the others does, the returned URL might still be using the HTTP protocol if the property ApplicationProperty.WEB_HTTPS_SUPPORTED is set to false.

Parameters:

request - the current request

clientId - the client ID to include. Can be null which will lead to including the ID of the current client.

urlPath - the URL path referencing a resource. The path doesn't have to start with a '/' and can be null.

forceHttps - whether to force an HTTPS URL

staticResource - true if the url should be rendered as a resource not to be delivered by the dispatcher servlet

staticResourceByDispatcher - true if the url should be rendered as a resource BUT delivered by the dispatcher servlet (see KenmeiForwardFilter)

Returns:

the absolute URL

renderAbsoluteUrl

public static String renderAbsoluteUrl(javax.servlet.http.HttpServletRequest request,
                                       String clientId,
                                       String urlPath,
                                       boolean forceHttps,
                                       ChannelType channelTyp,
                                       boolean staticResource,
                                       boolean staticResourceByDispatcher)

Renders an absolute URL for the provided URL path. The returned URL will be a using the HTTPS protocol if the forceHttps parameter is true or ChannelManagement#isForceSsl(ChannelType)) returns true for the provided channel or the current request was received via HTTPS. If the latter condition does not hold but one of the others does, the returned URL might still be using the HTTP protocol if the property ApplicationProperty.WEB_HTTPS_SUPPORTED is set to false.

Parameters:

request - the current request

clientId - the client ID to include. Can be null which will lead to including the ID of the current client.

urlPath - the URL path referencing a resource. The path doesn't have to start with a '/' and can be null.

forceHttps - whether to force an HTTPS URL

channelTyp - the channel to check for a forced SSL connection, instead of using the current channel

staticResource - true if the url should be rendered as a resource not to be delivered by the dispatcher servlet

staticResourceByDispatcher - true if the url should be rendered as a resource BUT delivered by the dispatcher servlet (see KenmeiForwardFilter)

Returns:

the absolute URL

renderAbsoluteUrlIgnoreRequestProtocol

public static String renderAbsoluteUrlIgnoreRequestProtocol(javax.servlet.http.HttpServletRequest request,
                                                            String clientId,
                                                            String urlPath,
                                                            boolean forceHttps,
                                                            boolean staticResource,
                                                            boolean staticResourceByDispatcher)

Renders an absolute URL for the provided URL path. The returned URL will be a using the HTTPS protocol if the forceHttps parameter is true or ChannelManagement.isForceSsl() returns true. the returned URL might still be using the HTTP protocol if the property ApplicationProperty.WEB_HTTPS_SUPPORTED is set to false. In contrast to #renderAbsoluteUrl(HttpServletRequest, String, String, boolean) the protocol used for the current request will not be evaluated.

Parameters:

request - the current request

clientId - the client ID to include. Can be null which will lead to including the ID of the current client.

urlPath - the URL path referencing a resource. The path doesn't have to start with a '/' and can be null.

forceHttps - whether to force an HTTPS URL

staticResource - true if the url should be rendered as a resource not to be delivered by the dispatcher servlet

staticResourceByDispatcher - true if the url should be rendered as a resource BUT delivered by the dispatcher servlet (see KenmeiForwardFilter)

Returns:

the absolute URL

renderRelativeUrl

public static String renderRelativeUrl(javax.servlet.http.HttpServletRequest request,
                                       String urlPath,
                                       boolean staticResource,
                                       boolean staticResourceByDispatcher)

Renders a relative URL for the provided URL path that leads to the referenced resource on the current client. For example 'portal/home.do' becomes '/microblog/global/portal/home.do' if the current client is named 'global'. The context is included.

Parameters:

request - the current request

urlPath - the URL path referencing a resource. The path doesn't have to start with a '/' and can be null.

staticResource - true if the url should be rendered as a resource not to be delivered by the dispatcher servlet

staticResourceByDispatcher - true if the url should be rendered as a resource BUT delivered by the dispatcher servlet (see KenmeiForwardFilter)

Returns:

the relative URL, starting with a '/'

renderRelativeUrl

public static String renderRelativeUrl(javax.servlet.http.HttpServletRequest request,
                                       String clientId,
                                       String urlPath,
                                       boolean staticResource,
                                       boolean staticResourceByDispatcher)

Renders a relative URL for the provided URL path that leads to the referenced resource on the given client. For example 'portal/home.do' becomes '/microblog/global/portal/home.do' if the provided clientId is 'global'. The context is included.

Parameters:

request - the current request

clientId - the client ID to include. Can be null which will lead to including the ID of the current client.

urlPath - the URL path referencing a resource. The path doesn't have to start with a '/' and can be null.

staticResource - true if the URL should be rendered as a resource which will not be delivered by the dispatcher servlet

staticResourceByDispatcher - true if the url should be rendered as a resource BUT delivered by the dispatcher servlet (see KenmeiForwardFilter)

Returns:

the relative URL, starting with a '/'

renderUrl

public static String renderUrl(javax.servlet.http.HttpServletRequest request,
                               String urlPath,
                               String baseUrl,
                               boolean absolute,
                               boolean secure,
                               Boolean renderSessionId,
                               String clientId,
                               boolean staticResource,
                               boolean staticResourceByDispatcher)

Renders the URL for the specified urlPath.

Parameters:

request - the current request to retrieve session data

urlPath - the URL path

baseUrl - optional string with a URL that should be prefixed to the urlPath. If set, the parameters absolute, secure and clientId will be ignored.

absolute - whether the URL should be rendered as an absolute URL. Will be ignored if baseUrl is not null.

secure - whether the URL should be rendered with the HTTPS protocol. Will be ignored if absolute is false or baseUrl is not null.

renderSessionId - optional parameter to force inclusion of the current session ID. If null the session ID will be included if the request asked for an existing session and the session ID was not received via a cookie. If not null and true the ID of the current session will be included. In case there is no session the session will be created. If baseUrl is not null the session ID won't be included.

clientId - the ID of the client to be included in the URL. If null the ID of the current client will be used. Will be ignored if baseUrl is not null.

staticResource - true if the url should be rendered as a resource not to be delivered by the dispatcher servlet

staticResourceByDispatcher - true if the url should be rendered as a resource BUT delivered by the dispatcher servlet (see KenmeiForwardFilter)

Returns:

the rendered URL

replaceModuleInMAV

public static org.springframework.web.servlet.ModelAndView replaceModuleInMAV(org.springframework.web.servlet.ModelAndView mav)

Replace 'MODULE' in the view name of the MAV with the current module.

Parameters:

mav - the mav to check

Returns:

the model and view

replaceModuleInViewName

public static String replaceModuleInViewName(String viewName)

Replace the module in the view name.

Parameters:

viewName - the view name

Returns:

the view name with replaced module

sendInternalRedirect

public static void sendInternalRedirect(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response,
                                        String relativeUrl)
                                 throws IOException

Send a redirect within the web application. The redirect will be sent to the current client.

Parameters:

request - the current request

response - the response for the redirect

relativeUrl - a relative URL to append. can be null

Throws:

IOException - in case the redirect fails

sendInternalRedirect

public static void sendInternalRedirect(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response,
                                        String clientId,
                                        String relativeUrl)
                                 throws IOException

Send a redirect within the web application. The redirect will be sent to the provided client or if not specified to the current client.

Parameters:

request - the current request

response - the response for the redirect

clientId - the ID of the client to redirect to. If this parameter is null the redirect will be sent to the current client.

relativeUrl - a relative URL to append. can be null

Throws:

IOException - in case the redirect fails

sendInternalRedirectToLogoutUrl

public static void sendInternalRedirectToLogoutUrl(javax.servlet.http.HttpServletRequest request,
                                                   javax.servlet.http.HttpServletResponse response)
                                            throws IOException

Sends a redirect to the logout URL of the current client.

Parameters:

request - the current request

response - the response for the redirect

Throws:

IOException - in case the redirect fails

sendInternalRedirectToStartPage

public static void sendInternalRedirectToStartPage(javax.servlet.http.HttpServletRequest request,
                                                   javax.servlet.http.HttpServletResponse response)
                                            throws IOException

Send a redirect within the web application. The redirect will be sent to the start page of the current client.

Parameters:

request - the current request

response - the response for the redirect

Throws:

IOException - in case the redirect fails

sendRedirect

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

Send a redirect using the provided URL.

Parameters:

request - the current request

response - the response for the redirect

url - the URL. Can be absolute or relative. In case it is relative the redirect will be on the server, but no client ID will be included.

Throws:

IOException - in case of an error

setApplicationFailure

public static void setApplicationFailure(javax.servlet.http.HttpServletResponse response)

Sets the application failure.

Parameters:

response - the response

setApplicationSuccess

public static void setApplicationSuccess(javax.servlet.http.HttpServletResponse response)

Sets the application success.

Parameters:

response - the response