GeneralUtil (Atlassian Confluence 6.6.0 API)

java.lang.Object
- com.atlassian.confluence.util.GeneralUtil

public final class GeneralUtil
extends Object

Constructor Summary

Constructors
Constructor and Description

GeneralUtil()

Constructors
Constructor and Description
`GeneralUtil()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`alwaysMaskEmail(String emailAddress)` Masks an email address by replacing '@' with 'at' and '.' with 'dot'.
`static String`	`appendAmpersandOrQuestionMark(String str)` Appends an ampersand if the given string already contains a question mark, or a question mark otherwise.
`static String`	`appendAmpsandOrQuestionMark(String str)` Deprecated. since 5.7. Call `appendAmpersandOrQuestionMark(String)` instead.
`static int`	`arraySize(int[] array)` convenience method to allow us to determine the size of an int array a velocity file
`static String`	`base64Decode(String s)`
`static String`	`base64Encode(String s)`
`static String`	`cleanQuietly(String stringToClean)` Sanitizes the input by removing unsafe elements or attributes.
`static String`	`completeUrlEncode(String url)` A utility method to encode the given url for protocols which the CompleteURLEncoder supports.
`static String`	`constrainLength(String s, int length)` Truncate a string after n characters
`static Map<String,String>`	`convertBeanToMap(Object bean)`
`static Date`	`convertMailFormatDate(String date)`
`static Boolean`	`convertToBoolean(Object obj)`
`static boolean`	`convertToBoolean(Object bool, boolean defaultValue)`
`static Character`	`convertToCharacter(Object obj)`
`static Integer`	`convertToInteger(Object obj)`
`static String`	`convertToString(Object obj)`
`static void`	`copyDate(Calendar original, Calendar copy)` Takes two calendar objects and sets the Date of the second to the Date of the first.
`static File`	`createTempDirectoryInConfluenceTemp(String prefix)`
`static File`	`createTempFile(String directory)`
`static String`	`customGetPageUrl(AbstractPage page)` Need a special case of generalutils getpageurl that appends ? or ampersand smartly this is used to prefix url parameters that are appended after this path like: showcomments=true#addcomment
`static String`	`displayShortUrl(String url)`
`static String`	`displayShortUrl(String url, int length)`
`static String`	`doubleUrlEncode(String s)`
`static void`	`elapse(String tag)` Add elapsed time to HttpRequestStats
`static String`	`escapeCDATA(String s)`
`static List<String>`	`escapeCommas(List<String> toEscape)` Escape commas on each entry in the given list of strings.
`static String`	`escapeCommas(String toEscape)` Escapes commas and backslashes with leading backslashes.
`static String`	`escapeForHtmlAttribute(String s)` Escapes " and \ with a leading \ so that strings can't break out of double-quoted HTML attributes.
`static String`	`escapeForJavascript(String s)` Escapes ', " and \ with a leading \.
`static String[]`	`escapeXml(Object[] args)` Produces an array of XML escaped `String`s from a list of Objects.
`static String`	`escapeXml(String stringToEscape)`
`static String`	`escapeXMLCharacters(String input)` Take a String which may contain <, > or & and return an XML string containing entities.
`static <T> List<T>`	`filterNulls(Collection<T> in)` Return a List with no null entries
`static String`	`findAndMaskEmail(String text, com.atlassian.user.User currentUser)`
`static void`	`flushResponse()` Flushes response writer.
`static String`	`format(Number number)` Deprecated. since 5.2. No replacement
`static String`	`format(Object obj)` Deprecated. since 5.2. Use `DateFormatter` or `Strings.nullToEmpty(String)` instead
`static String`	`format(String str)` Deprecated. since 5.2. Use `Strings.nullToEmpty(String)` instead
`static String`	`formatDateFull(Date date)` Deprecated. since 5.2. Use a `DateFormatter` instead
`static String`	`formatLongTime(long time)`
`static String`	`getAttachmentUrl(Attachment attachment)` Get the permalink URL to preview the given attachment in the previewer.
`static Date`	`getBuildDate()`
`static String`	`getBuildDateString()`
`static String`	`getBuildNumber()`
`static String`	`getCharacterEncoding()`
`static String`	`getCommentUrl(Attachment attachment, Comment comment)` Get the permalink URL to preview the given comment (annotation) in the previewer.
`static String`	`getCompactDuration(long time)` Returns the duration in a compact HH:mm:ss format.
`static File`	`getConfluenceTempDirectory()` Deprecated. since 5.5. Use `getLocalTempDirectory()` instead.
`static String`	`getConfluenceTempDirectoryPath()` Deprecated. since 5.5. Use `getLocalTempDirectory()` instead.
`static String`	`getCookieValue(javax.servlet.http.HttpServletRequest request, String key)`
`static String`	`getCookieValue(String key)`
`static ResourceBundle`	`getDefaultResourceBundle()`
`static String`	`getEditPageUrl(AbstractPage page)` Get a resume draft URL that includes the shareDraftid
`static String`	`getFormatDateSimple(Date date)`
`static Settings`	`getGlobalSettings()`
`static I18NBean`	`getI18n()`
`static String`	`getIdBasedPageUrl(AbstractPage page)` Get page URL that is id based (i.e.
`static com.atlassian.core.util.ImageInfo`	`getImageInfo(File pathToImage)`
`static File`	`getLocalTempDirectory()` Checks if local temp directory exists before returning the path.
`static String`	`getNiceDuration(int minutes, int seconds)`
`static String`	`getOriginalUrl(javax.servlet.http.HttpServletRequest request)`
`static String`	`getPageUrl(AbstractPage page)`
`static String`	`getPageUrl(VersionHistorySummary summary)`
`static Comment`	`getParentComment(Comment comment)` Returns the top-level comment that the comment is attached to
`static AbstractPage`	`getParentPageOrBlog(Contained content)` returns the page or blog that the content is attached to, or null if it is not attached to a page or blog.
`static long`	`getPercentage(long numerator, long denom)` converts a fraction into a percentage
`static long`	`getPercentage(String numeratorAsString, String denomAsString)`
`static <T> List<T>`	`getRandomSubSet(List<T> list, int sizeOfSubset, Random random)` Returns a randomised subset of the list provided.
`static String`	`getRelativeTime(Date date)` Deprecated. since 2.7 use `FriendlyDateFormatter`
`static String`	`getRequestCorrelationId()` Returns request correlation id
`static Duration`	`getServerRenderTime(javax.servlet.http.HttpServletRequest servletRequest)` Calculates the duration of the request
`static File`	`getSharedTempDirectory()` Checks if shared temp directory exists before returning the path.
`static String`	`getStackTrace(Throwable t)`
`static Long`	`getSystemStartupTime()`
`static Unzipper`	`getUnzipper(File zipFile, File dirToExtractTo)`
`static Unzipper`	`getUnzipper(URL zipUrl, File dirToExtractTo)`
`static String`	`getUploadFileTooLargeMessage(String errorMessage)` if this error message is of the type: "java.io.IOException: Content Length Error" convert it to something nicer
`static UserAccessor`	`getUserAccessor()`
`static String`	`getVersionNumber()`
`static String`	`hackSingleQuotes(String s)` hack to make strings that contain singles compatible with javascript (which also uses single quotes denote strings)
`static boolean`	`hasTooManyUsers()` Deprecated. since 5.10 Use `UserAccessor.isLicensedToAddMoreUsers()`
`static String`	`highlight(String content, String searchwords)`
`static String`	`htmlEncode(String text)` TODO introduce deprecation: deprecated since 5.3.2.
`static String`	`htmlEncodeAndReplaceSpaces(String text)` TODO introduce deprecation: deprecated since 5.3.2.
`static String`	`htmlEscapeQuotes(String input)` Take a string and escape the quotes in it with \" and HTML escape them afterwards.
`static boolean`	`isAllAscii(String s)`
`static boolean`	`isAllLettersOrNumbers(String s)`
`static boolean`	`isDateWithin24Hours(Date date)` Determines if given date is within 24 hours
`static boolean`	`isDefaultUserProfilePicture(String username)` Deprecated. since 2.7. Use `UserAccessor.getUserProfilePicture(com.atlassian.user.User)`.
`static boolean`	`isInLastDays(Date date, int maxDays)`
`static boolean`	`isLicenseExpired()`
`static boolean`	`isOutgoingMailConfigured()` Deprecated. since 5.0. Use `MailServerManager.isDefaultSMTPMailServerDefined()` instead.
`static boolean`	`isSafeTitleForFilesystem(String title)` Ensure the title is safe to be written to the file system.
`static boolean`	`isSafeTitleForUrl(String title)` Is "title" something we can safely put in a /foo/bar/title URL? Or should we reference this thing by ID just to be safe?
`static boolean`	`isSetupComplete()`
`static boolean`	`isSuperUser(com.atlassian.user.User user)` Deprecated. since 3.5 calls to the PermissionManager will ensure super-user checks are performed
`static void`	`loadDefaultProperties()` Deprecated. since 3.0 because it doesn't do anything
`static String`	`lookupDomainName(javax.servlet.http.HttpServletRequest request)` Get the default domain name.
`static String`	`makeFlatSummary(String content)` Create a summary of this content fragment.
`static String`	`makeFlatSummary(String content, String query)` Create a summary of this content fragment given a query
`static com.atlassian.bonnie.search.summary.Summary`	`makeSummary(String content)` Create a proper summary of this content fragment.
`static com.atlassian.bonnie.search.summary.Summary`	`makeSummary(String content, String query)` Create a proper summary of this content fragment given a query
`static String`	`maskEmail(String emailAddress)` If configured, masks an email address to defeat the most simplistic spam bots.
`static String`	`maskEmail(String emailAddress, Settings globalSettings, I18NBean i18NBean)`
`static ConfluenceActionSupport`	`newWiredConfluenceActionSupport()`
`static String`	`personalSpaceUrl(String contextPath, String username)` Deprecated. since 5.0 You should instead retrieve the space using `SpaceManager` and call getUrlPath on the Space object. Also note that if a user has been renamed (which is possible from Confluence 5.3 onwards) then this method is likely to return the wrong key.
`static String`	`plain2html(String text)`
`static String`	`populateSimpleMessage(String template, List<String> values)` Populate the template String supplied using the given values.
`static <K,V> Map<K,V>`	`prefixAllMapKeys(String prefix, Map<K,V> map)` Convert the supplied Map so that all of the keys in the Map are prefixed by the supplied String followed by a full stop.
`static void`	`profilePop(String s)`
`static void`	`profilePush(String s)`
`static String`	`rdfEncode(String s)` A fairly evil hack to work around CONF-10364.
`static String`	`refineOsDestination(String osDestination)` Escape XML and replace all space with %20
`static String`	`removeEmailsFromString(String text)` Remove all emails from text
`static String`	`replaceConfluenceConstants(String in, File home, File localHome)` Replaces `ConfluenceBootstrapConstants.CONFLUENCE_HOME_CONSTANT` and `ConfluenceBootstrapConstants.CONFLUENCE_LOCAL_HOME_CONSTANT` in the given text with the correct paths.
`static String`	`replaceConfluenceHomeConstant(String in, String confHome)` Deprecated. since 5.5. Use `replaceConfluenceConstants(String, java.io.File, java.io.File)` instead.
`static String`	`replaceInvalidXmlCharacters(String text)` Take a String which may contain characters outside of the XML character range (http://www.w3.org/TR/REC-xml/#charsets) and return a String with those characters converted to Unicode "Replacement Character"s (0xFFFD).
`static <T> List<T>`	`safeSubList(List<T> list, int max)`
`static javax.servlet.http.Cookie`	`setCookie(String key, String value)` Sets a cookie.
`static void`	`setSystemStartupTime(Long systemStartupTime)`
`static void`	`setUserAccessor(UserAccessor userAcc)`
`static String`	`shortenString(String str, int max)` Returns a substring of the specified string if it is longer than max.
`static boolean`	`shouldUrlDecode(String str)` TODO introduce deprecation: deprecated since 5.3.3.
`static Collection<String>`	`specialLowerCaseCollection(Collection<String> collection)` Takes a collection of Strings and lowercases the entries.
`static String`	`specialToLowerCase(String str)` the database lower() function in PostgreSQL only works for ASCII strings.
`static String[]`	`splitCommaDelimitedString(String escapedNames)` Method will turn a String of comma separated entities into a String Array.
`static boolean`	`stringSet(String str)` Deprecated. since 5.10 Use `StringUtils.isNotEmpty(CharSequence)`
`long`	`subtract(long a, long b)` Deprecated. since 5.0. Just use a minus sign.
`long`	`subtract(String firstOperandAsString, String secondOperandAsString)` Deprecated. since 5.0. Just say no.
`static String`	`summarise(String content)`
`static Date`	`toEndOfMonth(Calendar postDate, boolean isSqlServer)` Takes a Calendar object and returns the very end (last day, hour, minute, second and millisecond) of the month that the Calendar is in.
`static String`	`trimDownStringToWord(String s)`
`static String`	`unescapeCDATA(String s)`
`static String`	`unescapeEntities(String str)`
`static void`	`unzipFile(File zipFile, File dirToExtractTo)` Unzips the zip file to the destination directory
`static void`	`unzipUrl(URL zipUrl, File dirToExtractTo)` Unzips the zip url to the destination directory.
`static String`	`urlDecode(String url)` TODO introduce deprecation: deprecated since 5.3.3.
`static String`	`urlEncode(String url)` A utility method to encode HTTP form parameter/values.
`static String`	`urlEncode(String value, String encoding)` TODO introduce deprecation: deprecated since 5.3.3.
`static String`	`wordWrap(String str, int max)` For really long strings that have no spaces or line breaks, browsers such as firefox, Netscape, have difficulty wrapping them inside a table cell, and so these strings end up stretching the cell longer than its suppose to be = ugly

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

- Constructor Detail
  - GeneralUtil
```
public GeneralUtil()
```
- Method Detail
  - loadDefaultProperties
```
@Deprecated
public static void loadDefaultProperties()
```
    Deprecated. since 3.0 because it doesn't do anything
    
    See Also:
    
    BuildInformation
  - getStackTrace
```
public static String getStackTrace(Throwable t)
```
  - format
```
@Deprecated
public static String format(Number number)
```
    Deprecated. since 5.2. No replacement
    
    TODO: Replace with a NumberFormatter, similar to DateFormatter
    
    Parameters:
    
    number - the number object to reformat
    
    Returns:
    
    the number formatted a String, or null if an exception occurred.
  - format
```
@Deprecated
public static String format(String str)
```
    Deprecated. since 5.2. Use Strings.nullToEmpty(String) instead
  - format
```
@Deprecated
public static String format(Object obj)
```
    Deprecated. since 5.2. Use DateFormatter or Strings.nullToEmpty(String) instead
  - convertMailFormatDate
```
public static Date convertMailFormatDate(String date)
                                  throws ParseException
