com.konakartadmin.utils

Class ModuleUtils

java.lang.Object

com.konakartadmin.utils.ModuleUtils

Direct Known Subclasses:

InstallDefaultModule, RemoveModule

public class ModuleUtils
extends java.lang.Object

Module Utils

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	adminEngineClassname
private static boolean	categoriesShared
private static KKConfiguration[]	configs
private static boolean	customersShared
private static KKAdminIf	eng
private static int	engineMode
static org.apache.commons.logging.Log	log logger
static java.lang.String	MODULE_TYPE_ORDERTOTAL Module Type
static java.lang.String	MODULE_TYPE_OTHER Module Type
static java.lang.String	MODULE_TYPE_PAYMENT Module Type
static java.lang.String	MODULE_TYPE_SHIPPING Module Type
private static java.lang.String	moduleName
private static java.lang.String	moduleType
private static java.lang.String	password
private static boolean	productsShared
private static java.lang.String	propsFileName
private static java.lang.String	sessionId
private static java.lang.String	storeId
private static java.lang.String	username

Constructor Summary

Constructors

Constructor and Description
ModuleUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAdminEngineClassname()
protected static KKAdminIf	getAnEng()
protected static java.lang.String	getCodeForModuleName()
static KKConfiguration[]	getConfigs()
static KKAdminIf	getEng()
static int	getEngineMode()
protected static java.lang.String	getImplementationForModuleName()
protected static KKConfiguration	getInstalled()
static java.lang.String	getModuleName()
static java.lang.String	getModuleType()
protected static OrderTotalModule	getOrderTotalModuleForName(java.lang.String moduleName) Called to instantiate an Admin Order Total module.
protected static OtherModule	getOtherModuleForName(java.lang.String moduleName) Called to instantiate an Admin Other module.
static java.lang.String	getPassword()
protected static PaymentModule	getPaymentModuleForName(java.lang.String moduleNameIn) Called to instantiate an Admin payment module.
static java.lang.String	getSessionId()
protected static ShippingModule	getShippingModuleForName(java.lang.String moduleName) Called to instantiate an Admin shipping module.
static java.lang.String	getStoreId()
static java.lang.String	getUsername()
static boolean	isCategoriesShared()
static boolean	isCustomersShared()
static boolean	isMultiStoreSingleDB()
static boolean	isProductsShared()
protected static java.lang.String	moduleClassForModuleName(java.lang.String moduleName)
static int	processArgs(java.lang.String[] args, java.lang.String usage) Install the module
static void	setAdminEngineClassname(java.lang.String adminEngineClassname)
static void	setCategoriesShared(boolean categoriesShared)
static void	setConfigs(KKConfiguration[] configs)
static void	setCustomersShared(boolean customersShared)
static void	setEng(KKAdminIf eng)
static void	setEngineMode(int engineMode)
static void	setModuleName(java.lang.String module)
static void	setModuleType(java.lang.String moduleType)
static void	setPassword(java.lang.String password)
static void	setProductsShared(boolean productsShared)
static void	setSessionId(java.lang.String sessionId)
static void	setStoreId(java.lang.String storeId)
static void	setUsername(java.lang.String username)

Methods inherited from class java.lang.Object

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

Field Detail

log

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

logger

MODULE_TYPE_PAYMENT

public static final java.lang.String MODULE_TYPE_PAYMENT

Module Type

See Also:

Constant Field Values

MODULE_TYPE_SHIPPING

public static final java.lang.String MODULE_TYPE_SHIPPING

Module Type

See Also:

Constant Field Values

MODULE_TYPE_ORDERTOTAL

public static final java.lang.String MODULE_TYPE_ORDERTOTAL

Module Type

See Also:

Constant Field Values

MODULE_TYPE_OTHER

public static final java.lang.String MODULE_TYPE_OTHER

Module Type

See Also:

Constant Field Values

propsFileName

private static java.lang.String propsFileName

storeId

private static java.lang.String storeId

username

private static java.lang.String username

password

private static java.lang.String password

sessionId

private static java.lang.String sessionId

adminEngineClassname

private static java.lang.String adminEngineClassname

moduleName

private static java.lang.String moduleName

moduleType

private static java.lang.String moduleType

engineMode

private static int engineMode

customersShared

private static boolean customersShared

productsShared

private static boolean productsShared

categoriesShared

private static boolean categoriesShared

eng

private static KKAdminIf eng

configs

private static KKConfiguration[] configs

Constructor Detail

ModuleUtils

public ModuleUtils()

Method Detail

processArgs

public static int processArgs(java.lang.String[] args,
                              java.lang.String usage)

Install the module

Parameters:

args - command line arguments

usage - the usage statement

Returns:

return 0 if successful otherwise a number indictaing the error

