KKJSONAdminEngBase (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakartadmin.json.KKJSONAdminEngBase

public class KKJSONAdminEngBase
extends java.lang.Object

KonaKart JSON Client-side Engine Base for the Admin Engine

Field Summary

Fields
Modifier and Type	Field and Description
`private AdminEngineConfig`	`adminEngConf` Configuration parameter passed when the engine is instantiated
`private static org.apache.commons.configuration2.PropertiesConfiguration`	`allConfig` Used to read all of the properties from the properties file
`private int`	`CONNECT_TIMEOUT_DEFAULT`
`private int`	`connectTimeout`
`private boolean`	`generateMatchIds`
`private java.net.URL`	`jsonURL`
`private static org.apache.commons.configuration2.Configuration`	`konakartConfig` Used to read the KonaKart properties from the properties file
`private static org.apache.commons.logging.Log`	`log`
`protected static com.fasterxml.jackson.databind.ObjectMapper`	`mapper` JSON Data Mapping Object
`private long`	`nextId`
`private int`	`READ_TIMEOUT_DEFAULT`
`private int`	`readTimeout`
`private java.lang.String`	`storeId`
`private boolean`	`successfullyInitialised`

Constructor Summary

Constructors
Constructor and Description

KKJSONAdminEngBase(AdminEngineConfig engConfIn)
Constructor with an AdminEngineConfig object.

Constructors
Constructor and Description
`KKJSONAdminEngBase(AdminEngineConfig engConfIn)` Constructor with an AdminEngineConfig object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkForException(KKJSONAdmin_ResponseIf response)`
`AdminEngineConfig`	`getAdminEngConf()`
`int`	`getConnectTimeout()`
`java.net.URL`	`getJsonURL()`
`static com.fasterxml.jackson.databind.ObjectMapper`	`getMapper()`
`protected java.lang.String`	`getNextId()` Return the next number in a sequence for matching requests and responses
`int`	`getReadTimeout()`
`java.lang.String`	`getStoreId()`
`java.lang.String`	`getStoreIdForRequest()` Only return the storeId if we're in a multi-store environment
`protected static KKAdminException`	`handleThrowable(java.lang.Throwable e, java.lang.String methodName)` Handles the exception for all methods.
`void`	`init()`
`boolean`	`isGenerateMatchIds()`
`boolean`	`isSuccessfullyInitialised()`
`java.lang.String`	`postRequest(java.lang.String request)`
`static java.lang.String`	`prettyJson(java.lang.String uglyJsonString)` To pretty-print a JSON String
`void`	`setConnectTimeout(int connectTimeout)`
`void`	`setEngConf(AdminEngineConfig adminEngConf)`
`void`	`setGenerateMatchIds(boolean generateMatchIds)`
`void`	`setJsonURL(java.net.URL jsonURL)`
`void`	`setReadTimeout(int readTimeout)`
`void`	`setStoreId(java.lang.String storeId)`
`void`	`setSuccessfullyInitialised(boolean successfullyInitialised)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log
```
private static org.apache.commons.logging.Log log
```
  - allConfig
```
private static org.apache.commons.configuration2.PropertiesConfiguration allConfig
```
    Used to read all of the properties from the properties file
  - konakartConfig
```
private static org.apache.commons.configuration2.Configuration konakartConfig
```
    Used to read the KonaKart properties from the properties file
  - successfullyInitialised
```
private boolean successfullyInitialised
```
  - storeId
```
private java.lang.String storeId
```
  - adminEngConf
```
private AdminEngineConfig adminEngConf
```
    Configuration parameter passed when the engine is instantiated
  - jsonURL
```
private java.net.URL jsonURL
```
  - nextId
```
private long nextId
```
  - generateMatchIds
```
private boolean generateMatchIds
```
  - CONNECT_TIMEOUT_DEFAULT
```
private final int CONNECT_TIMEOUT_DEFAULT
```
    See Also:
    
    Constant Field Values
  - READ_TIMEOUT_DEFAULT
```
private final int READ_TIMEOUT_DEFAULT
```
    See Also:
    
    Constant Field Values
  - connectTimeout
```
private int connectTimeout
```
  - readTimeout
```
private int readTimeout
```
  - mapper
```
protected static com.fasterxml.jackson.databind.ObjectMapper mapper
```
    JSON Data Mapping Object
- Constructor Detail
  - KKJSONAdminEngBase
```
public KKJSONAdminEngBase(AdminEngineConfig engConfIn)
                   throws KKAdminException
```
    Constructor with an AdminEngineConfig object.
    
    Parameters:
    
    engConfIn - the engConfIn
    
    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
  - handleThrowable
```
protected static KKAdminException handleThrowable(java.lang.Throwable e,
                                                  java.lang.String methodName)
```
    Handles the exception for all methods. If the exception is a RemoteException or a 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 ServerException.
    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
  - checkForException
```
protected void checkForException(KKJSONAdmin_ResponseIf response)
                          throws KKAdminException
```
    Throws:
    
    KKAdminException
  - getNextId
```
protected java.lang.String getNextId()
```
    Return the next number in a sequence for matching requests and responses
    
    Returns:
    
    the next number as a String
  - postRequest
```
public java.lang.String postRequest(java.lang.String request)
                             throws java.lang.Exception
```
    Parameters:
    
    request - the request
    
    Returns:
    
    the response
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - prettyJson
```
public static java.lang.String prettyJson(java.lang.String uglyJsonString)
```
    To pretty-print a JSON String
    
    Parameters:
    
    uglyJsonString - the raw JSON String
    
    Returns:
    
    the pretty version of the input
  - isSuccessfullyInitialised
```
public boolean isSuccessfullyInitialised()
```
    Returns:
    
    the successfullyInitialised
  - setSuccessfullyInitialised
```
public void setSuccessfullyInitialised(boolean successfullyInitialised)
```
    Parameters:
    
    successfullyInitialised - the successfullyInitialised to set
  - getStoreIdForRequest
```
public java.lang.String getStoreIdForRequest()
```
    Only return the storeId if we're in a multi-store environment
    
    Returns:
    
    the storeId that will go on the request
  - getStoreId
```
public java.lang.String getStoreId()
```
    Returns:
    
    the storeId
  - setStoreId
```
public void setStoreId(java.lang.String storeId)
```
    Parameters:
    
    storeId - the storeId to set
  - getAdminEngConf
```
public AdminEngineConfig getAdminEngConf()
```
    Returns:
    
    the adminEngConf
  - setEngConf
```
public void setEngConf(AdminEngineConfig adminEngConf)
```
    Parameters:
    
    adminEngConf - the adminEngConf to set
  - getJsonURL
```
public java.net.URL getJsonURL()
```
    Returns:
    
    the jsonURL
  - setJsonURL
```
public void setJsonURL(java.net.URL jsonURL)
```
    Parameters:
    
    jsonURL - the jsonURL to set
  - isGenerateMatchIds
```
public boolean isGenerateMatchIds()
```
    Returns:
    
    the generateMatchIds
  - setGenerateMatchIds
```
public void setGenerateMatchIds(boolean generateMatchIds)
```
    Parameters:
    
    generateMatchIds - the generateMatchIds to set
  - getMapper
```
public static com.fasterxml.jackson.databind.ObjectMapper getMapper()
```
    Returns:
    
    the mapper
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Returns:
    
    the connectTimeout
  - setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
    Parameters:
    
    connectTimeout - the connectTimeout to set
  - getReadTimeout
```
public int getReadTimeout()
```
    Returns:
    
    the readTimeout
  - setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
    Parameters:
    
    readTimeout - the readTimeout to set

Class KKJSONAdminEngBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

allConfig

konakartConfig

successfullyInitialised

storeId

adminEngConf

jsonURL

nextId

generateMatchIds

CONNECT_TIMEOUT_DEFAULT

READ_TIMEOUT_DEFAULT

connectTimeout

readTimeout

mapper

Constructor Detail

KKJSONAdminEngBase

Method Detail

init

handleThrowable

checkForException

getNextId

postRequest

prettyJson

isSuccessfullyInitialised

setSuccessfullyInitialised

getStoreIdForRequest

getStoreId

setStoreId

getAdminEngConf

setEngConf

getJsonURL

setJsonURL

isGenerateMatchIds

setGenerateMatchIds

getMapper

getConnectTimeout

setConnectTimeout

getReadTimeout

setReadTimeout