org.bedework.util.jmx

Class ConfBase<T extends ConfigBase>

java.lang.Object

org.bedework.util.misc.Logged

org.bedework.util.jmx.ConfBase<T>

Type Parameters:

T -

All Implemented Interfaces:

BaseMBean, ConfBaseMBean

public abstract class ConfBase<T extends ConfigBase>
extends Logged
implements ConfBaseMBean

A configuration has a name and a location. The location can be specified in a number of ways:

• An absolute path to the directory containing the config
• Through definitions in a property file

The property file approach uses the system property
org.bedework.config.pfile
which provides the absolute path to a property file which may be fetched via http or read as a local file.

This file has properties defined for each configuration and some global to all

• org.bedework.config.base if provided defines a base for all configs which will be prepended
• One or more config pathsThe name of each is specified by the configPname field for the mbean. If a config base is provided this will be appended to that to give a absolute path

An example file may look like:

 org.bedework.config.base=file://$JBOSS_SERVER_DIR/conf/bedework/

 #         Calendar clients config dir
 org.bedework.clients.confuri=client-configs

 #         Calendar core config dir
 org.bedework.bwcore.confuri=bwcore

 #         Calendar engine config dir
 org.bedework.bwengine.confuri=bwengine

 #         carddav conf dir
 org.bedework.carddav.confuri=carddavConfig

 #         hosts conf dir
 org.bedework.hosts.confuri=hosts

 #         selfreg conf dir
 org.bedework.selfreg.confuri=selfreg

 #         synch conf dir
 org.bedework.synch.confuri=synch

 #         tzsvr conf dir
 org.bedework.tzs.confuri=tzsvr

 

Each may be augmented by providing a path suffix - used to add additional path elements to the base path.

Author:

douglm

Field Summary

Fields

Modifier and Type	Field and Description
protected T	cfg
static String	statusDone
static String	statusFailed
static String	statusRunning
static String	statusStopped
static String	statusTimedout
static String	statusUnknown

Fields inherited from class org.bedework.util.misc.Logged

auditLoggerName, debug, errorLoggerName, metricsLoggerName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfBase() At least setServiceName MUST be called
protected	ConfBase(String serviceName)

Method Summary

Modifier and Type	Method and Description
protected ObjectName	createObjectName(String serviceType, String name)
T	getConfig()
protected T	getConfigInfo(Class<T> cl)
protected T	getConfigInfo(ConfigurationStore cfs, String configName, Class<T> cl)
protected T	getConfigInfo(String configName, Class<T> cl)
String	getConfigName()
String	getConfigPname()
String	getConfigUri()
static ManagementContext	getManagementContext()
String	getPathSuffix()
protected Set<ObjectName>	getRegisteredMBeans()
String	getServiceName()
protected ObjectName	getServiceObjectName()
String	getStatus()
ConfigurationStore	getStore() Get a ConfigurationStore based on the uri or property value.
boolean	isRunning() Lifecycle
abstract String	loadConfig() (Re)load the configuration
protected String	loadConfig(Class<T> cl)
protected String	loadOnlyConfig(Class<T> cl) Load the configuration if we only expect one and we don't care or know what it's called.
protected static Object	makeObject(String className)
protected void	register(ObjectName key, Object bean)
protected void	register(String serviceType, String name, Object view)
String	saveConfig() Save the current configuration
void	setConfigName(String val)
void	setConfigPname(String val) Specify a system property giving the absolute path to the configuration directory.
void	setConfigUri(String val) Specify the absolute path to the configuration directory.
void	setPathSuffix(String val) Specify a suffix to the path to the configuration directory.
void	setServiceName(String val)
void	setStatus(String val)
void	setStore(ConfigurationStore val) Set a ConfigurationStore
void	start() Lifecycle
void	stop() Lifecycle
protected void	unregister(ObjectName key)
protected void	unregister(String serviceType, String name)

Methods inherited from class org.bedework.util.misc.Logged

audit, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, getAuditLoggerIfEnabled, getErrorLoggerIfEnabled, getLogger, getLogger, getMetricsLoggerIfEnabled, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsLoggerEnabled, metrics, warn

Methods inherited from class java.lang.Object

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

Field Detail

statusDone

public static final String statusDone

See Also:

Constant Field Values

statusFailed

public static final String statusFailed

See Also:

Constant Field Values

statusRunning

public static final String statusRunning

See Also:

Constant Field Values

statusStopped

