org.kuali.rice.core.framework.config.property
Class AbstractBaseConfig

java.lang.Object
  extended by org.kuali.rice.core.framework.config.property.AbstractBaseConfig
All Implemented Interfaces:
Config
Direct Known Subclasses:
JAXBConfigImpl, SimpleConfig

public abstract class AbstractBaseConfig
extends Object
implements Config

This abstract class implements all the convenience config methods that can be implemented independent of the config impl.

Author:
Kuali Rice Team (rice.collab@kuali.org)

Field Summary
 
Fields inherited from interface org.kuali.rice.core.api.config.property.Config
ALT_OJB_FILE, ALT_SPRING_FILE, APPLICATION_NAME, APPLICATION_VERSION, BAM_ENABLED, BASE_WEB_SERVICE_URL_WORKFLOW_CLIENT_FILE, BASE_WEB_SERVICE_WSDL_PATH, BATCH_MODE, CREDENTIALS_SOURCE_FACTORY, DATASOURCE_DRIVER_NAME, DATASOURCE_OJB_SEQUENCE_MANAGER, DATASOURCE_OJB_SEQUENCE_MANAGER_CLASS, DATASOURCE_PASSWORD, DATASOURCE_PLATFORM, DATASOURCE_POOL_MAX_SIZE, DATASOURCE_POOL_MAXWAIT, DATASOURCE_POOL_MIN_SIZE, DATASOURCE_POOL_VALIDATION_QUERY, DATASOURCE_URL, DATASOURCE_USERNAME, DEFAULT_KEW_NOTE_CLASS, DEV_MODE, DOCUMENT_LOCK_TIMEOUT, EDL_CONFIG_LOCATION, EMAIL_SECURITY_PATH, EMBEDDED_PLUGIN_DEFAULT_CURRENT_CLASS_LOADER, EMBEDDED_PLUGIN_LOCATIAON, ENABLE_EMAIL_REMINDER_LIFECYCLE, ENABLE_XML_PIPELINE_LIFECYCLE, ENVIRONMENT, EXTRA_CLASSES_DIR, EXTRA_LIB_DIR, FIRST_DAILY_EMAIL_DELIVERY_DATE, FIRST_WEEKLY_EMAIL_DELIVERY_DATE, KEN_URL, KEW_URL, KEYSTORE_ALIAS, KEYSTORE_FILE, KEYSTORE_PASSWORD, KIM_URL, KR_URL, LOG4J_SETTINGS_PATH, LOG4J_SETTINGS_PROPS, LOG4J_SETTINGS_RELOADINTERVAL_MINS, LOG4J_SETTINGS_XML, M_BEANS, MESSAGE_PERSISTENCE, MODULE_NAME, NODE_PROPERTIES_PATH, OJB_PLATFORM, OUT_BOX_MODE, PLUGIN_DIR, PROD_ENVIRONMENT_CODE, REFRESH_RATE, RICE_VERSION, SERVICE_SERVLET_URL, THREAD_POOL_SIZE, TRANSACTION_TIMEOUT, VERSION, WEB_SERVICE_CONNECT_RETRY, WSDL_LOCATION_WORKFLOW_CLIENT_FILE
 
Constructor Summary
AbstractBaseConfig()
           
 
Method Summary
 String getAlternateOJBFile()
           
 String getAlternateSpringFile()
           
 String getApplicationName()
           
 String getApplicationVersion()
           
 String getBaseWebServiceURL()
           
 String getBaseWebServiceWsdlPath()
           
 Boolean getBatchMode()
           
 Boolean getBooleanProperty(String key)
           
 boolean getBooleanProperty(String key, boolean defaultValue)
           
 String getClientWSDLFullPathAndFileName()
           
 String getDailyEmailFirstDeliveryDate()
           
 String getDefaultKewNoteClass()
           
 Boolean getDevMode()
           
 String getDocumentLockTimeout()
           
 String getEDLConfigLocation()
           
 String getEmailConfigurationPath()
           
 Boolean getEmailReminderLifecycleEnabled()
           
 String getEmbeddedPluginLocation()
           
 String getEndPointUrl()
           
 String getEnvironment()
           
 String getKENBaseURL()
           
 String getKEWBaseURL()
           
 String getKeystoreAlias()
           
 String getKeystoreFile()
           
 String getKeystorePassword()
           
 String getKIMBaseURL()
           
 String getKRBaseURL()
           
 String getLog4jFileLocation()
           
 String getLog4jReloadInterval()
           
 Long getNumericProperty(String key)
           
 long getNumericProperty(String key, long defaultValue)
           
