com.communote.server.web.commons.viewtool

Class UrlTool

java.lang.Object

com.communote.server.web.commons.viewtool.RequestAwareTool

com.communote.server.web.commons.viewtool.UrlTool

@DefaultKey(value="urlTool")
 @ValidScope(value="request")
public class UrlTool
extends RequestAwareTool

Tool for rendering application URLs.

Author:

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

Constructor Summary

Constructors

Constructor and Description
UrlTool() Constructor.

Method Summary

Modifier and Type	Method and Description
String	blog(String alias) Renders a permanent link to the named blog
String	blogFromId(String blogId) Renders a permanent link to the named blog
String	clientImage(ImageSizeType size) Creates a URL pointing to the logo of the current client.
String	createBuildTimestampParam() Creates a request parameter holding the build timestamp.
String	currentUser() Renders a permanent link to the current user
String	getExternalObjectLink(String externalSystemId, String externalObjectId) Returns a link to the given external object within the external system.
String	getFaviconUrl()
String	image(String entityId, CoreImageType imageType, ImageSizeType size) Creates a URL pointing to an imag for the given entity.
String	imageForBanner(String entityId)
String	imageForProfile(String entityId)
String	insertSessionId(String url) This method inserts the session id into the url.
String	note(String blogAlias, Long noteId) Renders a permanent link to the note
String	render(String urlPath) Renders the URL for the specified urlPath.
String	render(String urlPath, boolean absolute, boolean secure, boolean staticResource) Renders the URL for the specified urlPath.
String	render(String urlPath, boolean absolute, String channelTypeAsString, boolean staticResource) Renders the URL for the specified urlPath.
String	render(String urlPath, String baseUrl, boolean absolute, boolean secure, Boolean renderSessionId, String clientId, boolean staticResource) Renders the URL for the specified urlPath.
String	renderAttachmentUrl(Attachment attachment) Determine the relative attachment URL path for a resource
String	renderAttachmentUrl(Attachment attachment, boolean useAbsoluteUrl, boolean staticResource) Determine the resource URL for download/access for the given item
String	renderAttachmentUrl(AttachmentData attachment) Determine the relative attachment URL path for a resource
String	renderAttachmentUrl(AttachmentData attachment, boolean useAbsoluteUrl, boolean staticResource) Determine the resource URL for download/access for the given item
String	renderConcatenatedCssUrl(String categoryName, boolean minimized) Render the URL to the concatenated CSS of a given category.
String	renderConcatenatedJsUrl(String categoryName, boolean minimized) Render the URL to the concatenated JavaScript of a given category.
List<String>	renderCssUrls(String categoryName, boolean minimized) Render the URLs to the CSS resources of the given category.
String	renderIfRelative(String urlPath) Uses render(String) to render the URL if it is relative, otherwise the URL is returned unchanged.
List<String>	renderJsUrls(String categoryName, boolean minimized) Render the URLs to the JavaScript resources of the given category.
String	renderStartpage() Renders the startpage url.
String	renderStatic(String urlPath) Renders the URL of a static resource which is not delivered by the dispatcher servlet.
String	renderStaticBase(boolean absolute, boolean secure, String clientId) Renders the base URL of all static resources.
String	tag(long tagId) Renders a permanent link to the given tag.
String	tag(String tag) Deprecated. Use tag(long) instead.
String	topicDefaultProfileImage() Set the image url to the default topic image.
String	user(String alias) Renders a permanent link to the named user
String	userImage(Long userId, ImageSizeType size) Creates a URL pointing to a user image.
String	userImage(UserData user, ImageSizeType size) Creates a URL pointing to a user image.

Methods inherited from class com.communote.server.web.commons.viewtool.RequestAwareTool

getRequest, getResponse, getServletContext, setRequest, setResponse, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlTool

public UrlTool()

Constructor.

Method Detail

blog

public String blog(String alias)

Renders a permanent link to the named blog

Parameters:

alias - the alias of the blog

Returns:

the link

blogFromId

public String blogFromId(String blogId)