```
    Throws:
    
    ParseException
  - convertToCharacter
```
public static Character convertToCharacter(Object obj)
```
  - convertToInteger
```
public static Integer convertToInteger(Object obj)
```
  - convertToBoolean
```
@Nullable
public static Boolean convertToBoolean(Object obj)
```
  - convertToBoolean
```
public static boolean convertToBoolean(Object bool,
                                       boolean defaultValue)
```
  - convertToString
```
public static String convertToString(Object obj)
```
  - getOriginalUrl
```
public static String getOriginalUrl(javax.servlet.http.HttpServletRequest request)
```
  - completeUrlEncode
```
public static String completeUrlEncode(String url)
```
    A utility method to encode the given url for protocols which the CompleteURLEncoder supports. To only encode HTTP form parameter/values or fragments, use urlEncode() instead. TODO introduce deprecation: deprecated since 5.3.3. Use HtmlUtil.completeUrlEncode(String) instead.
    
    Parameters:
    
    url - - the entire URL to encode
    
    Returns:
    
    encoded url
  - urlEncode
```
public static String urlEncode(String url)
```
    A utility method to encode HTTP form parameter/values. To encode entire URLs, use completeUrlEncode() instead. TODO introduce deprecation: deprecated since 5.3.3. Use HtmlUtil.urlEncode(String) instead.
    
    Parameters:
    
    url - - part of the url to encode
    
    Returns:
    
    encoded url
  - urlEncode
```
public static String urlEncode(String value,
                               String encoding)
