com.jivesoftware.community
Class JiveGlobals

java.lang.Object
  com.jivesoftware.community.JiveGlobals

public class JiveGlobals
extends java.lang.Object

This class controls access to a number of global propeties in the applcation.

Additionally, this class controls access to Jive properties. If the application is on, property manipulation must be done through this class and not the database or xml files directly.

Properties come in 3 types:

1. Local properties - these are set in jiveHome/jive_startup.xml
2. Database properties - these are stored in the jiveProperty database table
3. Localized properties - these are stored in the jiveLocalizedProp database table.

As mentioned above, local (or startup) properties are stored in the jive_startup.xml file in the jiveHome directory. These properties bootstrap the application and start things like database access and cache settings. Jive needs to know the physical location of the jiveHome directory. This can be set in a number of ways:

• Set a Java system property named jiveHome with the full path to the directory.
• Set the full path in a jive_init.xml located in your classpath. This is a simple XML file and should look something like this: <jiveHome>c:\the\path\to\jiveHome<\jiveHome> or <jiveHome>/opt/path/to/jiveHome</jiveHome>
• Use another class in your claspath so it can be loaded by Java's classloaders. This must be done before the rest of the application starts up. A good place for this might be servlet that is set to run as soon as the appserver starts up.

All Jive property names must be in the form prop.name - parts of the name must be separated by ".". The value can be any valid String, including strings with line breaks.

Methods to control local properties (in jive_startup.xml):

• getLocalProperty(String)
• getLocalProperty(String, int)
• getLocalProperties(String)
• setLocalProperty(String, String)
• setLocalProperties(Map)
• deleteLocalProperty(String)

Methods to control database properties (in the jiveProperty table):

• getJiveProperty(String)
• getJiveProperty(String, String)
• getJivePropertyNames()
• getJivePropertyNames(String)
• getJiveProperties(String)
• getJiveIntProperty(String, int)
• getJiveBooleanProperty(String)
• getJiveBooleanProperty(String, boolean)
• setJiveProperty(String, String)
• setJiveProperties(java.util.Map)
• deleteJiveProperty(String)

Methods to control localized properties (in the jiveLocalizedProp table):

• getLocalizedJiveProperty(String, java.util.Locale)
• getLocalizedPropertyLocales(String)
• setLocalizedJiveProperty(String, String, java.util.Locale)
• deleteLocalizedJiveProperty(String, java.util.Locale)

Nested Class Summary

static interface	JiveGlobals.JiveHomeProvider A pluggable way to specify a value for jiveHome.
static class	JiveGlobals.ResetLocalizationSettingsClusterTask

Field Summary

static boolean	failedLoading Indicates loading a reference to the jiveHome directory failed.
static java.lang.String	jiveHome Location of the jiveHome directory.
static JiveProperties<java.lang.String,java.lang.String>	setupProperties Local Jive properties (from jive_startup.xml).

Method Summary

