org.kuali.rice.core.api.config.property
Interface Config

All Known Implementing Classes:
AbstractBaseConfig, ConfigParserImplConfig, JAXBConfigImpl, PluginConfig, SimpleConfig

public interface Config

Interface encapsulating central config settings. This interface was taken directly from BundleUtility which it replaces.

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

Field Summary
static String ALT_OJB_FILE
           
static String ALT_SPRING_FILE
           
static String APPLICATION_NAME
          Property a client can set to specify Rice client application name.
static String APPLICATION_VERSION
          Property consulted to determine application version explicitly set by the client application
static String BAM_ENABLED
           
static String BASE_WEB_SERVICE_URL_WORKFLOW_CLIENT_FILE
           
static String BASE_WEB_SERVICE_WSDL_PATH
           
static String BATCH_MODE
           
static String CREDENTIALS_SOURCE_FACTORY
           
static String DATASOURCE_DRIVER_NAME
           
static String DATASOURCE_OJB_SEQUENCE_MANAGER
           
static String DATASOURCE_OJB_SEQUENCE_MANAGER_CLASS
           
static String DATASOURCE_PASSWORD
           
static String DATASOURCE_PLATFORM
           
static String DATASOURCE_POOL_MAX_SIZE
           
static String DATASOURCE_POOL_MAXWAIT
           
static String DATASOURCE_POOL_MIN_SIZE
           
static String DATASOURCE_POOL_VALIDATION_QUERY
           
static String DATASOURCE_URL
           
static String DATASOURCE_USERNAME
           
static String DEFAULT_KEW_NOTE_CLASS
           
static String DEV_MODE
           
static String DOCUMENT_LOCK_TIMEOUT
           
static String EDL_CONFIG_LOCATION
           
static String EMAIL_SECURITY_PATH
           
static String EMBEDDED_PLUGIN_DEFAULT_CURRENT_CLASS_LOADER
           
static String EMBEDDED_PLUGIN_LOCATIAON
           
static String ENABLE_EMAIL_REMINDER_LIFECYCLE
           
static String ENABLE_XML_PIPELINE_LIFECYCLE
           
static String ENVIRONMENT
          The application "environment".
static String EXTRA_CLASSES_DIR
           
static String EXTRA_LIB_DIR
           
static String FIRST_DAILY_EMAIL_DELIVERY_DATE
           
static String FIRST_WEEKLY_EMAIL_DELIVERY_DATE
           
static String KEN_URL
          Configuration key under which to specify the base url for kim
static String KEW_URL
          Configuration key under which to specify the base url for workflow
static String KEYSTORE_ALIAS
           
static String KEYSTORE_FILE
           
static String KEYSTORE_PASSWORD
           
static String KIM_URL
          Configuration key under which to specify the base url for kim
static String KR_URL
          Configuration key under which to specify the base url for rice
static String LOG4J_SETTINGS_PATH
          Configuration key under which to specify an external Log4J configuration file path
static String LOG4J_SETTINGS_PROPS
          Configuration key under which to specify inlined Log4J configuration in properties configurer syntax
static String LOG4J_SETTINGS_RELOADINTERVAL_MINS
          Configuration key under which to specify the Log4J configuration reload interval in minutes
static String LOG4J_SETTINGS_XML
          Configuration key under which to specify inlined Log4J configuration in XML/DOM configurer syntax
static String M_BEANS
           
static String MESSAGE_PERSISTENCE
           
static String MODULE_NAME
          "module.name" is the historical de-facto parameter used to configure "module" names.
static String NODE_PROPERTIES_PATH
           
static String OJB_PLATFORM
           
static String OUT_BOX_MODE
           
static String PLUGIN_DIR
           
static String PROD_ENVIRONMENT_CODE
          The code that represents the production environment.
static String REFRESH_RATE
           