```
    TODO introduce deprecation: deprecated since 5.3.3. Use HtmlUtil.urlEncode(String, String) instead.
  - urlDecode
```
public static String urlDecode(String url)
```
    TODO introduce deprecation: deprecated since 5.3.3. Use HtmlUtil.urlDecode(String) instead.
  - shouldUrlDecode
```
public static boolean shouldUrlDecode(String str)
```
    TODO introduce deprecation: deprecated since 5.3.3. Use HtmlUtil.shouldUrlDecode(String) instead.
  - getPageUrl
```
public static String getPageUrl(VersionHistorySummary summary)
```
  - getPageUrl
```
public static String getPageUrl(AbstractPage page)
```
  - getIdBasedPageUrl
```
public static String getIdBasedPageUrl(AbstractPage page)
```
    Get page URL that is id based (i.e. in the format /pages/viewpage.action?pageId=<pageId>)
    
    Parameters:
    
    page - the page to generate a url for
    
    Returns:
    
    page URL that is id based
  - getEditPageUrl
```
public static String getEditPageUrl(AbstractPage page)
```
    Get a resume draft URL that includes the shareDraftid
    
    Parameters:
    
    page - the page to generate an edit url for
    
    Returns:
    
    The edit URL for that page
    
    Since:
    
    6.1
  - getAttachmentUrl
```
public static String getAttachmentUrl(Attachment attachment)
```
    Get the permalink URL to preview the given attachment in the previewer.
    
    Parameters:
    
    attachment - the attachment to generate an URL for.
    
    Returns:
    
    permalink URL for the attachment.
  - getCommentUrl
```
public static String getCommentUrl(Attachment attachment,
                                   Comment comment)