static void	deleteJiveProperty(java.lang.String name) Deletes a Jive property.
static void	deleteLocalizedJiveProperty(java.lang.String name, java.util.Locale locale) Deletes a localized Jive property.
static void	deleteLocalProperty(java.lang.String name) Deletes a local property.
static java.lang.String	formatDate(java.util.Date date) Formats a Date object and returns a formatted String.
static java.lang.String	formatDateTime(java.util.Date date) Formats a Date object to return a date and time using the global locale.
static java.lang.String	getBuildProperty(java.lang.String name) Returns a build-level property.
static java.lang.String	getCharacterEncoding() Returns the character set that Jive uses for encoding.
static java.lang.String	getDefaultBaseURL() Returns the base URL of this Jive installation - usually: http://[yoursite]/[webapp-path] This uses the Jive property of jiveURL which is settable through the config file or admin console.
static boolean	getJiveBooleanProperty(java.lang.String name) Returns the specified Jive property as a boolean or returns false if the property doesn't exist or isn't parseable.
static boolean	getJiveBooleanProperty(java.lang.String name, boolean defaultValue) Returns the specified Jive property as a boolean or returns defaultValue if the property doesn't exist or isn't parseable.
static java.lang.String	getJiveHome() Returns the location of the jiveHome directory.
static int	getJiveIntProperty(java.lang.String name, int defaultValue) Returns the specified Jive property as an integer or returns the defaultValue if the property does't exist or the value isn't a number.
static JiveObject	getJiveObjectFromURL(JiveContext jiveContext, java.lang.String url) Returns a JiveObject that matches the specified url or null if no object matches the specified url.
static java.lang.String	getJiveObjectURL(JiveObject jiveObject) Returns the full (including domain name as set in the jiveURL jive property ) URL to this JiveObject or the default base url if the jive content object does not have a specific url.
static java.util.List<java.lang.String>	getJiveProperties(java.lang.String parent) Return all immediate children property values of a parent Jive property as a list of strings, or an empty list if there are no children.
static java.lang.String	getJiveProperty(java.lang.String name) Returns the value of the specified property or null if the value doesn't exist.
static java.lang.String	getJiveProperty(java.lang.String name, java.lang.String defaultValue) Returns a Jive property.
static java.util.List<java.lang.String>	getJivePropertyNames() Returns all Jive property names.
static java.util.List<java.lang.String>	getJivePropertyNames(java.lang.String parent) Return all immediate children property names of a parent Jive property as a list of strings, or an empty list if there are no children.
static java.util.Locale	getLocale() Returns the global Locale used by Jive.
static java.lang.String	getLocalizedJiveProperty(java.lang.String name, java.util.Locale locale) Returns a localized Jive property given its name and locale.
static java.util.List<java.util.Locale>	getLocalizedPropertyLocales(java.lang.String name) Returns a list of locales where this property is set.
static java.util.List<java.lang.String>	getLocalProperties(java.lang.String parent) Return all immediate children property values of a parent local property as a list of strings, or an empty list if there are no children.
static java.lang.String	getLocalProperty(java.lang.String name) Returns a local property.
static int	getLocalProperty(java.lang.String name, int defaultValue) Returns a local property as an integer.
static java.util.Map<java.lang.String,java.lang.String>	getSpiProperties(java.lang.String spiClass)
static java.lang.String	getSpiProperty(java.lang.String spiClass, java.lang.String name)
static java.util.Date	getStartupDate() Returns the date the Jive system was started.
static java.util.TimeZone	getTimeZone() Returns the global TimeZone used by Jive.
static java.util.Map<java.lang.String,java.lang.String>	getUnmodifiableMap()
static boolean	isSetup() Returns true if the application has been set up, false otherwise.
static boolean	isWhiteLabel() Returns true if the application is running in white label mode, false otherwise.
static void	resetLocalization() Resets locale specific settings so they will be reread from properties.
static void	setCharacterEncoding(java.lang.String characterEncoding) Sets the character set that Jive uses for encoding.
static void	setConfigName(java.lang.String configName) Allows the name of the local config file name to be changed.
static void	setJiveHome(java.lang.String jHome) Sets the location of the jiveHome directory.
static void	setJiveProperties(java.util.Map<java.lang.String,java.lang.String> propertyMap) Sets multiple Jive properties at once.
static void	setJiveProperty(java.lang.String name, java.lang.String value) Sets a Jive property.
static void	setLocale(java.util.Locale newLocale) Sets the global locale used by Jive.
static void	setLocalizedJiveProperty(java.lang.String name, java.lang.String value, java.util.Locale locale) Sets a localized Jive property.
static void	setLocalProperties(java.util.Map<java.lang.String,java.lang.String> propertyMap) Sets multiple local properties at once.
static void	setLocalProperty(java.lang.String name, java.lang.String value) Sets a local property.
static void	setSpiProperties(java.lang.String spiClass, java.util.Map<java.lang.String,java.lang.String> config)
static void	setSpiProperty(java.lang.String clazz, java.lang.String name, java.lang.String value)
static void	setTimeZone(java.util.TimeZone newTimeZone) Sets the global time zone used by Jive.

Methods inherited from class java.lang.Object

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

Field Detail

jiveHome

public static java.lang.String jiveHome

Location of the jiveHome directory.

failedLoading

public static boolean failedLoading

Indicates loading a reference to the jiveHome directory failed.

setupProperties

public static JiveProperties<java.lang.String,java.lang.String> setupProperties

Local Jive properties (from jive_startup.xml).

Method Detail

getStartupDate

public static java.util.Date getStartupDate()

Returns the date the Jive system was started. This value can be used to calculate uptime.

Returns:

the date the Jive system was started.

getLocale

public static java.util.Locale getLocale()