public static final String statusStopped

See Also:

Constant Field Values

statusTimedout

public static final String statusTimedout

See Also:

Constant Field Values

statusUnknown

public static final String statusUnknown

See Also:

Constant Field Values

cfg

protected T extends ConfigBase cfg

Constructor Detail

ConfBase

protected ConfBase()

At least setServiceName MUST be called

ConfBase

protected ConfBase(String serviceName)

Method Detail

setServiceName

public void setServiceName(String val)

Parameters:

val - IDENTICAL to that defined for service.

getServiceName

public String getServiceName()

Specified by:

getServiceName in interface BaseMBean

Returns:

name defined for service.

setStatus

public void setStatus(String val)

Parameters:

val - a status.

getStatus

public String getStatus()

Specified by:

getStatus in interface BaseMBean

Returns:

"Done", "Failed", "Running", "Stopped"

start

public void start()

Description copied from interface: BaseMBean

Lifecycle

Specified by:

start in interface BaseMBean

stop

public void stop()

Description copied from interface: BaseMBean

Lifecycle

Specified by:

stop in interface BaseMBean

isRunning

public boolean isRunning()

Description copied from interface: BaseMBean

Lifecycle

Specified by:

isRunning in interface BaseMBean

Returns:

true if service running

setConfigUri

public void setConfigUri(String val)

Specify the absolute path to the configuration directory.

Parameters:

val -

getConfigUri

public String getConfigUri()

Returns:

String path to configs

setConfigPname

public void setConfigPname(String val)

Specify a system property giving the absolute path to the configuration directory.

Parameters:

val -

getConfigPname

public String getConfigPname()

Returns:

String name of system property

setPathSuffix

public void setPathSuffix(String val)

Specify a suffix to the path to the configuration directory.

Parameters:

val -

getPathSuffix

public String getPathSuffix()

Returns:

String path suffix to configs

setStore

public void setStore(ConfigurationStore val)

Set a ConfigurationStore

Parameters:

val -

getStore

public ConfigurationStore getStore()
                            throws ConfigException

Get a ConfigurationStore based on the uri or property value.

Returns:

store

Throws:

ConfigException

getConfig

public T getConfig()

Returns:

the object we are managing

loadConfig

public abstract String loadConfig()

(Re)load the configuration

Returns:

status

getRegisteredMBeans

protected Set<ObjectName> getRegisteredMBeans()

setConfigName

public void setConfigName(String val)

Specified by:

setConfigName in interface ConfBaseMBean

getConfigName

public String getConfigName()

Specified by:

getConfigName in interface ConfBaseMBean

Returns:

String application name

saveConfig

public String saveConfig()

Description copied from interface: ConfBaseMBean

Save the current configuration

Specified by:

saveConfig in interface ConfBaseMBean

Returns:

completion message

register

protected void register(String serviceType,
                        String name,
                        Object view)

unregister

protected void unregister(String serviceType,
                          String name)

getServiceObjectName

protected ObjectName getServiceObjectName()
                                   throws MalformedObjectNameException

Throws:

MalformedObjectNameException

createObjectName

protected ObjectName createObjectName(String serviceType,
                                      String name)
                               throws MalformedObjectNameException

Throws:

MalformedObjectNameException

getConfigInfo

protected T getConfigInfo(Class<T> cl)
                   throws ConfigException

Returns:

config identified by current config name

Throws:

ConfigException

getConfigInfo

protected T getConfigInfo(String configName,
                          Class<T> cl)
                   throws ConfigException

Returns:

current state of config

Throws:

ConfigException

getConfigInfo

protected T getConfigInfo(ConfigurationStore cfs,
                          String configName,
                          Class<T> cl)
                   throws ConfigException

Throws:

ConfigException

loadConfig

protected String loadConfig(Class<T> cl)

Parameters:

cl -

Returns:

config identified by current config name

loadOnlyConfig

protected String loadOnlyConfig(Class<T> cl)

Load the configuration if we only expect one and we don't care or know what it's called.

Parameters:

cl -

Returns:

null for success or an error message (logged already)

register

protected void register(ObjectName key,
                        Object bean)
                 throws Exception

Parameters:

key -

bean -

Throws:

Exception

unregister

protected void unregister(ObjectName key)
                   throws Exception

Parameters:

key -

Throws:

Exception

getManagementContext

public static ManagementContext getManagementContext()

Returns:

the management context.

makeObject

protected static Object makeObject(String className)