```
    Get the permalink URL to preview the given comment (annotation) in the previewer.
    
    Parameters:
    
    attachment - the attachment that the annotation is on.
    
    comment - the annotation to generate the url for.
    
    Returns:
    
    permalink URL for the annotation.
  - getParentPageOrBlog
```
public static AbstractPage getParentPageOrBlog(Contained content)
```
    returns the page or blog that the content is attached to, or null if it is not attached to a page or blog.
    
    Parameters:
    
    content - content to check for containing page or blog.
    
    Returns:
    
    container page or blog.
  - getParentComment
```
public static Comment getParentComment(Comment comment)
```
    Returns the top-level comment that the comment is attached to
    
    Parameters:
    
    comment - comment to check for parent comment
    
    Returns:
    
    top-level parent comment
  - isSafeTitleForUrl
```
public static boolean isSafeTitleForUrl(String title)
```
    Is "title" something we can safely put in a /foo/bar/title URL? Or should we reference this thing by ID just to be safe?
    
    Parameters:
    
    title - The title to check
    
    Returns:
    
    True of the title can be put in a URL, false otherwise
  - isSafeTitleForFilesystem
```
public static boolean isSafeTitleForFilesystem(String title)
```
    Ensure the title is safe to be written to the file system. See CONF-10741.
    
    Parameters:
    
    title - The title to check
    
    Returns:
    
    True if the title is safe for the filesystem, false otherwise
  - customGetPageUrl
```
public static String customGetPageUrl(AbstractPage page)
```
    Need a special case of generalutils getpageurl that appends ? or ampersand smartly this is used to prefix url parameters that are appended after this path like: showcomments=true#addcomment
    
    Parameters:
    
    page - The page to get the URL of
    
    Returns:
    
    The URL of the page with a trailing ? or &
  - appendAmpsandOrQuestionMark
```
@Deprecated
public static String appendAmpsandOrQuestionMark(String str)
```
    Deprecated. since 5.7. Call appendAmpersandOrQuestionMark(String) instead.
    
    Appends an ampersand if the given string already contains a question mark, or a question mark otherwise.
    
    Parameters:
    
    str - the string to prepare for adding a query param to.
    
    Returns:
    
    the given string with a question mark
  - appendAmpersandOrQuestionMark
```
public static String appendAmpersandOrQuestionMark(String str)
```
    Appends an ampersand if the given string already contains a question mark, or a question mark otherwise.
    
    Parameters:
    
    str - the string to prepare for adding a query param to.
    
    Returns:
    
    the given string with a question mark
    
    Since:
    
    5.7
  - wordWrap
```
public static String wordWrap(String str,
                              int max)
```
    For really long strings that have no spaces or line breaks, browsers such as firefox, Netscape, have difficulty wrapping them inside a table cell, and so these strings end up stretching the cell longer than its suppose to be = ugly
    we want to simulate IE's word-wrap/break function here
    
    Parameters:
    
    str - the string to wrap
    
    max - max length of string allowed per line
    
    Returns:
    
    The wrapped string
  - highlight
```
public static String highlight(String content,
                               String searchwords)
```
  - doubleUrlEncode
```
public static String doubleUrlEncode(String s)
```
  - isAllAscii
```
public static boolean isAllAscii(String s)
```
  - isAllLettersOrNumbers
```
public static boolean isAllLettersOrNumbers(String s)
```
  - getVersionNumber
```
public static String getVersionNumber()
```
  - getBuildDate
```
public static Date getBuildDate()
```
  - getBuildDateString
```
public static String getBuildDateString()
```
  - getBuildNumber
```
public static String getBuildNumber()
```
    Returns:
    
    The build number of the currently running Confluence instance.
    
    See Also:
    
    BuildInformation.getBuildNumber()
  - getSystemStartupTime
```
public static Long getSystemStartupTime()
```
  - setSystemStartupTime
```
public static void setSystemStartupTime(Long systemStartupTime)
```
  - isLicenseExpired
```
public static boolean isLicenseExpired()
```
  - hasTooManyUsers
```
@Deprecated
public static boolean hasTooManyUsers()
```
    Deprecated. since 5.10 Use UserAccessor.isLicensedToAddMoreUsers()
    
    Check if the current installation has more active users than is allowed by the license
    
    Returns:
    
    true if the number exceeds the license, false otherwise.
  - stringSet
```
@Deprecated
public static boolean stringSet(String str)
```
    Deprecated. since 5.10 Use StringUtils.isNotEmpty(CharSequence)
  - formatLongTime
```
public static String formatLongTime(long time)
```
  - displayShortUrl
```
public static String displayShortUrl(String url)
```
  - displayShortUrl
```
public static String displayShortUrl(String url,
                                     int length)
```
  - formatDateFull
```
@Deprecated
public static String formatDateFull(Date date)
```
    Deprecated. since 5.2. Use a DateFormatter instead
    
    Always renders a date using english locale. This is not what most users would want!
  - toEndOfMonth
```
public static Date toEndOfMonth(Calendar postDate,
                                boolean isSqlServer)