Returns the global Locale used by Jive. A locale specifies language and country codes, and is used for internationalization. The default locale is system dependant and is determined by calling Locale.getDefault().

Returns:

the global locale used by Jive.

setLocale

public static void setLocale(java.util.Locale newLocale)

Sets the global locale used by Jive. A locale specifies language and country codes, and is used for formatting dates and numbers. The default locale comes from the JDK's Locale.getDefault().

Parameters:

newLocale - the global locale for Jive.

getCharacterEncoding

public static java.lang.String getCharacterEncoding()

Returns the character set that Jive uses for encoding. This is used for displaying content in skins, sending email watch updates, etc. The default encoding is UTF-8, which is a Unicode encoding which supports double byte character sets such as Chinese or Japanese. Unicode offers simultaneous support for a large number of languages and is easy to convert into native charsets as necessary. You may also specify any other charset that is supported by your JVM. A list of encodings supported by the Sun JVM can be found here.

In order for a particular encoding to work (such as Unicode), your application server and database may need to be specially configured. Please consult your server documentation for more information. For example, SQLServer has a special column type for Unicode text, and the Resin application server can be configured to use a custom charset by adding a <character-encoding> element to the web.xml/resin.conf file. Any Servlet 2.3 compliant application servers also supports the method HttpServletRequest.setCharacterEncoding(String). A Servlet 2.3 filter called com.jivesoftware.community.web.filter.SetResponseCharacterEncodingFilter is installed in this application's web.xml file, which will set the incoming character encoding to the one reported by this method.

Returns:

the global Jive character encoding.

setCharacterEncoding

public static void setCharacterEncoding(java.lang.String characterEncoding)
                                 throws java.io.UnsupportedEncodingException

Sets the character set that Jive uses for encoding. For a more complete description of the character encoding in this applcation, see getCharacterEncoding().

Parameters:

characterEncoding - the global Jive character encoding.

Throws:

java.io.UnsupportedEncodingException - if the specified character encoding is invalid.

getTimeZone

public static java.util.TimeZone getTimeZone()

Returns the global TimeZone used by Jive. The default is the JDK's default time zone.

Returns:

the global time zone used by Jive.

setTimeZone

public static void setTimeZone(java.util.TimeZone newTimeZone)

Sets the global time zone used by Jive.

Parameters:

newTimeZone - the new global time zone used by this application.

resetLocalization

public static void resetLocalization()

Resets locale specific settings so they will be reread from properties.

formatDate

public static java.lang.String formatDate(java.util.Date date)

Formats a Date object and returns a formatted String. This uses the date formatter which in turn uses the default locale.

Parameters:

date - the Date to format.

Returns:

a String representing the date.

formatDateTime

public static java.lang.String formatDateTime(java.util.Date date)

Formats a Date object to return a date and time using the global locale.

Parameters:

date - the Date to format.

Returns:

a String representing the date and time.

getDefaultBaseURL

public static java.lang.String getDefaultBaseURL()

Returns the base URL of this Jive installation - usually:

http://[yoursite]/[webapp-path]

This uses the Jive property of jiveURL which is settable through the config file or admin console.

Returns:

the base URL of this Jive installation.

getJiveObjectURL

public static java.lang.String getJiveObjectURL(JiveObject jiveObject)

Returns the full (including domain name as set in the jiveURL jive property ) URL to this JiveObject or the default base url if the jive content object does not have a specific url. Objects for which URL's can be generated are as follows:

• Community
• Thread
• Message
• Blog
• BlogPost
• Document
• User
• Attachment

This uses the Jive property of jiveURL which is settable through the config file or admin console.

Parameters:

jiveObject - the jive object to return the url for

Returns:

the URL to this JiveObject

getJiveObjectFromURL

public static JiveObject getJiveObjectFromURL(JiveContext jiveContext,
                                              java.lang.String url)

Returns a JiveObject that matches the specified url or null if no object matches the specified url.

Parameters:

jiveContext - the context to use to retrieve the jive object

url - the url to a JiveObject

Returns:

a JiveObject that matches the specified url

getJiveHome

public static java.lang.String getJiveHome()

Returns the location of the jiveHome directory.

Returns:

the location of the jiveHome directory.

setJiveHome

public static void setJiveHome(java.lang.String jHome)

Sets the location of the jiveHome directory. This method is only intended to be used during setup and should not set called in normal operations.