static String RICE_VERSION
          The Rice version is by default determined automatically by inspecting the classloader (@see .
static String SERVICE_SERVLET_URL
           
static String THREAD_POOL_SIZE
           
static String TRANSACTION_TIMEOUT
           
static String VERSION
          These properties are consulted to determine application version explicitly set by the client application.
static String WEB_SERVICE_CONNECT_RETRY
           
static String WSDL_LOCATION_WORKFLOW_CLIENT_FILE
           
 
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)
           
 Object getObject(String key)
           
 Map<String,Object> getObjects()
           
 Boolean getOutBoxOn()
           
 String getProductionEnvironmentCode()
           
 Properties getProperties()
          Returns properties explicitly configured in this Config
 Map<String,String> getPropertiesWithPrefix(String prefix, boolean stripPrefix)
           
 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
 void parseConfig()
           
 void putConfig(Config config)
          This method takes a config object and merges it with the current object.
 void putObject(String key, Object value)
           
 void putObjects(Map<String,Object> objects)
           
 void putProperties(Properties properties)
           
 void putProperty(String key, String value)
           
 void removeObject(String key)
           
 void removeProperty(String key)
           
 

Field Detail

KEYSTORE_ALIAS

static final String KEYSTORE_ALIAS
See Also:
Constant Field Values

KEYSTORE_PASSWORD

static final String KEYSTORE_PASSWORD
See Also:
Constant Field Values

KEYSTORE_FILE

static final String KEYSTORE_FILE
See Also:
Constant Field Values

BASE_WEB_SERVICE_URL_WORKFLOW_CLIENT_FILE

static final String BASE_WEB_SERVICE_URL_WORKFLOW_CLIENT_FILE
See Also:
Constant Field Values

BASE_WEB_SERVICE_WSDL_PATH

static final String BASE_WEB_SERVICE_WSDL_PATH
See Also:
Constant Field Values

WSDL_LOCATION_WORKFLOW_CLIENT_FILE

static final String WSDL_LOCATION_WORKFLOW_CLIENT_FILE
See Also:
Constant Field Values

WEB_SERVICE_CONNECT_RETRY

static final String WEB_SERVICE_CONNECT_RETRY
See Also:
Constant Field Values

LOG4J_SETTINGS_XML

static final String LOG4J_SETTINGS_XML
Configuration key under which to specify inlined Log4J configuration in XML/DOM configurer syntax

See Also:
Constant Field Values

LOG4J_SETTINGS_PROPS

static final String LOG4J_SETTINGS_PROPS
Configuration key under which to specify inlined Log4J configuration in properties configurer syntax

See Also:
Constant Field Values

LOG4J_SETTINGS_PATH

static final String LOG4J_SETTINGS_PATH
Configuration key under which to specify an external Log4J configuration file path

See Also:
Constant Field Values

LOG4J_SETTINGS_RELOADINTERVAL_MINS

static final String LOG4J_SETTINGS_RELOADINTERVAL_MINS
Configuration key under which to specify the Log4J configuration reload interval in minutes

See Also:
Constant Field Values

TRANSACTION_TIMEOUT

static final String TRANSACTION_TIMEOUT
See Also:
Constant Field Values

DOCUMENT_LOCK_TIMEOUT

static final String DOCUMENT_LOCK_TIMEOUT
See Also:
Constant Field Values

EMAIL_SECURITY_PATH

static final String EMAIL_SECURITY_PATH
See Also:
Constant Field Values

ENVIRONMENT

static final String ENVIRONMENT
The application "environment". This parameter is by convention used in many places, and is also reported on outbound service calls.

See Also:
Constant Field Values

PROD_ENVIRONMENT_CODE

static final String PROD_ENVIRONMENT_CODE
The code that represents the production environment.

See Also:
Constant Field Values

RICE_VERSION

