org.kuali.ole.docstore.util

Class DocStoreEnvUtil

java.lang.Object

org.kuali.ole.docstore.util.DocStoreEnvUtil

public class DocStoreEnvUtil
extends Object

Created by IntelliJ IDEA. User: Sreekanth Date: 6/6/12 Time: 3:19 PM To change this template use File | Settings | File Templates.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOC_STORE_PROPERTIES_FILE_SYS_PROP
static String	DOCSTORE_DOCUMENTCONFIG_FILE
static String	DOCSTORE_LOG4J_PROPERTIES_FILE
static String	DOCSTORE_PROPERTIES_FILE
static String	DOCSTORE_PROPERTIES_FOLDER
static String	DOCSTORE_ROOT_DEFAULT
static String	DOCSTORE_ROOT_DIR
static String	DOCSTORE_ROOT_TEST_DEFAULT
protected String	docStoreDocumentConfigFilePath
protected String	docStorePropertiesFilePath
protected String	docStorePropertiesFolderPath
protected String	rootFolderPath

Constructor Summary

Constructors

Constructor and Description
DocStoreEnvUtil()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDocStorePropertiesFilePath()
String	getDocStorePropertiesFolderPath()
String	getDocStoreRoot(String defaultValue) Calculate the correct home directory for docstore based on system properties and environment.
protected List<ResourceItem>	getResourceItems() Return a list of ResourceItem objects representing resources required by the docstore application.
String	getRootFolderPath()
protected void	initEnv(String defaultRootValue) Configure the home directory for docstore.
void	initEnvironment() Initializes environment for normal use of docStore.
void	initEnvironmentCommon(String docStoreRoot) Initializes an environment for the DocStore application at the given root folder.
void	initPathValues(String docStoreRoot)
void	initTestEnvironment() Initializes environment for testing.
void	logEnvironment()
void	printEnvironment()
void	setDocStorePropertiesFilePath(String docStorePropertiesFilePath)
void	setDocStorePropertiesFolderPath(String docStorePropertiesFolderPath)
void	setProperties(Properties properties)
void	setRootFolderPath(String rootFolderPath)
void	setVendor(String vendor)

Methods inherited from class java.lang.Object

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

Field Detail

DOCSTORE_ROOT_DIR

public static final String DOCSTORE_ROOT_DIR

See Also:

Constant Field Values

DOCSTORE_ROOT_DEFAULT

public static final String DOCSTORE_ROOT_DEFAULT

See Also:

Constant Field Values

DOCSTORE_ROOT_TEST_DEFAULT

public static final String DOCSTORE_ROOT_TEST_DEFAULT

See Also:

Constant Field Values

DOCSTORE_PROPERTIES_FOLDER

public static final String DOCSTORE_PROPERTIES_FOLDER

See Also:

Constant Field Values

DOCSTORE_PROPERTIES_FILE

public static final String DOCSTORE_PROPERTIES_FILE

See Also:

Constant Field Values

DOCSTORE_LOG4J_PROPERTIES_FILE

public static final String DOCSTORE_LOG4J_PROPERTIES_FILE

See Also:

Constant Field Values

DOCSTORE_DOCUMENTCONFIG_FILE

public static final String DOCSTORE_DOCUMENTCONFIG_FILE

See Also:

Constant Field Values

DOC_STORE_PROPERTIES_FILE_SYS_PROP

public static final String DOC_STORE_PROPERTIES_FILE_SYS_PROP

See Also:

Constant Field Values

docStorePropertiesFilePath

protected String docStorePropertiesFilePath

rootFolderPath

protected String rootFolderPath

docStorePropertiesFolderPath

protected String docStorePropertiesFolderPath

docStoreDocumentConfigFilePath

protected String docStoreDocumentConfigFilePath

Constructor Detail

DocStoreEnvUtil

public DocStoreEnvUtil()

Method Detail

initEnvironment

public void initEnvironment()
                     throws IOException

Initializes environment for normal use of docStore. This should be called during web app initialization.

Throws:

IOException

initTestEnvironment

public void initTestEnvironment()
                         throws IOException

Initializes environment for testing. This should be called in all test cases.

Throws:

IOException

initEnv

protected void initEnv(String defaultRootValue)
                throws IOException

Configure the home directory for docstore. When this method returns the system property ole.docstore.home is guaranteed to be set.

Throws:

IOException

getDocStoreRoot

public String getDocStoreRoot(String defaultValue)

Calculate the correct home directory for docstore based on system properties and environment. If no system properties or environment variables are set, fall through to the default directory.

initPathValues

public void initPathValues(String docStoreRoot)

initEnvironmentCommon

public void initEnvironmentCommon(String docStoreRoot)

Initializes an environment for the DocStore application at the given root folder. Looks for necessary folders and files under the root folder. Any resources that already exist are left untouched. Any that are missing are created using default values.

getResourceItems

protected List<ResourceItem> getResourceItems()

Return a list of ResourceItem objects representing resources required by the docstore application.

setProperties

public void setProperties(Properties properties)

setVendor

public void setVendor(String vendor)

printEnvironment

public void printEnvironment()

logEnvironment

public void logEnvironment()

getDocStorePropertiesFolderPath

public String getDocStorePropertiesFolderPath()

setDocStorePropertiesFolderPath

public void setDocStorePropertiesFolderPath(String docStorePropertiesFolderPath)

getDocStorePropertiesFilePath

public String getDocStorePropertiesFilePath()

setDocStorePropertiesFilePath

public void setDocStorePropertiesFilePath(String docStorePropertiesFilePath)

getRootFolderPath

public String getRootFolderPath()

setRootFolderPath

public void setRootFolderPath(String rootFolderPath)