getCodeForModuleName

protected static java.lang.String getCodeForModuleName()
                                                throws KKAdminException

Throws:

KKAdminException

getImplementationForModuleName

protected static java.lang.String getImplementationForModuleName()
                                                          throws KKAdminException

Throws:

KKAdminException

moduleClassForModuleName

protected static java.lang.String moduleClassForModuleName(java.lang.String moduleName)

getShippingModuleForName

protected static ShippingModule getShippingModuleForName(java.lang.String moduleName)
                                                  throws KKAdminException

Called to instantiate an Admin shipping module.

Parameters:

moduleName - the moduleName

Returns:

Returns an instantiated Admin Shipping Module

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getPaymentModuleForName

protected static PaymentModule getPaymentModuleForName(java.lang.String moduleNameIn)
                                                throws KKAdminException

Called to instantiate an Admin payment module.

Parameters:

moduleNameIn - the moduleNameIn

Returns:

Returns an instantiated Admin Payment Module

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getOrderTotalModuleForName

protected static OrderTotalModule getOrderTotalModuleForName(java.lang.String moduleName)
                                                      throws KKAdminException

Called to instantiate an Admin Order Total module.

Parameters:

moduleName - the moduleName

Returns:

Returns an instantiated Admin Order Total Module

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getOtherModuleForName

protected static OtherModule getOtherModuleForName(java.lang.String moduleName)
                                            throws KKAdminException

Called to instantiate an Admin Other module.

Parameters:

moduleName - the moduleName

Returns:

Returns an instantiated Admin Other Module

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getInstalled

protected static KKConfiguration getInstalled()
                                       throws KKAdminException

Throws:

KKAdminException

getAnEng

protected static KKAdminIf getAnEng()
                             throws KKAdminException,
                                    java.lang.IllegalArgumentException,
                                    java.lang.InstantiationException,
                                    java.lang.IllegalAccessException,
                                    java.lang.ClassNotFoundException,
                                    java.lang.reflect.InvocationTargetException

Throws:

KKAdminException

java.lang.IllegalArgumentException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.ClassNotFoundException

java.lang.reflect.InvocationTargetException

isMultiStoreSingleDB

public static boolean isMultiStoreSingleDB()

Returns:

true if the mode is multi-store single DB

isCustomersShared

public static boolean isCustomersShared()

Returns:

the customersShared

setCustomersShared

public static void setCustomersShared(boolean customersShared)

Parameters:

customersShared - the customersShared to set

isProductsShared

public static boolean isProductsShared()

Returns:

the productsShared

setProductsShared

public static void setProductsShared(boolean productsShared)

Parameters:

productsShared - the productsShared to set

getStoreId

public static java.lang.String getStoreId()

Returns:

the storeId

setStoreId

public static void setStoreId(java.lang.String storeId)

Parameters:

storeId - the storeId to set

getUsername

public static java.lang.String getUsername()

Returns:

the username

setUsername

public static void setUsername(java.lang.String username)

Parameters:

username - the username to set

getPassword

public static java.lang.String getPassword()

Returns:

the password

getEngineMode

public static int getEngineMode()

Returns:

the engineMode

setEngineMode

public static void setEngineMode(int engineMode)

Parameters:

engineMode - the engineMode to set

getAdminEngineClassname

public static java.lang.String getAdminEngineClassname()

Returns:

the adminEngineClassname

setAdminEngineClassname

public static void setAdminEngineClassname(java.lang.String adminEngineClassname)

Parameters:

adminEngineClassname - the adminEngineClassname to set

getEng

public static KKAdminIf getEng()

Returns:

the eng

setEng

public static void setEng(KKAdminIf eng)

Parameters:

eng - the eng to set

isCategoriesShared

public static boolean isCategoriesShared()

Returns:

the categoriesShared

setCategoriesShared

public static void setCategoriesShared(boolean categoriesShared)

Parameters:

categoriesShared - the categoriesShared to set

setPassword

public static void setPassword(java.lang.String password)

Parameters:

password - the password to set

getConfigs

public static KKConfiguration[] getConfigs()

Returns:

the configs

setConfigs

public static void setConfigs(KKConfiguration[] configs)

Parameters:

configs - the configs to set

getModuleName

public static java.lang.String getModuleName()

Returns:

the module

setModuleName

public static void setModuleName(java.lang.String module)

Parameters:

module - the module to set

getModuleType

public static java.lang.String getModuleType()

Returns:

the moduleType

setModuleType

public static void setModuleType(java.lang.String moduleType)

Parameters:

moduleType - the moduleType to set

getSessionId

public static java.lang.String getSessionId()

Returns:

the sessionId

setSessionId

public static void setSessionId(java.lang.String sessionId)

Parameters:

sessionId - the sessionId to set