Parameters:

jHome - the path to jiveHome

setConfigName

public static void setConfigName(java.lang.String configName)

Allows the name of the local config file name to be changed. The default is jive_startup.xml. Note, this is used for setup, upgrade or testing purposes and is not needed in normal operation.

Parameters:

configName - the name of the config file.

isSetup

public static boolean isSetup()

Returns true if the application has been set up, false otherwise.

Returns:

true if the application has been set up, false otherwise.

getLocalProperty

public static java.lang.String getLocalProperty(java.lang.String name)

Returns a local property. Local properties are stored in the file jive_startup.xml which exists in the jiveHome directory. Properties are always specified as "foo.bar.prop", which would map to the following entry in the XML file:

 <foo>
     <bar>
         <prop>some value</prop>
     </bar>
 </foo>
 

Parameters:

name - the name of the property to return.

Returns:

the property value specified by name.

getLocalProperty

public static int getLocalProperty(java.lang.String name,
                                   int defaultValue)

Returns a local property as an integer. If the specified property can't be found, or if the value is not a number, the defaultValue will be returned.

Parameters:

name - the name of the property to return.

defaultValue - the value returned if the property could not be loaded or was not a number.

Returns:

the property value specified by name or defaultValue.

getLocalProperties

public static java.util.List<java.lang.String> getLocalProperties(java.lang.String parent)

Return all immediate children property values of a parent local property as a list of strings, or an empty list if there are no children. For example, given the properties X.Y.A, X.Y.B, X.Y.C and X.Y.C.D, then the immediate child properties of X.Y are A, B, and C (the value of C.D would not be returned using this method).

Parameters:

parent - the name of the parent property to return the children for.

Returns:

all child property values for the given parent.

setLocalProperty

public static void setLocalProperty(java.lang.String name,
                                    java.lang.String value)

Sets a local property. If the property doesn't already exists, a new one will be created.

Parameters:

name - the name of the property being set.

value - the value of the property being set.

setLocalProperties

public static void setLocalProperties(java.util.Map<java.lang.String,java.lang.String> propertyMap)

Sets multiple local properties at once. If a property doesn't already exists, a new one will be created.

Parameters:

propertyMap - a map of properties, keyed on property name.

deleteLocalProperty

public static void deleteLocalProperty(java.lang.String name)

Deletes a local property. If the property doesn't exist, the method does nothing.

Parameters:

name - the name of the property to delete.

getJiveProperty

public static java.lang.String getJiveProperty(java.lang.String name)

Returns the value of the specified property or null if the value doesn't exist.

Parameters:

name - the name of the property to return.

Returns:

the property value specified by name or null if it doesn't exist.

getJiveProperty

public static java.lang.String getJiveProperty(java.lang.String name,
                                               java.lang.String defaultValue)

Returns a Jive property. If the specified property doesn't exist, the defaultValue will be returned.

Parameters:

name - the name of the property.

defaultValue - value returned if the property doesn't exist.

Returns:

the property value specified by name or the defaultValue if the property doesn't exist.

getJivePropertyNames

public static java.util.List<java.lang.String> getJivePropertyNames()

Returns all Jive property names.

Returns:

a List of all property names (Strings).

getJivePropertyNames

public static java.util.List<java.lang.String> getJivePropertyNames(java.lang.String parent)

Return all immediate children property names of a parent Jive property as a list of strings, or an empty list if there are no children. For example, given the properties X.Y.A, X.Y.B, X.Y.C and X.Y.C.D, then the immediate child properties of X.Y are A, B, and C (C.D would not be returned using this method).

Parameters:

parent - the parent property to return all child properties for

Returns:

a List of all immediate children property names

getJiveProperties

public static java.util.List<java.lang.String> getJiveProperties(java.lang.String parent)

Return all immediate children property values of a parent Jive property as a list of strings, or an empty list if there are no children. For example, given the properties X.Y.A, X.Y.B, X.Y.C and X.Y.C.D, then the immediate child properties of X.Y are X.Y.A, X.Y.B, and X.Y.C (the value of X.Y.C.D would not be returned using this method).

Parameters:

parent - the name of the parent property to return the children for.

Returns:

all child property values for the given parent.

getJiveIntProperty

public static int getJiveIntProperty(java.lang.String name,
                                     int defaultValue)

Returns the specified Jive property as an integer or returns the defaultValue if the property does't exist or the value isn't a number.