abstract  Object getObject(String key)
           
abstract  Map<String,Object> getObjects()
           
 Boolean getOutBoxOn()
           
 String getProductionEnvironmentCode()
           
abstract  Properties getProperties()
          Returns properties explicitly configured in this Config
 Map<String,String> getPropertiesWithPrefix(String prefix, boolean stripPrefix)
           
abstract  String getProperty(String key)
           
 Integer getRefreshRate()
           
 String getRiceVersion()
           
 String getTransactionTimeout()
           
 String getWebServicesConnectRetry()
           
 String getWeeklyEmailFirstDeliveryDate()
           
 Boolean getXmlPipelineLifeCycleEnabled()
           
 boolean isProductionEnvironment()
          Returns whether this Config object defines a production environment
abstract  void parseConfig()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.kuali.rice.core.api.config.property.Config
putConfig, putObject, putObjects, putProperties, putProperty, removeObject, removeProperty
 

Constructor Detail

AbstractBaseConfig

public AbstractBaseConfig()
Method Detail

getObject

public abstract Object getObject(String key)
Specified by:
getObject in interface Config

getObjects

public abstract Map<String,Object> getObjects()
Specified by:
getObjects in interface Config

getProperties

public abstract Properties getProperties()
Description copied from interface: Config
Returns properties explicitly configured in this Config

Specified by:
getProperties in interface Config
Returns:
properties explicitly configured in this Config

getProperty

public abstract String getProperty(String key)
Specified by:
getProperty in interface Config

parseConfig

public abstract void parseConfig()
                          throws IOException
Specified by:
parseConfig in interface Config
Throws:
IOException

getPropertiesWithPrefix

public Map<String,String> getPropertiesWithPrefix(String prefix,
                                                  boolean stripPrefix)
Specified by:
getPropertiesWithPrefix in interface Config

getAlternateOJBFile

public String getAlternateOJBFile()
Specified by:
getAlternateOJBFile in interface Config

getAlternateSpringFile

public String getAlternateSpringFile()
Specified by:
getAlternateSpringFile in interface Config

getBaseWebServiceURL

public String getBaseWebServiceURL()
Specified by:
getBaseWebServiceURL in interface Config

getBaseWebServiceWsdlPath

public String getBaseWebServiceWsdlPath()
Specified by:
getBaseWebServiceWsdlPath in interface Config

getBatchMode

public Boolean getBatchMode()
Specified by:
getBatchMode in interface Config

getBooleanProperty

public boolean getBooleanProperty(String key,
                                  boolean defaultValue)
Specified by:
getBooleanProperty in interface Config

getBooleanProperty

public Boolean getBooleanProperty(String key)
Specified by:
getBooleanProperty in interface Config

getNumericProperty

public long getNumericProperty(String key,
                               long defaultValue)
Specified by:
getNumericProperty in interface Config

getNumericProperty

public Long getNumericProperty(String key)
Specified by:
getNumericProperty in interface Config

getClientWSDLFullPathAndFileName

public String getClientWSDLFullPathAndFileName()
Specified by:
getClientWSDLFullPathAndFileName in interface Config

getDailyEmailFirstDeliveryDate

