Package org.apache.ofbiz.service.config

Class ServiceConfigUtil

java.lang.Object

org.apache.ofbiz.service.config.ServiceConfigUtil

public final class ServiceConfigUtil
extends Object

A ServiceConfig factory and related utility methods.

The ServiceConfig instance models the serviceengine.xml file and the instance is kept in the "service.ServiceConfig" cache. Clearing the cache will reload the service configuration file. Client code that depends on the serviceengine.xml file can be notified when the file is reloaded by implementing ServiceConfigListener and registering itself using the registerServiceConfigListener(ServiceConfigListener) method.

Method Summary

Modifier and Type	Method	Description
static String	getEngine()
static String	getEngineParameter(String engineName, String parameterName)	Returns the specified parameter value from the specified engine, or null if the engine or parameter are not found.
static ServiceConfig	getServiceConfig()	Returns the ServiceConfig instance.
static ServiceEngine	getServiceEngine()	Returns the default service engine configuration (named "default").
static ServiceEngine	getServiceEngine(String name)	Returns the specified ServiceEngine configuration instance, or null if the configuration does not exist.
static String	getServiceEngineXmlFileName()
static void	registerServiceConfigListener(ServiceConfigListener listener)	Register a ServiceConfigListener instance.

Methods inherited from class java.lang.Object

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

Method Details

getEngineParameter

public static String getEngineParameter(String engineName,
 String parameterName)
                                 throws GenericConfigException

Returns the specified parameter value from the specified engine, or null if the engine or parameter are not found.

Parameters:

engineName -

parameterName -

Returns:

Throws:

GenericConfigException

getServiceConfig

public static ServiceConfig getServiceConfig()
                                      throws GenericConfigException

Returns the ServiceConfig instance.

Throws:

GenericConfigException

getServiceEngine

public static ServiceEngine getServiceEngine()
                                      throws GenericConfigException

Returns the default service engine configuration (named "default").

Throws:

GenericConfigException

getServiceEngine

public static ServiceEngine getServiceEngine(String name)
                                      throws GenericConfigException

Returns the specified ServiceEngine configuration instance, or null if the configuration does not exist.

Throws:

GenericConfigException

registerServiceConfigListener

public static void registerServiceConfigListener(ServiceConfigListener listener)

Register a ServiceConfigListener instance. The instance will be notified when the serviceengine.xml file is reloaded.

Parameters:

listener -

getEngine

public static String getEngine()

getServiceEngineXmlFileName

public static String getServiceEngineXmlFileName()