Parameters:

name - the name of the property.

defaultValue - value returned if the property doesn't exist or was not a number.

Returns:

the property value specified by name or defaultValue.

getJiveBooleanProperty

public static boolean getJiveBooleanProperty(java.lang.String name)

Returns the specified Jive property as a boolean or returns false if the property doesn't exist or isn't parseable.

Parameters:

name - the name of the property to return.

Returns:

true if the property value exists and is set to "true" (ignoring case). Otherwise false is returned.

getJiveBooleanProperty

public static boolean getJiveBooleanProperty(java.lang.String name,
                                             boolean defaultValue)

Returns the specified Jive property as a boolean or returns defaultValue if the property doesn't exist or isn't parseable.

Parameters:

name - the name of the property.

defaultValue - value returned if the property doesn't exist.

Returns:

true if the property value exists and is set to "true" or false if the property value is "false" (ignoring case). If the value isn't set or isn't parseable then defaultValue is returned.

setJiveProperty

public static void setJiveProperty(java.lang.String name,
                                   java.lang.String value)

Sets a Jive property. If the property doesn't already exists, a new one will be created.

Parameters:

name - the name of the property being set.

value - the value of the property being set.

setJiveProperties

public static void setJiveProperties(java.util.Map<java.lang.String,java.lang.String> propertyMap)

Sets multiple Jive properties at once. If a property doesn't already exists, a new one will be created.

Parameters:

propertyMap - a map of properties, keyed on property name.

deleteJiveProperty

public static void deleteJiveProperty(java.lang.String name)

Deletes a Jive property. If the property doesn't exist, the method does nothing. All children of the property will be deleted as well.

Parameters:

name - the name of the property to delete.

getLocalizedJiveProperty

public static java.lang.String getLocalizedJiveProperty(java.lang.String name,
                                                        java.util.Locale locale)

Returns a localized Jive property given its name and locale. If the property doesn't exist then null will be returned.

Parameters:

name - the name of the property

locale - the locale this property applies to

Returns:

the property value specified by name and locale or null if it doesn't exist.

getLocalizedPropertyLocales

public static java.util.List<java.util.Locale> getLocalizedPropertyLocales(java.lang.String name)

Returns a list of locales where this property is set. If the property doesn't exist or is not set then an empty list is returned.

Parameters:

name - the name of the property to check.

Returns:

a list of Locale objects where this property is set or an empty list if the property doesn't exist.

setLocalizedJiveProperty

public static void setLocalizedJiveProperty(java.lang.String name,
                                            java.lang.String value,
                                            java.util.Locale locale)

Sets a localized Jive property. If the property doesn't already exists, a new one will be created.

Parameters:

name - the name of the property being set.

value - the value of the property being set.

locale - the locale of the property

deleteLocalizedJiveProperty

public static void deleteLocalizedJiveProperty(java.lang.String name,
                                               java.util.Locale locale)

Deletes a localized Jive property. If the property doesn't exist, the method does nothing. All children of the property will be deleted as well.

Parameters:

name - the name of the property to delete.

locale - the locale of the property

isWhiteLabel

public static boolean isWhiteLabel()

Returns true if the application is running in white label mode, false otherwise. false is the default.

Returns:

true if we're in white label mode, false otherwise. False is the default.

getBuildProperty

public static java.lang.String getBuildProperty(java.lang.String name)

Returns a build-level property. These are properties that are part of the build itself and can not be overridden or changed at runtime.

Note, this method will be generally less performant that other property accessors, so it's best to cache the answer from this method.

Parameters:

name - the name of the proeprty

Returns:

the value of the property if it is set or null if the property is blank or if the prop doesn't exist.

getUnmodifiableMap

public static java.util.Map<java.lang.String,java.lang.String> getUnmodifiableMap()

setSpiProperty

public static void setSpiProperty(java.lang.String clazz,
                                  java.lang.String name,
                                  java.lang.String value)

getSpiProperty

public static java.lang.String getSpiProperty(java.lang.String spiClass,
                                              java.lang.String name)

getSpiProperties

public static java.util.Map<java.lang.String,java.lang.String> getSpiProperties(java.lang.String spiClass)

setSpiProperties

public static void setSpiProperties(java.lang.String spiClass,
                                    java.util.Map<java.lang.String,java.lang.String> config)