ca.bc.gov.webade.config
Class WebADEPreferencesXMLFileLoader

java.lang.Object
  extended byca.bc.gov.webade.config.WebADEPreferencesXMLFileLoader
All Implemented Interfaces:
java.io.Serializable

public final class WebADEPreferencesXMLFileLoader
extends java.lang.Object
implements java.io.Serializable

Author:
jross
See Also:
Serialized Form

Field Summary
static java.lang.String WEBADE_PREFERENCE_FILE_LOCATION
          System property name for property containing the path to the "webade-preference-file-location" containing the XML file that overrides preferences stored in the database for the specific installation.
 
Constructor Summary
WebADEPreferencesXMLFileLoader(java.io.File file)
           
WebADEPreferencesXMLFileLoader(java.lang.String fileLocation)
           
 
Method Summary
 WebADEPreferences getApplicationPreferences(java.lang.String applicationAcronym)
           
 WebADEPreferences getExtensionPreferences(java.lang.String applicationAcronym)
           
 WebADEPreferences getWebADEPreferences(java.lang.String applicationAcronym)
           
static java.lang.String getWebADEPreferencesFileLocation()
           
 void loadXml()
           
 void loadXml(java.io.File file)
           
 void loadXml(java.lang.String fileLocation)
           
static void setWebADEPreferencesFileLocation(java.lang.String webADEPreferencesFileLocation)
          Sets the WebADE preferences XML file location.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WEBADE_PREFERENCE_FILE_LOCATION

public static final java.lang.String WEBADE_PREFERENCE_FILE_LOCATION
System property name for property containing the path to the "webade-preference-file-location" containing the XML file that overrides preferences stored in the database for the specific installation.

See Also:
Constant Field Values
Constructor Detail

WebADEPreferencesXMLFileLoader

public WebADEPreferencesXMLFileLoader(java.io.File file)
                               throws WebADEException
Parameters:
file -
Throws:
WebADEException

WebADEPreferencesXMLFileLoader

public WebADEPreferencesXMLFileLoader(java.lang.String fileLocation)
                               throws WebADEException
Parameters:
fileLocation -
Throws:
WebADEException
Method Detail

getWebADEPreferencesFileLocation

public static java.lang.String getWebADEPreferencesFileLocation()
Returns:
The WebADE preferences XML file location.

setWebADEPreferencesFileLocation

public static void setWebADEPreferencesFileLocation(java.lang.String webADEPreferencesFileLocation)
Sets the WebADE preferences XML file location.

Parameters:
webADEPreferencesFileLocation - The WebADE preferences XML file location.

loadXml

public void loadXml()
             throws WebADEException
Throws:
WebADEException

loadXml

public void loadXml(java.lang.String fileLocation)
             throws WebADEException
Parameters:
fileLocation -
Throws:
WebADEException

loadXml

public void loadXml(java.io.File file)
             throws WebADEException
Parameters:
file -
Throws:
WebADEException

getApplicationPreferences

public WebADEPreferences getApplicationPreferences(java.lang.String applicationAcronym)
                                            throws WebADEException
Parameters:
applicationAcronym -
Returns:
The application's preferences from the config file.
Throws:
WebADEException

getWebADEPreferences

public WebADEPreferences getWebADEPreferences(java.lang.String applicationAcronym)
                                       throws WebADEException
Parameters:
applicationAcronym -
Returns:
The application's WebADE preferences from the config file.
Throws:
WebADEException

getExtensionPreferences

public WebADEPreferences getExtensionPreferences(java.lang.String applicationAcronym)
                                          throws WebADEException
Parameters:
applicationAcronym -
Returns:
The application's preferences from the config file.
Throws:
WebADEException