```
    Takes a Calendar object and returns the very end (last day, hour, minute, second and millisecond) of the month that the Calendar is in. The original Calendar object is left unaltered.
    
    Parameters:
    
    postDate - A calendar object
    
    Returns:
    
    Date object signifying the very end of the Calendar's month
  - copyDate
```
public static void copyDate(Calendar original,
                            Calendar copy)
```
    Takes two calendar objects and sets the Date of the second to the Date of the first. Used to keep dates consistent regardless of timezones.
    
    Parameters:
    
    original - The source calendar object
    
    copy - The destination calendar object
  - isSuperUser
```
@Deprecated
public static boolean isSuperUser(com.atlassian.user.User user)
```
    Deprecated. since 3.5 calls to the PermissionManager will ensure super-user checks are performed
    
    Parameters:
    
    user - the user to check for (the null user will always return false
    
    Returns:
    
    true if the user is a super-user, false otherwise.
    
    See Also:
    
    PermissionManager.hasPermission(com.atlassian.user.User, com.atlassian.confluence.security.Permission, java.lang.Object)
  - getCharacterEncoding
```
public static String getCharacterEncoding()
```
  - escapeXml
```
public static String escapeXml(String stringToEscape)
```
  - cleanQuietly
```
public static String cleanQuietly(String stringToClean)
```
    Sanitizes the input by removing unsafe elements or attributes. It will keep the safe tags. For example, the input below,
```
 <div><script>alert(1);</script></div>
```
    will generate the following output,
```
 <div></div>
```
    Parameters:
    
    stringToClean - - the string might contain unsafe contents.
    
    Returns:
    
    the string where the unsafe contents have been removed.
  - escapeXml
```
public static String[] escapeXml(Object[] args)
```
    Produces an array of XML escaped Strings from a list of Objects. String.valueOf(Object) is used to produce Strings from the Objects
    
    Parameters:
    
    args - an array of objects
    
    Returns:
    
    an array of XML escaped Strings
  - escapeForJavascript
```
public static String escapeForJavascript(String s)
```
    Escapes ', " and \ with a leading \.
    
    Parameters:
    
    s - the string to escape
    
    Returns:
    
    the escaped string
  - escapeForHtmlAttribute
```
public static String escapeForHtmlAttribute(String s)
```
    Escapes " and \ with a leading \ so that strings can't break out of double-quoted HTML attributes.
    
    Parameters:
    
    s - the string to escape
    
    Returns:
    
    the escaped string
  - isSetupComplete
```
public static boolean isSetupComplete()
```
  - maskEmail
```
public static String maskEmail(String emailAddress)
```
    If configured, masks an email address to defeat the most simplistic spam bots. If Confluence is not configured to mask email addresses, just returns the original address.
    Passing in null to this method will just get you null back
    
    Parameters:
    
    emailAddress - the email address to mask
    
    Returns:
    
    the masked email address, or the original address if masking is not configured
  - maskEmail
```
public static String maskEmail(String emailAddress,
                               Settings globalSettings,
                               I18NBean i18NBean)
```
  - alwaysMaskEmail
```
public static String alwaysMaskEmail(String emailAddress)
```
    Masks an email address by replacing '@' with 'at' and '.' with 'dot'.
    
    Parameters:
    
    emailAddress - an email address to mask, eg dwillis@atlassian.com
    
    Returns:
    
    a masked version of the email, eg dwillis at atlassian dot com
  - findAndMaskEmail
```
public static String findAndMaskEmail(String text,
                                      com.atlassian.user.User currentUser)
```
  - escapeCDATA
```
public static String escapeCDATA(String s)
```
  - unescapeCDATA
```
public static String unescapeCDATA(String s)
```
  - createTempDirectoryInConfluenceTemp
```
public static File createTempDirectoryInConfluenceTemp(String prefix)
```
  - createTempFile
```
public static File createTempFile(String directory)
```
  - unescapeEntities
```
public static String unescapeEntities(String str)
```
  - base64Decode
```
public static String base64Decode(String s)
```
  - base64Encode
```
public static String base64Encode(String s)
```
  - hackSingleQuotes
```
public static String hackSingleQuotes(String s)
```
    hack to make strings that contain singles compatible with javascript (which also uses single quotes denote strings)
    
    Parameters:
    
    s - the input string
    
    Returns:
    
    the string with ' replaced with ' + '\\'' + '
  - isInLastDays
```
public static boolean isInLastDays(Date date,
                                   int maxDays)
```
    Parameters:
    
    date - the date to check
    
    maxDays - the number of days into the past the date can fall
    
    Returns:
    
    Whether whether the date falls within maxDays before the present.
  - getRelativeTime
```
public static String getRelativeTime(Date date)
```
    Deprecated. since 2.7 use FriendlyDateFormatter
    
    Parameters:
    
    date - the date to convert to a relative time string
    
    Returns:
    
    A relative time period, 'X hours, Y minutes ago'
  - getFormatDateSimple
```
public static String getFormatDateSimple(Date date)
```
  - setCookie
```
public static javax.servlet.http.Cookie setCookie(String key,
                                                  String value)
```
    Sets a cookie. set to use a default cookie age of one year and the context path as the default path
    
    Parameters:
    
    key - the key of the cookie
    
    value - the value of the cookie
    
    Returns:
    
    the new Cookie object
  - getCookieValue
```
public static String getCookieValue(javax.servlet.http.HttpServletRequest request,
                                    String key)