public String getDailyEmailFirstDeliveryDate()
Specified by:
getDailyEmailFirstDeliveryDate in interface Config

getDefaultKewNoteClass

public String getDefaultKewNoteClass()
Specified by:
getDefaultKewNoteClass in interface Config

getDevMode

public Boolean getDevMode()
Specified by:
getDevMode in interface Config

getDocumentLockTimeout

public String getDocumentLockTimeout()
Specified by:
getDocumentLockTimeout in interface Config

getEDLConfigLocation

public String getEDLConfigLocation()
Specified by:
getEDLConfigLocation in interface Config

getEmailConfigurationPath

public String getEmailConfigurationPath()
Specified by:
getEmailConfigurationPath in interface Config

getEmailReminderLifecycleEnabled

public Boolean getEmailReminderLifecycleEnabled()
Specified by:
getEmailReminderLifecycleEnabled in interface Config

getEmbeddedPluginLocation

public String getEmbeddedPluginLocation()
Specified by:
getEmbeddedPluginLocation in interface Config

getEndPointUrl

public String getEndPointUrl()
Specified by:
getEndPointUrl in interface Config

getEnvironment

public String getEnvironment()
Specified by:
getEnvironment in interface Config

getProductionEnvironmentCode

public String getProductionEnvironmentCode()
Specified by:
getProductionEnvironmentCode in interface Config

isProductionEnvironment

public boolean isProductionEnvironment()
Description copied from interface: Config
Returns whether this Config object defines a production environment

Specified by:
isProductionEnvironment in interface Config

getRiceVersion

public String getRiceVersion()
Specified by:
getRiceVersion in interface Config
Returns:
the RICE_VERSION property

getApplicationName

public String getApplicationName()
Specified by:
getApplicationName in interface Config
Returns:
APPLICATION_NAME or MODULE_NAME property

getApplicationVersion

public String getApplicationVersion()
Specified by:
getApplicationVersion in interface Config
Returns:
APPLICATION_VERSION or VERSION property

getKENBaseURL

public String getKENBaseURL()
Specified by:
getKENBaseURL in interface Config
Returns:
the base URL for KEN

getKEWBaseURL

public String getKEWBaseURL()
Specified by:
getKEWBaseURL in interface Config
Returns:
the base URL for KEW

getKIMBaseURL

public String getKIMBaseURL()
Specified by:
getKIMBaseURL in interface Config
Returns:
the base URL for KIM

getKRBaseURL

public String getKRBaseURL()
Specified by:
getKRBaseURL in interface Config
Returns:
the base URL for KRice

getKeystoreAlias

public String getKeystoreAlias()
Specified by:
getKeystoreAlias in interface Config

getKeystoreFile

public String getKeystoreFile()
Specified by:
getKeystoreFile in interface Config

getKeystorePassword

public String getKeystorePassword()
Specified by:
getKeystorePassword in interface Config

getLog4jFileLocation

public String getLog4jFileLocation()
Specified by:
getLog4jFileLocation in interface Config

getLog4jReloadInterval

public String getLog4jReloadInterval()
Specified by:
getLog4jReloadInterval in interface Config

getOutBoxOn

public Boolean getOutBoxOn()
Specified by:
getOutBoxOn in interface Config

getRefreshRate

public Integer getRefreshRate()
Specified by:
getRefreshRate in interface Config

getTransactionTimeout

public String getTransactionTimeout()
Specified by:
getTransactionTimeout in interface Config

getWebServicesConnectRetry

public String getWebServicesConnectRetry()
Specified by:
getWebServicesConnectRetry in interface Config

getWeeklyEmailFirstDeliveryDate

public String getWeeklyEmailFirstDeliveryDate()
Specified by:
getWeeklyEmailFirstDeliveryDate in interface Config

getXmlPipelineLifeCycleEnabled

public Boolean getXmlPipelineLifeCycleEnabled()
Specified by:
getXmlPipelineLifeCycleEnabled in interface Config


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.