CommunoteTool (Communote 3.5 API)

java.lang.Object
- com.communote.server.core.common.velocity.CommunoteTool

```
@DefaultKey(value="communoteTool")
public class CommunoteTool
extends Object
```
Facade to different helper functions.

Author:

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class CommunoteTool.AuthenticationTool
Authentication specific tool.

Nested Classes
Modifier and Type	Class and Description
`class`	`CommunoteTool.AuthenticationTool` Authentication specific tool.

Constructor Summary

Constructors
Constructor and Description

CommunoteTool()

Constructors
Constructor and Description
`CommunoteTool()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`convertToJsonString(Map<String,Object> mapping, boolean xmlEscape)` Convert the map to a serialized JSON string.
`Long`	`getActiveUserCount()`
`String`	`getAllUserPreferencesAsJson()`
`ApplicationInformation`	`getApplicationInformation()`
`CommunoteTool.AuthenticationTool`	`getAuth()`
`TopicTool`	`getBlogs()` Deprecated. Use `getTopics()` instead.
`ClientTool`	`getClient()`
`String`	`getConfigurationProperty(ClientConfigurationPropertyConstant key)` Get the value of a configuration property.
`int`	`getConfigurationProperty(ClientConfigurationPropertyConstant key, int fallback)` Get the value of a configuration property.
`String`	`getConfigurationPropertyAsString(ClientConfigurationPropertyConstant key, String fallback)` Get the value of a configuration property as String.
`List<Country>`	`getCountries(javax.servlet.http.HttpServletRequest request)` Delegates to `MasterDataManagement.getCountries(Locale)`
`String`	`getCurrentClientId()` Delegates to `ClientHelper.getCurrentClientId()`
`String`	`getCurrentClientName()` Delegates to `ClientHelper.getCurrentClient()`
`int`	`getCurrentOffsetOfEffectiveUserTimeZone()` Delegates to `UserManagementHelper.getCurrentOffsetOfEffectiveUserTimeZone()`
`String`	`getCurrentUserAlias()` Delegates to `SecurityHelper.getCurrentUserAlias()`
`TimeZone`	`getCurrentUserEffectiveTimeZone()`
`Long`	`getCurrentUserId()` Delegates to `SecurityHelper.getCurrentUserId()`
`Locale`	`getCurrentUserLocale(javax.servlet.http.HttpServletRequest request)`
`UserProfileVO`	`getCurrentUserProfile()`
`String`	`getCurrentUserSignature(UserNameFormat format)` To get the signature of the current user.
`String`	`getDisplayNameForExternalObject(javax.servlet.http.HttpServletRequest request, String externalSystemId)` Get the display name for an external object linked to an topic.
`Collection<Language>`	`getLanguages()` Delegates to `MasterDataManagement.getLanguages()`
`MessageTool`	`getMessages()`
`TagTool`	`getTags()`
`List<SimplifiedTimeZone>`	`getTimeZones()` Delegates to `MasterDataManagement.getTimeZones()`
`TopicTool`	`getTopics()`
`Collection<Language>`	`getUsedLanguages()` Delegates to `MasterDataManagement.getUsedLanguages()`
`UserData`	`getUser(Number id)` Get the details of a user.
`UserPreference`	`getUserPreferences(String className)`
`String`	`getUserPreferencesAsJson(String className)`
`String`	`getUserSignature(UserData userListItem, UserNameFormat format)` To get the signature of an author.
`String`	`getUserSignature(UserProfileDetailListItem listItem, UserNameFormat format)` To get the signature of an author.
`String`	`getUserSignature(User user, UserNameFormat format)` To get the signature of an author.
`boolean`	`isCompressCss()`
`boolean`	`isCompressJavaScript()`
`boolean`	`isCurrentUserClientManager()`
`boolean`	`isDevelopment()`
`boolean`	`isForceSsl(ChannelType type)` Delegates to `ChannelManagement.isForceSsl(ChannelType)`
`boolean`	`isPackCss()`
`boolean`	`isPackJavaScript()`
`boolean`	`isStandalone()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CommunoteTool
```
public CommunoteTool()
```
- Method Detail
  - convertToJsonString
```
public String convertToJsonString(Map<String,Object> mapping,
                                  boolean xmlEscape)
```
    Convert the map to a serialized JSON string.
    
    Parameters:
    
    mapping - the mapping to convert. The mapping should only contain simple types (numbers, strings, booleans and arrays of these types) as values.
    
    xmlEscape - whether to StringEscapeHelper.escapeXml(String) before returning the result. When using the serialized JSON as content of an HTML attribute, this parameter should be true.
    
    Returns:
    
    the serialized JSON. If null is provided or the serialization fails an empty object literal ({}) is returned.
  - getActiveUserCount