Renders a permanent link to the named blog

Parameters:

blogId - The blogs id as String.

Returns:

the link

clientImage

public String clientImage(ImageSizeType size)

Creates a URL pointing to the logo of the current client.

Parameters:

size - the size of the logo

Returns:

the URL to the client logo

createBuildTimestampParam

public String createBuildTimestampParam()

Creates a request parameter holding the build timestamp.

Returns:

the parameter string

currentUser

public String currentUser()

Renders a permanent link to the current user

Returns:

the link

getExternalObjectLink

public String getExternalObjectLink(String externalSystemId,
                                    String externalObjectId)

Returns a link to the given external object within the external system.

Parameters:

externalSystemId - The external system id.

externalObjectId - The external object id.

Returns:

The link or null, if there is no generator for the given external system.

getFaviconUrl

public String getFaviconUrl()

Returns:

the URL of the favicon icon

image

public String image(String entityId,
                    CoreImageType imageType,
                    ImageSizeType size)

Creates a URL pointing to an imag for the given entity.

Parameters:

entityId - Id of the entity to get the link for.

imageType - Type of the image.

size - Size of the requested image.

Returns:

the URL to the image

imageForBanner

public String imageForBanner(String entityId)

Parameters:

entityId - Id of the entity to get the link for.

Returns:

The url for the large banner image of the given entity.

imageForProfile

public String imageForProfile(String entityId)

Parameters:

entityId - Id of the entity to get the link for.

Returns:

The url for the large profile image of the given entity.

insertSessionId

public String insertSessionId(String url)

This method inserts the session id into the url. This should only be used for internal urls.

Parameters:

url - The url.

Returns:

The url with session id inserted.

note

public String note(String blogAlias,
                   Long noteId)

Renders a permanent link to the note

Parameters:

blogAlias - the alias of the blog

noteId - the id of the note

Returns:

the link

render

public String render(String urlPath)

Renders the URL for the specified urlPath. Delegates to #render(String, boolean, boolean) with parameters absolute and secure set to false.

Parameters:

urlPath - the URL path

Returns:

the created URL

render

public String render(String urlPath,
                     boolean absolute,
                     boolean secure,
                     boolean staticResource)

Renders the URL for the specified urlPath. Delegates to #render(String, String, boolean, boolean, Boolean, String) with parameters baseUrl, renderSessionId and clientId set to null.

Parameters:

urlPath - the URL path

absolute - whether the URL should be rendered as an absolute URL

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

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

Returns:

the rendered URL

render

public String render(String urlPath,
                     boolean absolute,
                     String channelTypeAsString,
                     boolean staticResource)
              throws IllegalArgumentException

Renders the URL for the specified urlPath. Delegates to #render(String, String, boolean, boolean, Boolean, String) with parameters baseUrl, renderSessionId and clientId set to null.

Parameters:

urlPath - the URL path

absolute - whether the URL should be rendered as an absolute URL

channelTypeAsString - The channel type as string to check against.

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

Returns:

the rendered URL

Throws:

IllegalArgumentException - Thrown, when there is no such channel type.

render

public String render(String urlPath,
                     String baseUrl,
                     boolean absolute,
                     boolean secure,
                     Boolean renderSessionId,
                     String clientId,
                     boolean staticResource)

Renders the URL for the specified urlPath.

Parameters:

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 which will not be handled by the dispatcher servlet

Returns:

the rendered URL

renderAttachmentUrl

public String renderAttachmentUrl(Attachment attachment)

Determine the relative attachment URL path for a resource

Parameters:

attachment - The attachment.

Returns:

the relative URL path for the attachment.

renderAttachmentUrl

public String renderAttachmentUrl(Attachment attachment,
                                  boolean useAbsoluteUrl,
                                  boolean staticResource)

Determine the resource URL for download/access for the given item

Parameters:

attachment - the attachment.

useAbsoluteUrl - true to render absolute URL

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

Returns:

URL for the attachment.

renderAttachmentUrl

