com.konakartadmin.bl

Class AdminAppMgr

java.lang.Object

com.konakartadmin.bl.AdminAppMgr

All Implemented Interfaces:

AdminAppMgrIf

public class AdminAppMgr
extends java.lang.Object
implements AdminAppMgrIf

The AdminAppMgr - a collection of utilities the Admin Application

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.commons.configuration2.Configuration	adminAppConfigs Admin App Configuration Map - the keys and values from konakartadmin_gwt.properties
protected static org.apache.commons.logging.Log	log the log
private static java.lang.String	mutex

Constructor Summary

Constructors

Constructor and Description
AdminAppMgr() Empty constructor

Method Summary

Modifier and Type	Method and Description
private org.apache.commons.configuration2.Configuration	getAdminAppConfigs()
private java.lang.String	getAdminAppPropertiesFileName()
java.lang.String	getAdminAppProperty(java.lang.String key, java.lang.String def) Get the Admin App property value for the specified key.
boolean	getAdminAppPropertyAsBoolean(java.lang.String key, boolean def) Get the Admin App property value as a boolean for the specified key.
int	getAdminAppPropertyAsInt(java.lang.String key, int def) Get the Admin App property value as in int for the specified key.
void	refreshCache() Refresh the Admin App Manager's cached data
void	setAdminAppConfigs(org.apache.commons.configuration2.Configuration newAdminAppConfigs) Set this to null to refresh the cache next time it's called

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

adminAppConfigs

private static org.apache.commons.configuration2.Configuration adminAppConfigs

Admin App Configuration Map - the keys and values from konakartadmin_gwt.properties

mutex

private static java.lang.String mutex

Constructor Detail

AdminAppMgr

public AdminAppMgr()

Empty constructor

Method Detail

getAdminAppProperty

public java.lang.String getAdminAppProperty(java.lang.String key,
                                            java.lang.String def)
                                     throws KKAdminException

Get the Admin App property value for the specified key. If it isn't found use the default value.

Specified by:

getAdminAppProperty in interface AdminAppMgrIf

Parameters:

key - the key

def - the def

Returns:

Get the Admin App property value for the specified key. If it isn't found use the default value.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getAdminAppPropertyAsInt

public int getAdminAppPropertyAsInt(java.lang.String key,
                                    int def)
                             throws KKAdminException

Get the Admin App property value as in int for the specified key. If it isn't found use the default value.

Specified by:

getAdminAppPropertyAsInt in interface AdminAppMgrIf

Parameters:

key - the key

def - the def

Returns:

Get the Admin App property value as in int for the specified key. If it isn't found use the default value.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getAdminAppPropertyAsBoolean

public boolean getAdminAppPropertyAsBoolean(java.lang.String key,
                                            boolean def)
                                     throws KKAdminException

Get the Admin App property value as a boolean for the specified key. If it isn't found use the default value.

Parameters:

key - the key

def - the def

Returns:

Get the Admin App property value as a boolean for the specified key. If it isn't found use the default value.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

refreshCache

public void refreshCache()
                  throws KKAdminException

Description copied from interface: AdminAppMgrIf

Refresh the Admin App Manager's cached data

Specified by:

refreshCache in interface AdminAppMgrIf

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine for unexpected problems such as not being able to locate or read properties files

getAdminAppConfigs

private org.apache.commons.configuration2.Configuration getAdminAppConfigs()
                                                                    throws KKAdminException

Returns:

the adminAppConfigs

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

setAdminAppConfigs

public void setAdminAppConfigs(org.apache.commons.configuration2.Configuration newAdminAppConfigs)

Set this to null to refresh the cache next time it's called

Parameters:

newAdminAppConfigs - the adminAppConfigs to set

getAdminAppPropertiesFileName

private java.lang.String getAdminAppPropertiesFileName()
                                                throws com.konakart.app.KKException

Throws:

com.konakart.app.KKException