```
public Long getActiveUserCount()
```
    Returns:
    
    The current active user count.
  - getAllUserPreferencesAsJson
```
public String getAllUserPreferencesAsJson()
```
    Returns:
    
    The preferences as JSON String.
  - getApplicationInformation
```
public ApplicationInformation getApplicationInformation()
```
    Returns:
    
    the application information.
  - getAuth
```
public CommunoteTool.AuthenticationTool getAuth()
```
    Returns:
    
    the AuthenticationTool
  - getBlogs
```
@Deprecated
public TopicTool getBlogs()
```
    Deprecated. Use getTopics() instead.
    
    Returns:
    
    the TopicTool
  - getClient
```
public ClientTool getClient()
```
    Returns:
    
    the ClientTool
  - getConfigurationProperty
```
public String getConfigurationProperty(ClientConfigurationPropertyConstant key)
```
    Get the value of a configuration property.
    
    Parameters:
    
    key - the key of the property
    
    Returns:
    
    the value or null if not defined. Be careful about null value handling in velocity. Default behavior is printing the call string when the value is null.
    
    See Also:
    
    ClientConfigurationProperties.getProperty(ClientConfigurationPropertyConstant)
  - getConfigurationProperty
```
public int getConfigurationProperty(ClientConfigurationPropertyConstant key,
                                    int fallback)
```
    Get the value of a configuration property. If the property is not defined the provided fallback will be returned.
    
    Parameters:
    
    key - the key of the property
    
    fallback - the fallback
    
    Returns:
    
    the value
    
    See Also:
    
    AbstractConfigurationProperties.getProperty(com.communote.server.api.core.config.ConfigurationPropertyConstant, int)
  - getConfigurationPropertyAsString
```
public String getConfigurationPropertyAsString(ClientConfigurationPropertyConstant key,
                                               String fallback)
```
    Get the value of a configuration property as String. If the property is not defined thes provided fallback will be returned.
    
    Parameters:
    
    key - the key of the property
    
    fallback - the fallback as String
    
    Returns:
    
    the value as String
    
    See Also:
    
    AbstractConfigurationProperties.getProperty(com.communote.server.api.core.config.ConfigurationPropertyConstant, String)
  - getCountries
```
public List<Country> getCountries(javax.servlet.http.HttpServletRequest request)
```
    Delegates to MasterDataManagement.getCountries(Locale)
    
    Parameters:
    
    request - the http servlet request
    
    Returns:
    
    the list of countries
  - getCurrentClientId
```
public String getCurrentClientId()
```
    Delegates to ClientHelper.getCurrentClientId()
    
    Returns:
    
    the current client alias
  - getCurrentClientName
```
public String getCurrentClientName()
```
    Delegates to ClientHelper.getCurrentClient()
    
    Returns:
    
    the name of the current client
  - getCurrentOffsetOfEffectiveUserTimeZone
```
public int getCurrentOffsetOfEffectiveUserTimeZone()
```
    Delegates to UserManagementHelper.getCurrentOffsetOfEffectiveUserTimeZone()
    
    Returns:
    
    the timezone offset
  - getCurrentUserAlias
```
public String getCurrentUserAlias()
```
    Delegates to SecurityHelper.getCurrentUserAlias()
    
    Returns:
    
    the current user alias
  - getCurrentUserEffectiveTimeZone
```
public TimeZone getCurrentUserEffectiveTimeZone()
```
    Returns:
    
    The current effective Timezone of the user.
  - getCurrentUserId
```
public Long getCurrentUserId()
```
    Delegates to SecurityHelper.getCurrentUserId()
    
    Returns:
    
    the current user ID
  - getCurrentUserLocale
```
public Locale getCurrentUserLocale(javax.servlet.http.HttpServletRequest request)
```
    Parameters:
    
    request - the current request
    
    Returns:
    
    The locale of the current user.
  - getCurrentUserProfile
```
public UserProfileVO getCurrentUserProfile()
```
    Returns:
    
    The currents user profile.
  - getCurrentUserSignature
```
public String getCurrentUserSignature(UserNameFormat format)
```
    To get the signature of the current user.
    
    Parameters:
    
    format - the format of the user signature
    
    Returns:
    
    the user signature
  - getDisplayNameForExternalObject
```
public String getDisplayNameForExternalObject(javax.servlet.http.HttpServletRequest request,
                                              String externalSystemId)
```
    Get the display name for an external object linked to an topic. If the system id is unknown, the system id or 'unknown' will be returned.
    
    Parameters:
    
    request - the repuest
    
    externalSystemId - the external system id of the external object
    
    Returns:
    
    the display name of the external object
  - getLanguages