public String renderAttachmentUrl(AttachmentData attachment)

Determine the relative attachment URL path for a resource

Parameters:

attachment - the attachment list item.

Returns:

the relative URL path for the attachment.

renderAttachmentUrl

public String renderAttachmentUrl(AttachmentData attachment,
                                  boolean useAbsoluteUrl,
                                  boolean staticResource)

Determine the resource URL for download/access for the given item

Parameters:

attachment - the attachment list item.

useAbsoluteUrl - true to render absolute URL

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

Returns:

URL for the attachment.

renderConcatenatedCssUrl

public String renderConcatenatedCssUrl(String categoryName,
                                       boolean minimized)

Render the URL to the concatenated CSS of a given category.

Parameters:

categoryName - the name of the category

minimized - whether to return the minimized version of the concatenated CSS

Returns:

the URL to retrieve the concatenated CSS or empty string if the resource does not exist

renderConcatenatedJsUrl

public String renderConcatenatedJsUrl(String categoryName,
                                      boolean minimized)

Render the URL to the concatenated JavaScript of a given category.

Parameters:

categoryName - the name of the category

minimized - whether to return the minimized version of the concatenated JavaScript

Returns:

the URL to retrieve the concatenated JavaScript or empty string if the resource does not exist

renderCssUrls

public List<String> renderCssUrls(String categoryName,
                                  boolean minimized)

Render the URLs to the CSS resources of the given category.

Parameters:

categoryName - the name of the category

minimized - whether to render the URLs to the minimized versions

Returns:

the URLs to the CSS resources. The list will be empty if the category is not known.

renderIfRelative

public String renderIfRelative(String urlPath)

Uses render(String) to render the URL if it is relative, otherwise the URL is returned unchanged.

Example:

• https://github.com/communote remains https://github.com/communote
• /portal/home becomes /microblog/global/portal/home

Parameters:

urlPath - the url to render

Returns:

the rendered or unmodified URL

renderJsUrls

public List<String> renderJsUrls(String categoryName,
                                 boolean minimized)

Render the URLs to the JavaScript resources of the given category.

Parameters:

categoryName - the name of the category

minimized - whether to render the URLs to the minimized versions

Returns:

the URLs to the JavaScript resources. The list will be empty if the category is not known.

renderStartpage

public String renderStartpage()

Renders the startpage url.

Returns:

the startpage url

renderStatic

public String renderStatic(String urlPath)

Renders the URL of a static resource which is not delivered by the dispatcher servlet. This is a convenience function for the render method.

Parameters:

urlPath - The URL path.

Returns:

the rendered URL

renderStaticBase

public String renderStaticBase(boolean absolute,
                               boolean secure,
                               String clientId)

Renders the base URL of all static resources. This function won't add the sessionId or a timestamp request parameter.

Parameters:

absolute - whether the URL should be rendered as an absolute URL.

secure - whether the URL should be rendered with the HTTPS protocol

clientId - the ID of the client to be included in the URL. If null the ID of the current client will be used.

Returns:

the rendered URL

tag

public String tag(long tagId)

Renders a permanent link to the given tag.

Parameters:

tagId - The tag.

Returns:

the link

tag

@Deprecated
public String tag(String tag)

Deprecated. Use tag(long) instead.

Renders a permanent link to the given tag.

Parameters:

tag - The tag.

Returns:

the link

topicDefaultProfileImage

public String topicDefaultProfileImage()

Set the image url to the default topic image.

Returns:

the url to the default profile image

user

public String user(String alias)

Renders a permanent link to the named user

Parameters:

alias - the alias of the user

Returns:

the link

userImage

public String userImage(Long userId,
                        ImageSizeType size)

Creates a URL pointing to a user image.

Parameters:

userId - the ID of the user whose image should be rendered

size - the size of the image

Returns:

the URL to the image

userImage

public String userImage(UserData user,
                        ImageSizeType size)

Creates a URL pointing to a user image.

Parameters:

user - the user whose image should be rendered

size - the size of the image

Returns:

the URL to the image