CommonUtils (eXo PLF:: Forum Applications commons 6.1.1-CP10 API)

java.lang.Object
- org.exoplatform.forum.common.CommonUtils

```
public class CommonUtils
extends Object
```
Version:

$Revision$

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AMP`
`static String`	`AMP_HEX`
`static String`	`AMP_NUMBER`
`static String`	`AMP_SPACE`
`static String`	`ASTERISK_STR`
`static String`	`COLON`
`static String`	`COMMA`
`static String`	`EMPTY_STR`
`static String`	`FROM_KEY`
`static String`	`GREATER_THAN`
`static String`	`LESS_THAN`
`static String`	`PERCENT_STR`
`static String`	`QUOT`
`static String`	`SEMICOLON`
`static String`	`SLASH`
`static String`	`SPACE`

Constructor Summary

Constructors
Constructor and Description

CommonUtils()

Constructors
Constructor and Description
`CommonUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`centerTrunc(String str, int middlePosition, int maxLength)` Truncates large Strings showing the string around the specific middle position with the specific length.
`static String`	`convertCodeHTML(String s)`
`static org.exoplatform.services.jcr.ext.common.SessionProvider`	`createSystemProvider()`
`static String`	`generateCheckSum(byte[] b)` Generates checksum for files, and get a file ending in .sha1 This task can also be used to perform checksum verifications.
`static <T> T`	`getComponent(Class<T> type)`
`static String`	`getExcerpt(String str, String textQuery, int maxLength)` Get excerpt of given string with start position is the first position of textQuery.
`static org.exoplatform.container.ExoContainer`	`getExoContainer(org.quartz.JobExecutionContext context)`
`static Calendar`	`getGreenwichMeanTime()` Get current time GMT/Zulu or UTC,(zone time is 0+GMT)
`static String`	`getImageUrl(String imagePath)`
`static String`	`getRSSLink(String appType, String portalName, String objectId)`
`static String`	`getURI(String url)` Get the URI of full URL
`static String`	`getUserRSSLink(String apptype, String userId)`
`static File`	`getXMLFile(ByteArrayOutputStream bos, String appName, String objectType, Date createDate, String fileName)`
`static boolean`	`hasSpecialCharacter(String input)` To check the input content has special characters or not.
`static boolean`	`isEmpty(String s)` Check string is null or empty
`static boolean`	`isEmpty(String[] array)` check string array is whether empty or not
`static String`	`makeNotificationSender(String from)` This function will change email address in 'from' field by address of mail service which is configured as system property : `gatein.email.smtp.from` or `mail.from`.
`static String`	`normalizeUnifiedSearchInput(String input)` Normalize Unified search input
`static String`	`processBBCode(String s)`
`static String`	`processSearchCondition(String searchCondition)` Process the search condition correspond to each context
`static String`	`processUnifiedSearchSearchCondition(String input)`
`static String`	`removeSpecialCharacterForSearch(String input)` Filter all invalid character (anything except word, number, space and search wildcard) from search conditional.
`static String`	`removeSpecialCharacterForUnifiedSearch(String input)`

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

- Field Detail
  - COMMA
```
public static final String COMMA
```
    See Also:
    
    Constant Field Values
  - SLASH
```
public static final String SLASH
```
    See Also:
    
    Constant Field Values
  - EMPTY_STR
```
public static final String EMPTY_STR
```
    See Also:
    
    Constant Field Values
  - COLON
```
public static final String COLON
```
    See Also:
    
    Constant Field Values
  - SEMICOLON
```
public static final String SEMICOLON
```
    See Also:
    
    Constant Field Values
  - SPACE
```
public static final String SPACE
```
    See Also:
    
    Constant Field Values
  - ASTERISK_STR
```
public static final String ASTERISK_STR
```
    See Also:
    
    Constant Field Values
  - PERCENT_STR
```
public static final String PERCENT_STR
```
    See Also:
    
    Constant Field Values
  - AMP_NUMBER
```
public static final String AMP_NUMBER
```
    See Also:
    
    Constant Field Values
  - LESS_THAN
```
public static final String LESS_THAN
```
    See Also:
    
    Constant Field Values
  - GREATER_THAN
```
public static final String GREATER_THAN
```
    See Also:
    
    Constant Field Values
  - QUOT
```
public static final String QUOT
```
    See Also:
    
    Constant Field Values
  - AMP_SPACE
```
public static final String AMP_SPACE
```
    See Also:
    
    Constant Field Values
  - AMP_HEX
```
public static final String AMP_HEX
```
    See Also:
    
    Constant Field Values
  - AMP
```
public static final String AMP
```
    See Also:
    
    Constant Field Values
  - FROM_KEY
```
public static final String FROM_KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CommonUtils
```
public CommonUtils()
```
- Method Detail
  - generateCheckSum
```
public static String generateCheckSum(byte[] b)
                               throws Exception
```
    Generates checksum for files, and get a file ending in .sha1 This task can also be used to perform checksum verifications.
    
    Parameters:
    
    b -
    
    Returns:
    
    Throws:
    
    Exception
  - getXMLFile
```
public static File getXMLFile(ByteArrayOutputStream bos,
                              String appName,
                              String objectType,
                              Date createDate,
                              String fileName)
                       throws Exception