```
  - getCookieValue
```
public static String getCookieValue(String key)
```
  - htmlEncode
```
public static String htmlEncode(String text)
```
    TODO introduce deprecation: deprecated since 5.3.2. Use HtmlUtil.htmlEncode(String) instead)
  - htmlEncodeAndReplaceSpaces
```
public static String htmlEncodeAndReplaceSpaces(String text)
```
    TODO introduce deprecation: deprecated since 5.3.2. Use HtmlUtil.htmlEncodeAndReplaceSpaces(String) instead)
  - plain2html
```
public static String plain2html(String text)
```
    Parameters:
    
    text - the text to encode
    
    Returns:
    
    the html encoded text
    
    See Also:
    
    PlainTextToHtmlConverter
  - unzipFile
```
public static void unzipFile(File zipFile,
                             File dirToExtractTo)
                      throws IOException
```
    Unzips the zip file to the destination directory
    
    Parameters:
    
    zipFile - the zip file to extract
    
    dirToExtractTo - the directory to extract the zip file to
    
    Throws:
    
    IOException - if an IOException occurs
  - getUnzipper
```
public static Unzipper getUnzipper(File zipFile,
                                   File dirToExtractTo)
                            throws IOException
```
    Throws:
    
    IOException
  - unzipUrl
```
public static void unzipUrl(URL zipUrl,
                            File dirToExtractTo)
                     throws IOException
```
    Unzips the zip url to the destination directory.
    
    Parameters:
    
    zipUrl - the URL of the zip file to extract
    
    dirToExtractTo - the directory to extract the zip file to
    
    Throws:
    
    IOException - if an IOException occurs
  - getUnzipper
```
public static Unzipper getUnzipper(URL zipUrl,
                                   File dirToExtractTo)
```
  - getUploadFileTooLargeMessage
```
public static String getUploadFileTooLargeMessage(String errorMessage)
```
    if this error message is of the type: "java.io.IOException: Content Length Error" convert it to something nicer
    
    Parameters:
    
    errorMessage - the error message to convert
    
    Returns:
    
    the nicer error message if it can be converted, else the input string
  - getDefaultResourceBundle
```
public static ResourceBundle getDefaultResourceBundle()
```
  - getI18n
```
public static I18NBean getI18n()
```
    Returns:
    
    The I18NBean for the current user
  - arraySize
```
public static int arraySize(int[] array)
```
    convenience method to allow us to determine the size of an int array a velocity file
    
    Parameters:
    
    array - the array to find the length of
    
    Returns:
    
    the length of the array
  - escapeXMLCharacters
```
@Nullable
public static String escapeXMLCharacters(@Nullable
                                                   String input)
```
    Take a String which may contain <, > or & and return an XML string containing entities.
    
    Parameters:
    
    input - a string to escape for XML
    
    Returns:
    
    the string with XML entities escaped
  - replaceInvalidXmlCharacters
```
public static String replaceInvalidXmlCharacters(String text)
```
    Take a String which may contain characters outside of the XML character range (http://www.w3.org/TR/REC-xml/#charsets) and return a String with those characters converted to Unicode "Replacement Character"s (0xFFFD).
    Note that this method does not "escape" the string (e.g. "&" is not converted to "&").
    Similar to Verifier.checkCharacterData(String) but converts illegals instead of throwing Exceptions.
    
    Parameters:
    
    text - the input string
    
    Returns:
    
    the input string with those characters converted to Unicode "Replacement Character"s
  - htmlEscapeQuotes
```
public static String htmlEscapeQuotes(String input)
```
    Take a string and escape the quotes in it with \" and HTML escape them afterwards. We need this function to escape strings containing quotes passed into JavaScript functions
    null input will be returned as an empty String.
    
    Parameters:
    
    input - string to escape
    
    Returns:
    
    the escaped string
  - filterNulls
```
public static <T> List<T> filterNulls(Collection<T> in)
```
    Return a List with no null entries
    
    Parameters:
    
    in - a collection to filter nulls
    
    Returns:
    
    a list that is a copy of the collection with nulls removed
  - shortenString
```
public static String shortenString(String str,
                                   int max)
```
    Returns a substring of the specified string if it is longer than max. This method also appends ELLIPSIS to the end of the string if it does truncate it.
    
    Parameters:
    
    str - the string to shorten
    
    max - the maximum desired length of the result (excluding ELLIPSIS)
    
    Returns:
    
    a substring of the specified string if it is longer than max.
    
    See Also:
    
    StringUtils.abbreviate(String, int)
  - specialToLowerCase
```
public static String specialToLowerCase(String str)
```
    the database lower() function in PostgreSQL only works for ASCII strings. All other unicode and multibyte characters like capital umlaut are not properly converted. At the moment, when searching for pages we do the following comparison:
    
    lower(page.title) = :pageTitle (Where :pageTitle is normally .toLowerCase() first before being passed in)
    
    This special lower case function will skip the JAVA .toLowerCase() for postgres whose database lower() is ineffective.
    
    Parameters:
    
    str - the string to convert to lower case
    
    Returns:
    
    the lower cased string
  - replaceConfluenceHomeConstant
```
@Deprecated
public static String replaceConfluenceHomeConstant(String in,
                                                               String confHome)
```
    Deprecated. since 5.5. Use replaceConfluenceConstants(String, java.io.File, java.io.File) instead.
  - replaceConfluenceConstants
```
public static String replaceConfluenceConstants(String in,
                                                File home,
                                                File localHome)
```
    Replaces ConfluenceBootstrapConstants.CONFLUENCE_HOME_CONSTANT and ConfluenceBootstrapConstants.CONFLUENCE_LOCAL_HOME_CONSTANT in the given text with the correct paths.
    
    Parameters:
    
    in - text to make the replacements to
    
    home - Confluence home directory
    
    localHome - Confluence local home directory
    
    Returns:
    
    text with replacements
    
    Since:
    
    5.5
  - specialLowerCaseCollection
```
public static Collection<String> specialLowerCaseCollection(Collection<String> collection)
```
    Takes a collection of Strings and lowercases the entries.
    
    Parameters:
    
    collection - the collection
    
    Returns:
    
    lowercased collection of strings
  - safeSubList
```
public static <T> List<T> safeSubList(List<T> list,
                                      int max)
