com.konakart.bl

Class KKApiMgr

java.lang.Object

com.konakart.bl.KKApiMgr

All Implemented Interfaces:

KKApiMgrIf

public class KKApiMgr
extends java.lang.Object
implements KKApiMgrIf

Provides some hooks to supplement the execution of the APIs.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log

Constructor Summary

Constructors

Constructor and Description
KKApiMgr() Constructor

Method Summary

Modifier and Type	Method and Description
void	apiEnd(KKApiObjIf obj) Called at the end of the API call - just before returning
KKApiObjIf	apiStart(java.lang.String name) Called at the start of the API call
KKApiObjIf	apiStart(java.lang.String name, boolean debugOnly) Called at the start of the API call
java.lang.String	getElapsed(KKApiObjIf obj) Called at any time to get a String indicating the elapsed time.
long	getElapsedMS(KKApiObjIf obj) Called at any time to get a long indicating the elapsed time.
protected void	logApi(java.lang.String apiName, long start, long end)

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

Constructor Detail

KKApiMgr

public KKApiMgr()

Constructor

Method Detail

apiStart

public KKApiObjIf apiStart(java.lang.String name)

Description copied from interface: KKApiMgrIf

Called at the start of the API call

Specified by:

apiStart in interface KKApiMgrIf

Parameters:

name - the API name

Returns:

a KKApiObj object

apiStart

public KKApiObjIf apiStart(java.lang.String name,
                           boolean debugOnly)

Description copied from interface: KKApiMgrIf

Called at the start of the API call

Specified by:

apiStart in interface KKApiMgrIf

Parameters:

name - the API name

debugOnly - Only set up the KKApiObj if debug logging is enabled

Returns:

a KKApiObj object

apiEnd

public void apiEnd(KKApiObjIf obj)

Description copied from interface: KKApiMgrIf

Called at the end of the API call - just before returning

Specified by:

apiEnd in interface KKApiMgrIf

Parameters:

obj - the KKApiObjIf returned from the earlier apiStart call

logApi

protected void logApi(java.lang.String apiName,
                      long start,
                      long end)

getElapsed

public java.lang.String getElapsed(KKApiObjIf obj)

Description copied from interface: KKApiMgrIf

Called at any time to get a String indicating the elapsed time.

Specified by:

getElapsed in interface KKApiMgrIf

Parameters:

obj - the KKApiObjIf returned from the earlier apiStart call

Returns:

a String representing the elapsed time of the API call

getElapsedMS

public long getElapsedMS(KKApiObjIf obj)

Description copied from interface: KKApiMgrIf

Called at any time to get a long indicating the elapsed time.

Specified by:

getElapsedMS in interface KKApiMgrIf

Parameters:

obj - the KKApiObjIf returned from the earlier apiStart call

Returns:

a long representing the elapsed time of the API call in milliseconds