```
    Throws:
    
    Exception
  - getImageUrl
```
public static String getImageUrl(String imagePath)
                          throws Exception
```
    Throws:
    
    Exception
  - convertCodeHTML
```
public static String convertCodeHTML(String s)
```
  - makeNotificationSender
```
public static String makeNotificationSender(String from)
```
    This function will change email address in 'from' field by address of mail service which is configured as system property : gatein.email.smtp.from or mail.from.
    That ensures that 'emailAddress' part of 'from' field in a message object is always the same identity with authentication of smtp configuration.
    It's because of 2 reasons:
    - we don't want notification message to show email address of user as sender. Instead, we use mail service of kernel.
    - Almost authenticated smtp systems do not allow to separate email address in from field of message from smtp authentication (for now, GMX, MS exchange deny, Gmail efforts to modify the such value)
    Parameters:
    
    from -
    
    Returns:
    
    null if can not find suitable sender.
  - getURI
```
public static String getURI(String url)
```
    Get the URI of full URL
    
    Parameters:
    
    url - The URL input
    
    Returns:
  - processBBCode
```
public static String processBBCode(String s)
```
    Parameters:
    
    s -
    
    Returns:
  - getExoContainer
```
public static org.exoplatform.container.ExoContainer getExoContainer(org.quartz.JobExecutionContext context)
```
  - getRSSLink
```
public static String getRSSLink(String appType,
                                String portalName,
                                String objectId)
```
  - getUserRSSLink
```
public static String getUserRSSLink(String apptype,
                                    String userId)
```
  - isEmpty
```
public static boolean isEmpty(String s)
```
    Check string is null or empty
    
    Parameters:
    
    s -
    
    Returns:
    
    boolean
  - isEmpty
```
public static boolean isEmpty(String[] array)
```
    check string array is whether empty or not
    
    Parameters:
    
    array -
    
    Returns:
    
    false if at least one element of array is not empty, true in the opposite case.
  - removeSpecialCharacterForSearch
```
public static String removeSpecialCharacterForSearch(String input)
```
    Filter all invalid character (anything except word, number, space and search wildcard) from search conditional.
    
    Parameters:
    
    input - the input string
    
    Returns:
    
    String after remove all special characters
    
    Since:
    
    4.0.x
  - removeSpecialCharacterForUnifiedSearch
```
public static String removeSpecialCharacterForUnifiedSearch(String input)
```
  - processUnifiedSearchSearchCondition
```
public static String processUnifiedSearchSearchCondition(String input)
```
  - normalizeUnifiedSearchInput
```
public static String normalizeUnifiedSearchInput(String input)
```
    Normalize Unified search input
    
    Parameters:
    
    input - The key search
    
    Returns:
  - hasSpecialCharacter
```
public static boolean hasSpecialCharacter(String input)
```
    To check the input content has special characters or not.
    
    Parameters:
    
    input -
    
    Returns:
  - processSearchCondition
```
public static String processSearchCondition(String searchCondition)
```
    Process the search condition correspond to each context
    
    Parameters:
    
    searchCondition - the search condition
  - getExcerpt
```
public static String getExcerpt(String str,
                                String textQuery,
                                int maxLength)
```
    Get excerpt of given string with start position is the first position of textQuery.
    
    Parameters:
    
    str - the give string
    
    textQuery - the text that we truncate at the first appear
    
    maxLength - max of string length
    
    Returns:
    
    the excerpt string
  - centerTrunc
```
public static final String centerTrunc(String str,
                                       int middlePosition,
                                       int maxLength)
```
    Truncates large Strings showing the string around the specific middle position with the specific length.
    
    Parameters:
    
    str - the string to truncate
    
    middlePosition - the middle position we will show string around
    
    maxLength - the max length of string to show
    
    Returns:
    
    the truncated string
  - getGreenwichMeanTime
```
public static Calendar getGreenwichMeanTime()
```
    Get current time GMT/Zulu or UTC,(zone time is 0+GMT)
    
    Returns:
    
    Calendar
  - getComponent
```
public static <T> T getComponent(Class<T> type)
```
  - createSystemProvider
```
public static org.exoplatform.services.jcr.ext.common.SessionProvider createSystemProvider()
```

Class CommonUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMMA

SLASH

EMPTY_STR

COLON

SEMICOLON

SPACE

ASTERISK_STR

PERCENT_STR

AMP_NUMBER

LESS_THAN

GREATER_THAN

QUOT

AMP_SPACE

AMP_HEX

AMP

FROM_KEY

Constructor Detail

CommonUtils

Method Detail

generateCheckSum

getXMLFile

getImageUrl

convertCodeHTML

makeNotificationSender

getURI

processBBCode

getExoContainer

getRSSLink

getUserRSSLink

isEmpty

isEmpty

removeSpecialCharacterForSearch

removeSpecialCharacterForUnifiedSearch

processUnifiedSearchSearchCondition

normalizeUnifiedSearchInput

hasSpecialCharacter

processSearchCondition

getExcerpt

centerTrunc

getGreenwichMeanTime

getComponent

createSystemProvider