```
  - summarise
```
public static String summarise(String content)
```
    Parameters:
    
    content - the content to summarise
    
    Returns:
    
    the summarised content
  - makeSummary
```
public static com.atlassian.bonnie.search.summary.Summary makeSummary(String content)
```
    Create a proper summary of this content fragment.
    
    Parameters:
    
    content - the string to summarise
    
    Returns:
    
    the summary object for the string
    
    See Also:
    
    Summarizer
  - makeSummary
```
public static com.atlassian.bonnie.search.summary.Summary makeSummary(String content,
                                                                      @Nullable
                                                                      String query)
```
    Create a proper summary of this content fragment given a query
    
    Parameters:
    
    content - the string to summarise
    
    query - the lucene query
    
    Returns:
    
    the summary object for the content and query
    
    See Also:
    
    Summarizer
  - makeFlatSummary
```
public static String makeFlatSummary(String content)
```
    Create a summary of this content fragment.
    
    Parameters:
    
    content - the content to summarise
    
    Returns:
    
    the summary as a string
    
    See Also:
    
    Summarizer
  - makeFlatSummary
```
public static String makeFlatSummary(String content,
                                     @Nullable
                                     String query)
```
    Create a summary of this content fragment given a query
    
    Parameters:
    
    content - the content string
    
    query - the lucene query string
    
    Returns:
    
    the summarised content and query
    
    See Also:
    
    Summarizer
  - getUserAccessor
```
public static UserAccessor getUserAccessor()
```
  - setUserAccessor
```
public static void setUserAccessor(UserAccessor userAcc)
```
  - getImageInfo
```
public static com.atlassian.core.util.ImageInfo getImageInfo(File pathToImage)
```
  - getNiceDuration
```
public static String getNiceDuration(int minutes,
                                     int seconds)
```
  - getCompactDuration
```
public static String getCompactDuration(long time)
```
    Returns the duration in a compact HH:mm:ss format.
    
    Parameters:
    
    time - duration in milliseconds
    
    Returns:
    
    the duration in a compact HH:mm:ss format.
  - newWiredConfluenceActionSupport
```
public static ConfluenceActionSupport newWiredConfluenceActionSupport()
```
  - profilePush
```
public static void profilePush(String s)
```
  - profilePop
```
public static void profilePop(String s)
```
  - lookupDomainName
```
public static String lookupDomainName(javax.servlet.http.HttpServletRequest request)
```
    Get the default domain name.
    
    Parameters:
    
    request - the request
    
    Returns:
    
    null if request is null, otherwise a base URL derived from the request.
  - getGlobalSettings
```
public static Settings getGlobalSettings()
```
  - personalSpaceUrl
```
@Deprecated
public static String personalSpaceUrl(String contextPath,
                                                  String username)
```
    Deprecated. since 5.0 You should instead retrieve the space using SpaceManager and call getUrlPath on the Space object. Also note that if a user has been renamed (which is possible from Confluence 5.3 onwards) then this method is likely to return the wrong key.
  - getPercentage
```
public static long getPercentage(long numerator,
                                 long denom)
```
    converts a fraction into a percentage
    
    Parameters:
    
    numerator - the number to include in the percentage
    
    denom - the total number
    
    Returns:
    
    the percentage as a long integer, rounded
  - subtract
```
@Deprecated
public long subtract(long a,
                                 long b)
```
    Deprecated. since 5.0. Just use a minus sign.
  - getPercentage
```
public static long getPercentage(String numeratorAsString,
                                 String denomAsString)
```
  - subtract
```
@Deprecated
public long subtract(String firstOperandAsString,
                                 String secondOperandAsString)
```
    Deprecated. since 5.0. Just say no.
  - getConfluenceTempDirectoryPath
```
@Deprecated
public static String getConfluenceTempDirectoryPath()
```
    Deprecated. since 5.5. Use getLocalTempDirectory() instead.
  - getConfluenceTempDirectory
```
@Deprecated
public static File getConfluenceTempDirectory()
```
    Deprecated. since 5.5. Use getLocalTempDirectory() instead.
  - getLocalTempDirectory
```
public static File getLocalTempDirectory()
```
    Checks if local temp directory exists before returning the path. Create it if it doesn't already exist.
    
    Returns:
    
    path to temp directory inside local home
    
    Since:
    
    5.5
  - getSharedTempDirectory
```
public static File getSharedTempDirectory()
```
    Checks if shared temp directory exists before returning the path. Create it if it doesn't already exist.
    
    Returns:
    
    path to temp directory inside shared home
    
    Since:
    
    5.5
  - splitCommaDelimitedString
```
public static String[] splitCommaDelimitedString(String escapedNames)
```
    Method will turn a String of comma separated entities into a String Array. Spaces before or after the comma will be cropped. Backslashes are treated as escaped characters. Eg when "backslash""comma" is encountered, the backslash is discarded and the comma is not treated as a delimiter.
    
    Parameters:
    
    escapedNames - Comma delimited string with original commas and backslashes escaped by backslashes
    
    Returns:
    
    String[] of escapedNames
  - escapeCommas
```
public static List<String> escapeCommas(List<String> toEscape)
```
    Escape commas on each entry in the given list of strings.
    
    Parameters:
    
    toEscape - Strings to escape
    
    Returns:
    
    escaped Strings
  - escapeCommas
```
public static String escapeCommas(String toEscape)
```
    Escapes commas and backslashes with leading backslashes.
    
    Parameters:
    
    toEscape - string to escape. If null, then null will be returned.
    
    Returns:
    
    the escaped string
  - constrainLength
```
public static String constrainLength(String s,
                                     int length)
