com.communote.server.persistence.user.client

Class ClientUrlHelper

java.lang.Object

com.communote.server.persistence.user.client.ClientUrlHelper

public class ClientUrlHelper
extends Object

The Class ClientUrlHelper offers methods to add the client and module id to an url.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODULE_MICROBLOG Name of the microblogging module.

Method Summary

Modifier and Type	Method and Description
static void	appendUrlPath(StringBuilder url, String urlPath) Appends a urlPath to the provided url if the urlPath is not empty or blank
static String	getClientId(String urlPart) Gets the client id from the URL part.
static String	prependModuleClientPart(String urlPath) Prepends the module and client ID of the current client to the provided URL path.
static String	prependModuleClientPart(String clientId, String urlPath) Prepends the module and client ID to the provided URL path.
static String	removeIds(String uri) Removes the module and client id from the given uri.
static String	renderConfiguredAbsoluteUrl(String urlPath, boolean isSecure) Renders an absolute URL pointing to a resource on the current client.
static String	renderConfiguredAbsoluteUrl(String clientId, String urlPath, boolean isSecure, boolean staticResource) Renders an absolute URL pointing to a resource on the given client.

Methods inherited from class java.lang.Object

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

Field Detail

MODULE_MICROBLOG

public static final String MODULE_MICROBLOG

Name of the microblogging module.

See Also:

Constant Field Values

Method Detail

appendUrlPath

public static void appendUrlPath(StringBuilder url,
                                 String urlPath)

Appends a urlPath to the provided url if the urlPath is not empty or blank

Parameters:

url - the URL to extend. The URL is expected to not have a trailing '/'.

urlPath - the path to append. Can be null or empty and does not have to start with a '/'.

getClientId

public static String getClientId(String urlPart)

Gets the client id from the URL part. The URL part should look like '/microblog/client-id[/optional-url-path]'

Parameters:

urlPart - the part of the URL after the context

Returns:

the client id or the default id if no id was found

prependModuleClientPart

public static String prependModuleClientPart(String urlPath)

Prepends the module and client ID of the current client to the provided URL path. The returned string starts with a '/'.

Parameters:

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

Returns:

the module and client URL part

prependModuleClientPart

public static String prependModuleClientPart(String clientId,
                                             String urlPath)

Prepends the module and client ID to the provided URL path. The returned string starts with a '/'.

Parameters:

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

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

Returns:

the module and client URL part

removeIds

public static String removeIds(String uri)

Removes the module and client id from the given uri.

Parameters:

uri - the uri

Returns:

the uri without ids

renderConfiguredAbsoluteUrl

public static String renderConfiguredAbsoluteUrl(String urlPath,
                                                 boolean isSecure)

Renders an absolute URL pointing to a resource on the current client. This method should only be used if there is no access to a Request object because the URL might not be working if the configuration is wrong or wasn't adapted to the latest changes of the server settings. In case of access to Request object the appropriate method of the ControllerHelper should be used.

Parameters:

urlPath - a (relative) URL path without client and module information, can be empty or null

isSecure - whether the URL should be rendered with the HTTPS or HTTP protocol. If the configuration states that HTTPS is not supported, the returned URL will use the HTTP protocol.

Returns:

the URL

renderConfiguredAbsoluteUrl

public static String renderConfiguredAbsoluteUrl(String clientId,
                                                 String urlPath,
                                                 boolean isSecure,
                                                 boolean staticResource)

Renders an absolute URL pointing to a resource on the given client. This method should only be used if there is no access to a Request object because the URL might not be working if the configuration is wrong or wasn't adapted to the latest changes of the server settings. In case of access to Request object the appropriate method of the ControllerHelper should be used.

Parameters:

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

urlPath - a (relative) URL path without client and module information, can be empty or null

isSecure - whether the URL should be rendered with the HTTPS or HTTP protocol. If the configuration states that HTTPS is not supported, the returned URL will use the HTTP protocol.

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

Returns:

the URL