com.konakartadmin.rmi

Class KKRMIAdminEngBase

java.lang.Object

com.konakartadmin.rmi.KKRMIAdminEngBase

public class KKRMIAdminEngBase
extends java.lang.Object

KonaKart RMI Client-side Engine Base for the Admin Engine

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.commons.configuration2.Configuration	allConfig Used to read all of the properties from the properties file
private AdminEngineConfig	clientSideEngConf Configuration parameter passed when the engine is instantiated
private org.apache.commons.configuration2.Configuration	konakartConfig Used to read the KonaKart properties from the properties file
protected static org.apache.commons.logging.Log	log
private com.konakartadmin.rmi.KKRMIAdminEngServerIf	rmiEngine This is our RMI Server reference
private java.lang.String	rmiHost
private int	rmiPort
private java.lang.String	storeId
private boolean	successfullyInitialised

Constructor Summary

Constructors

Constructor and Description
KKRMIAdminEngBase(AdminEngineConfig engConfig) Constructor with an AdminEngineConfig object.

Method Summary

Modifier and Type	Method and Description
AdminEngineConfig	getClientSideEngConf()
protected int	getCodeFromException(java.lang.Throwable cause) Return the exception code on the Exception
com.konakartadmin.rmi.KKRMIAdminEngServerIf	getRmiEngine()
java.lang.String	getRmiHost()
int	getRmiPort()
java.lang.String	getStoreId()
protected KKAdminException	handleThrowable(java.lang.Throwable e, java.lang.String methodName) Handles the exception for all methods.
void	init()
boolean	isSuccessfullyInitialised()
void	setClientSideEngConf(AdminEngineConfig clientSideEngConf)
void	setRmiEngine(com.konakartadmin.rmi.KKRMIAdminEngServerIf rmiEngine)
void	setRmiHost(java.lang.String rmiHost)
void	setRmiPort(int rmiPort)
void	setStoreId(java.lang.String storeId)
void	setSuccessfullyInitialised(boolean successfullyInitialised)
protected void	setupKonaKartConfig()

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

allConfig

private org.apache.commons.configuration2.Configuration allConfig

Used to read all of the properties from the properties file

konakartConfig

private org.apache.commons.configuration2.Configuration konakartConfig

Used to read the KonaKart properties from the properties file

rmiPort

private int rmiPort

rmiHost

private java.lang.String rmiHost

successfullyInitialised

private boolean successfullyInitialised

storeId

private java.lang.String storeId

rmiEngine

private com.konakartadmin.rmi.KKRMIAdminEngServerIf rmiEngine

This is our RMI Server reference

clientSideEngConf

private AdminEngineConfig clientSideEngConf

Configuration parameter passed when the engine is instantiated

Constructor Detail

KKRMIAdminEngBase

public KKRMIAdminEngBase(AdminEngineConfig engConfig)
                  throws KKAdminException

Constructor with an AdminEngineConfig object.

Parameters:

engConfig - the engConfig

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

Method Detail

init

public void init()
          throws KKAdminException

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

setupKonaKartConfig

protected void setupKonaKartConfig()
                            throws java.lang.Exception

Throws:

java.lang.Exception

handleThrowable

protected KKAdminException handleThrowable(java.lang.Throwable e,
                                           java.lang.String methodName)

Handles the exception for all methods. If the exception is a RemoteException or ServerException and has a cause exception, then we add the cause exception instead of the RemoteException, although we do save the message of the RemoteException or SrverException.

We do this so that the receiver can detect the cause exception and act on it. Otherwise it gets lost.

Parameters:

e - the e

methodName - the methodName

Returns:

Returns an exception

getCodeFromException

protected int getCodeFromException(java.lang.Throwable cause)

Return the exception code on the Exception

Parameters:

cause - the Throwable

Returns:

the integer exception code

getRmiPort

public int getRmiPort()

Returns:

the rmiPort

setRmiPort

public void setRmiPort(int rmiPort)

Parameters:

rmiPort - the rmiPort to set

getRmiHost

public java.lang.String getRmiHost()

Returns:

the rmiHost

setRmiHost

public void setRmiHost(java.lang.String rmiHost)

Parameters:

rmiHost - the rmiHost to set

isSuccessfullyInitialised

public boolean isSuccessfullyInitialised()

Returns:

the successfullyInitialised

setSuccessfullyInitialised

public void setSuccessfullyInitialised(boolean successfullyInitialised)

Parameters:

successfullyInitialised - the successfullyInitialised to set

getStoreId

public java.lang.String getStoreId()

Returns:

the storeId

setStoreId

public void setStoreId(java.lang.String storeId)

Parameters:

storeId - the storeId to set

getRmiEngine

public com.konakartadmin.rmi.KKRMIAdminEngServerIf getRmiEngine()
                                                         throws KKAdminException

Returns:

the rmiEngine

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

setRmiEngine

public void setRmiEngine(com.konakartadmin.rmi.KKRMIAdminEngServerIf rmiEngine)

Parameters:

rmiEngine - the rmiEngine to set

getClientSideEngConf

public AdminEngineConfig getClientSideEngConf()

Returns:

the clientSideEngConf

setClientSideEngConf

public void setClientSideEngConf(AdminEngineConfig clientSideEngConf)

Parameters:

clientSideEngConf - the clientSideEngConf to set