```
    Truncate a string after n characters
    
    Parameters:
    
    s - The String to truncate
    
    length - The maximum length allowed.
    
    Returns:
    
    The truncated String -- or the original String if no truncation was needed.
  - isOutgoingMailConfigured
```
@Deprecated
public static boolean isOutgoingMailConfigured()
```
    Deprecated. since 5.0. Use MailServerManager.isDefaultSMTPMailServerDefined() instead.
  - convertBeanToMap
```
public static Map<String,String> convertBeanToMap(Object bean)
```
    Parameters:
    
    bean - a bean to be converted to a Map.
    
    Returns:
    
    a Map where the keys are the property names from the beans, and the values are the property values. An empty Map will be returned if the bean cannot be converted.
  - prefixAllMapKeys
```
public static <K,V> Map<K,V> prefixAllMapKeys(String prefix,
                                              Map<K,V> map)
```
    Convert the supplied Map so that all of the keys in the Map are prefixed by the supplied String followed by a full stop. e.g. monkey could become howler.monkey.
    If any of the keys in the Map are not Strings then they will be ignored.
    
    Parameters:
    
    prefix - the prefix to be pre-pended to each Map key, if null then the original Map will be returned.
    
    map - the Map to be modified. If null, then an empty Map will be returned.
    
    Returns:
    
    a new Map containing the modified keys and the supplied values.
  - isDefaultUserProfilePicture
```
@Deprecated
public static boolean isDefaultUserProfilePicture(String username)
```
    Deprecated. since 2.7. Use UserAccessor.getUserProfilePicture(com.atlassian.user.User).
    
    Parameters:
    
    username - the username to check
    
    Returns:
    
    true of they are using the default profile picture, false otherwise
  - rdfEncode
```
public static String rdfEncode(String s)
```
    A fairly evil hack to work around CONF-10364. It sucks, but is necessary.
    
    Parameters:
    
    s - to encode
    
    Returns:
    
    the input String with double hyphens replaced by --
  - populateSimpleMessage
```
public static String populateSimpleMessage(String template,
                                           List<String> values)
```
    Populate the template String supplied using the given values. The template may contain place holders which are denoted numerically in the form {n} where n is an index into the supplied values list.
    
    e.g. "The template called {1} will expects a colour here {0}".
    
    This template will use value 0 and value 1 from the supplied values array. If the referenced value cannot be found then the place holder will simply be removed.
    
    Parameters:
    
    template - the template to be populated
    
    values - the values used to populate the template
    
    Returns:
    
    a populated template with all place holder markers removed.
  - getRandomSubSet
```
public static <T> List<T> getRandomSubSet(List<T> list,
                                          int sizeOfSubset,
                                          Random random)
```
    Returns a randomised subset of the list provided. If the size of the subset is larger than the list, the entire list is returned in a random order.
    
    Parameters:
    
    list - - the list to subset
    
    sizeOfSubset - - the size of the subset to return
    
    random - - the source of randomness
    
    Returns:
    
    a randomised subset of the list
  - trimDownStringToWord
```
public static String trimDownStringToWord(String s)
```
  - isDateWithin24Hours
```
public static boolean isDateWithin24Hours(Date date)
```
    Determines if given date is within 24 hours
    
    Parameters:
    
    date -
    
    Returns:
  - refineOsDestination
```
public static String refineOsDestination(String osDestination)
```
    Escape XML and replace all space with %20
    
    Parameters:
    
    osDestination -
    
    Returns:
  - removeEmailsFromString
```
public static String removeEmailsFromString(String text)
```
    Remove all emails from text
    
    Parameters:
    
    text -
    
    Returns:
  - getServerRenderTime
```
public static Duration getServerRenderTime(javax.servlet.http.HttpServletRequest servletRequest)
```
    Calculates the duration of the request
    
    Since:
    
    5.9.0
  - getRequestCorrelationId
```
public static String getRequestCorrelationId()
```
    Returns request correlation id
    
    Since:
    
    5.9.0
  - flushResponse
```
public static void flushResponse()
```
    Flushes response writer. Logs error if exception occurs.
    
    Since:
    
    5.9.1
  - elapse
```
public static void elapse(String tag)
```
    Add elapsed time to HttpRequestStats
    
    Since:
    
    5.9.1
    
    See Also:
    
    HttpRequestStats

Class GeneralUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GeneralUtil

Method Detail

loadDefaultProperties

getStackTrace

format

format

format

convertMailFormatDate

convertToCharacter

convertToInteger

convertToBoolean

convertToBoolean

convertToString

getOriginalUrl

completeUrlEncode

urlEncode

urlEncode

urlDecode

shouldUrlDecode

getPageUrl

getPageUrl

getIdBasedPageUrl

getEditPageUrl

getAttachmentUrl

getCommentUrl

getParentPageOrBlog

getParentComment

isSafeTitleForUrl

isSafeTitleForFilesystem

customGetPageUrl

appendAmpsandOrQuestionMark

appendAmpersandOrQuestionMark

wordWrap

highlight

doubleUrlEncode

isAllAscii

isAllLettersOrNumbers

getVersionNumber

getBuildDate

getBuildDateString

getBuildNumber

getSystemStartupTime

setSystemStartupTime

isLicenseExpired

hasTooManyUsers

stringSet

formatLongTime

displayShortUrl

displayShortUrl

formatDateFull

toEndOfMonth

copyDate

isSuperUser

getCharacterEncoding

escapeXml

cleanQuietly

escapeXml

escapeForJavascript

escapeForHtmlAttribute

isSetupComplete

maskEmail

maskEmail

alwaysMaskEmail

findAndMaskEmail

escapeCDATA

unescapeCDATA

createTempDirectoryInConfluenceTemp

createTempFile

unescapeEntities

base64Decode

base64Encode

hackSingleQuotes

isInLastDays

getRelativeTime

getFormatDateSimple