Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.util
Class StartupContent

java.lang.Object
  extended by com.jivesoftware.base.util.StartupContent

public class StartupContent
extends java.lang.Object

Responsible for verifying and loading the Forums startup content into the database. The startup content is located in the jive_forums_data.sql script. The script must be located in the classpath in order to be file system independent.

Queries selected tables to verify startup content exists. If the content for a particular table does not exist, that content is loaded. The Connection is not closed so the data can be loaded from the DbConnectionManager in a lazy fashion, without interrupting the general flow.

Supports Extra Startup Content defined in the jive_extra_startup_content.xml. This content is loaded from the classpath and provides a mechanism to add extra Jive Properties on top of the defaults.


Nested Class Summary
static class StartupContent.ExtraStartupJiveProperty
          Represents an entry in the jive_extra_startup_content.xml.
 
Method Summary
static java.util.Map getExtraStartupContent()
          Retrieves all extra startup content properties as a Map.
static boolean isExtraStartupPropertyReadOnly(java.lang.String propertyName)
          Checks if an extra startup property is read only.
static void loadContent(java.sql.Connection conn)
          Loads the required Jive Forums content from the jive_forums_data.sql file, found in the classpath.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

loadContent

public static void loadContent(java.sql.Connection conn)
                        throws java.sql.SQLException
Loads the required Jive Forums content from the jive_forums_data.sql file, found in the classpath.

Parameters:
conn - the connection.
Throws:
java.sql.SQLException - if an error occurs executing a statement.

getExtraStartupContent

public static java.util.Map getExtraStartupContent()
Retrieves all extra startup content properties as a Map. This is set in the jive_extra_startup_content.xml

Returns:
all extra startup properties.

isExtraStartupPropertyReadOnly

public static boolean isExtraStartupPropertyReadOnly(java.lang.String propertyName)
Checks if an extra startup property is read only. This is set in the jive_extra_startup_content.xml.

Parameters:
propertyName - the property to check
Returns:
true if the property is read only.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.