```
public Collection<Language> getLanguages()
```
    Delegates to MasterDataManagement.getLanguages()
    
    Returns:
    
    the list of supported languages
  - getMessages
```
public MessageTool getMessages()
```
    Returns:
    
    the MessageTool
  - getTags
```
public TagTool getTags()
```
    Returns:
    
    the TagTool
  - getTimeZones
```
public List<SimplifiedTimeZone> getTimeZones()
```
    Delegates to MasterDataManagement.getTimeZones()
    
    Returns:
    
    the list of timezone ids
  - getTopics
```
public TopicTool getTopics()
```
    Returns:
    
    the BlogTool
  - getUsedLanguages
```
public Collection<Language> getUsedLanguages()
```
    Delegates to MasterDataManagement.getUsedLanguages()
    
    Returns:
    
    the list of supported languages
  - getUser
```
public UserData getUser(Number id)
```
    Get the details of a user. The tags and the properties of the user won't be included.
    
    Parameters:
    
    id - the ID of the user
    
    Returns:
    
    the user details or null
  - getUserPreferences
```
public UserPreference getUserPreferences(String className)
```
    Parameters:
    
    className - FQCN of the user preferences.
    
    Returns:
    
    The preferences.
  - getUserPreferencesAsJson
```
public String getUserPreferencesAsJson(String className)
```
    Parameters:
    
    className - FQCN of the user preferences.
    
    Returns:
    
    The preferences as JSON String.
  - getUserSignature
```
public String getUserSignature(User user,
                               UserNameFormat format)
```
    To get the signature of an author.
    
    Parameters:
    
    user - the user to use
    
    format - the format of the user signature
    
    Returns:
    
    the user signature
  - getUserSignature
```
public String getUserSignature(UserData userListItem,
                               UserNameFormat format)
```
    To get the signature of an author.
    
    Parameters:
    
    userListItem - the user list item to use
    
    format - the format of the user signature
    
    Returns:
    
    the user signature
  - getUserSignature
```
public String getUserSignature(UserProfileDetailListItem listItem,
                               UserNameFormat format)
```
    To get the signature of an author.
    
    Parameters:
    
    listItem - the user list item to use
    
    format - the format of the user signature
    
    Returns:
    
    the user signature
  - isCompressCss
```
public boolean isCompressCss()
```
    Returns:
    
    whether the minimized versions of the CSS files should be delivered
  - isCompressJavaScript
```
public boolean isCompressJavaScript()
```
    Returns:
    
    whether the minimized versions of the JavaScript files should be delivered
  - isCurrentUserClientManager
```
public boolean isCurrentUserClientManager()
```
    Returns:
    
    True, if the current user is a client manager.
  - isDevelopment
```
public boolean isDevelopment()
```
    Returns:
    
    True, if the application runs in development mode.
  - isForceSsl
```
public boolean isForceSsl(ChannelType type)
```
    Delegates to ChannelManagement.isForceSsl(ChannelType)
    
    Parameters:
    
    type - the channel type
    
    Returns:
    
    whether SSL is required for the requested channel
  - isPackCss
```
public boolean isPackCss()
```
    Returns:
    
    whether CSS files should be delivered as one aggregated file
  - isPackJavaScript
```
public boolean isPackJavaScript()
```
    Returns:
    
    whether JavaScript files should be delivered as one aggregated file
  - isStandalone
```
public boolean isStandalone()
```
    Returns:
    
    True, if this is the standalone version, else false.

Class CommunoteTool

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommunoteTool

Method Detail

convertToJsonString

getActiveUserCount

getAllUserPreferencesAsJson

getApplicationInformation

getAuth

getBlogs

getClient

getConfigurationProperty

getConfigurationProperty

getConfigurationPropertyAsString

getCountries

getCurrentClientId

getCurrentClientName

getCurrentOffsetOfEffectiveUserTimeZone

getCurrentUserAlias

getCurrentUserEffectiveTimeZone

getCurrentUserId

getCurrentUserLocale

getCurrentUserProfile

getCurrentUserSignature

getDisplayNameForExternalObject

getLanguages

getMessages

getTags

getTimeZones

getTopics

getUsedLanguages

getUser

getUserPreferences

getUserPreferencesAsJson

getUserSignature

getUserSignature

getUserSignature

isCompressCss

isCompressJavaScript

isCurrentUserClientManager

isDevelopment

isForceSsl

isPackCss

isPackJavaScript

isStandalone