static final String RICE_VERSION
The Rice version is by default determined automatically by inspecting the classloader (@see . However, this property is available for special cases such as testing or workarounds, in order to override the reported Rice version.

See Also:
Constant Field Values

MODULE_NAME

static final String MODULE_NAME
"module.name" is the historical de-facto parameter used to configure "module" names. This convention was adopted by client applications (e.g. sample-app) and is now consulted to determine client application name for service call version reporting.

See Also:
Constant Field Values

APPLICATION_NAME

static final String APPLICATION_NAME
Property a client can set to specify Rice client application name. This value is reported in outbound Rice service calls.

See Also:
Constant Field Values

VERSION

static final String VERSION
These properties are consulted to determine application version explicitly set by the client application. "version" is available as a convenience fallback for existing configurations (e.g. sample-app).

See Also:
Constant Field Values

APPLICATION_VERSION

static final String APPLICATION_VERSION
Property consulted to determine application version explicitly set by the client application

See Also:
Constant Field Values

PLUGIN_DIR

static final String PLUGIN_DIR
See Also:
Constant Field Values

EXTRA_CLASSES_DIR

static final String EXTRA_CLASSES_DIR
See Also:
Constant Field Values

EXTRA_LIB_DIR

static final String EXTRA_LIB_DIR
See Also:
Constant Field Values

EDL_CONFIG_LOCATION

static final String EDL_CONFIG_LOCATION
See Also:
Constant Field Values

THREAD_POOL_SIZE

static final String THREAD_POOL_SIZE
See Also:
Constant Field Values

BAM_ENABLED

static final String BAM_ENABLED
See Also:
Constant Field Values

EMBEDDED_PLUGIN_LOCATIAON

static final String EMBEDDED_PLUGIN_LOCATIAON
See Also:
Constant Field Values

DATASOURCE_PLATFORM

static final String DATASOURCE_PLATFORM
See Also:
Constant Field Values

OJB_PLATFORM

static final String OJB_PLATFORM
See Also:
Constant Field Values

NODE_PROPERTIES_PATH

static final String NODE_PROPERTIES_PATH
See Also:
Constant Field Values

DATASOURCE_OJB_SEQUENCE_MANAGER

static final String DATASOURCE_OJB_SEQUENCE_MANAGER
See Also:
Constant Field Values

DATASOURCE_OJB_SEQUENCE_MANAGER_CLASS

static final String DATASOURCE_OJB_SEQUENCE_MANAGER_CLASS
See Also:
Constant Field Values

DATASOURCE_DRIVER_NAME

static final String DATASOURCE_DRIVER_NAME
See Also:
Constant Field Values

DATASOURCE_URL

static final String DATASOURCE_URL
See Also:
Constant Field Values

DATASOURCE_POOL_MIN_SIZE

static final String DATASOURCE_POOL_MIN_SIZE
See Also:
Constant Field Values

DATASOURCE_POOL_MAX_SIZE

static final String DATASOURCE_POOL_MAX_SIZE
See Also:
Constant Field Values

DATASOURCE_POOL_MAXWAIT

static final String DATASOURCE_POOL_MAXWAIT
See Also:
Constant Field Values

DATASOURCE_POOL_VALIDATION_QUERY

static final String DATASOURCE_POOL_VALIDATION_QUERY
See Also:
Constant Field Values

DATASOURCE_USERNAME

static final String DATASOURCE_USERNAME
See Also:
Constant Field Values

DATASOURCE_PASSWORD

static final String DATASOURCE_PASSWORD
See Also:
Constant Field Values

KEW_URL

static final String KEW_URL
Configuration key under which to specify the base url for workflow

See Also:
Constant Field Values

KR_URL

static final String KR_URL
Configuration key under which to specify the base url for rice

See Also:
Constant Field Values

KIM_URL

static final String KIM_URL
Configuration key under which to specify the base url for kim

See Also:
Constant Field Values

KEN_URL

static final String KEN_URL
Configuration key under which to specify the base url for kim

See Also:
Constant Field Values

DEFAULT_KEW_NOTE_CLASS

static final String DEFAULT_KEW_NOTE_CLASS
See Also:
Constant Field Values

M_BEANS

static final String M_BEANS
See Also:
Constant Field Values

ALT_SPRING_FILE

static final String ALT_SPRING_FILE
See Also:
Constant Field Values

ALT_OJB_FILE

static final String ALT_OJB_FILE
See Also:
Constant Field Values

SERVICE_SERVLET_URL

static final String SERVICE_SERVLET_URL
See Also:
Constant Field Values

MESSAGE_PERSISTENCE

static final String MESSAGE_PERSISTENCE
See Also:
Constant Field Values

REFRESH_RATE

static final String REFRESH_RATE
See Also:
Constant Field Values

DEV_MODE

static final String DEV_MODE
See Also:
Constant Field Values

BATCH_MODE

static final String BATCH_MODE
See Also:
Constant Field Values

CREDENTIALS_SOURCE_FACTORY

static final String CREDENTIALS_SOURCE_FACTORY
See Also:
Constant Field Values

EMBEDDED_PLUGIN_DEFAULT_CURRENT_CLASS_LOADER

static final String EMBEDDED_PLUGIN_DEFAULT_CURRENT_CLASS_LOADER
See Also:
Constant Field Values

FIRST_DAILY_EMAIL_DELIVERY_DATE

static final String FIRST_DAILY_EMAIL_DELIVERY_DATE
See Also:
Constant Field Values

FIRST_WEEKLY_EMAIL_DELIVERY_DATE

static final String FIRST_WEEKLY_EMAIL_DELIVERY_DATE
See Also:
Constant Field Values

ENABLE_EMAIL_REMINDER_LIFECYCLE

static final String ENABLE_EMAIL_REMINDER_LIFECYCLE
See Also:
Constant Field Values

ENABLE_XML_PIPELINE_LIFECYCLE

static final String ENABLE_XML_PIPELINE_LIFECYCLE
See Also:
Constant Field Values

OUT_BOX_MODE

static final String OUT_BOX_MODE
See Also:
Constant Field Values
Method Detail

parseConfig

void parseConfig()
                 throws IOException
Throws:
IOException

getDailyEmailFirstDeliveryDate

String getDailyEmailFirstDeliveryDate()

getWeeklyEmailFirstDeliveryDate

String getWeeklyEmailFirstDeliveryDate()

getBaseWebServiceURL

String getBaseWebServiceURL()

getBaseWebServiceWsdlPath

String getBaseWebServiceWsdlPath()

getClientWSDLFullPathAndFileName

String getClientWSDLFullPathAndFileName()

getWebServicesConnectRetry

String getWebServicesConnectRetry()

getKEWBaseURL

String getKEWBaseURL()
Returns:
the base URL for KEW

getKIMBaseURL

String getKIMBaseURL()
Returns:
the base URL for KIM

getKRBaseURL

String getKRBaseURL()
Returns:
the base URL for KRice

getKENBaseURL

String getKENBaseURL()
Returns:
the base URL for KEN

getLog4jFileLocation

String getLog4jFileLocation()

getLog4jReloadInterval

String getLog4jReloadInterval()

getTransactionTimeout

String getTransactionTimeout()

getEmailConfigurationPath

String getEmailConfigurationPath()

getRiceVersion

String getRiceVersion()

getApplicationName

String getApplicationName()

getApplicationVersion

String getApplicationVersion()

getEnvironment

String getEnvironment()

getProductionEnvironmentCode

String getProductionEnvironmentCode()

getEDLConfigLocation

String getEDLConfigLocation()

getDefaultKewNoteClass

String getDefaultKewNoteClass()

getEmbeddedPluginLocation

String getEmbeddedPluginLocation()

getRefreshRate

Integer getRefreshRate()

getEndPointUrl

String getEndPointUrl()

getAlternateSpringFile

String getAlternateSpringFile()

getAlternateOJBFile

String getAlternateOJBFile()

getKeystoreAlias

String getKeystoreAlias()

getKeystorePassword

String getKeystorePassword()

getKeystoreFile

String getKeystoreFile()

getDocumentLockTimeout

String getDocumentLockTimeout()

getEmailReminderLifecycleEnabled

Boolean getEmailReminderLifecycleEnabled()

getXmlPipelineLifeCycleEnabled

Boolean getXmlPipelineLifeCycleEnabled()

getDevMode

Boolean getDevMode()

getBatchMode

Boolean getBatchMode()

getOutBoxOn

Boolean getOutBoxOn()

isProductionEnvironment

boolean isProductionEnvironment()
Returns whether this Config object defines a production environment


getProperties

Properties getProperties()
Returns properties explicitly configured in this Config

Returns:
properties explicitly configured in this Config

getProperty

String getProperty(String key)

getBooleanProperty

boolean getBooleanProperty(String key,
                           boolean defaultValue)

getBooleanProperty

Boolean getBooleanProperty(String key)

getNumericProperty

long getNumericProperty(String key,
                        long defaultValue)

getNumericProperty

Long getNumericProperty(String key)

getPropertiesWithPrefix

Map<String,String> getPropertiesWithPrefix(String prefix,
                                           boolean stripPrefix)

getObjects

Map<String,Object> getObjects()

getObject

Object getObject(String key)

putConfig

void putConfig(Config config)
This method takes a config object and merges it with the current object.

Parameters:
config -

putProperties

void putProperties(Properties properties)

putProperty

void putProperty(String key,
                 String value)

removeProperty

void removeProperty(String key)

putObjects

void putObjects(Map<String,Object> objects)

putObject

void putObject(String key,
               Object value)

removeObject

void removeObject(String key)


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