AdminEngineConfig (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakartadmin.app.AdminEngineConfig

All Implemented Interfaces:

java.lang.Cloneable
```
public class AdminEngineConfig
extends java.lang.Object
implements java.lang.Cloneable
```
Used to configure the KonaKart Admin engine client when it is instantiated.
Attributes required are dependent on the mode.
When creating engine clients for RMI and SOAP you can use the properties attribute to define your properties rather than referencing a properties file. The structure of the properties array is:
properties[0] = key 1
properties[1] = value 1
properties[2] = key 2
properties[3] = value 2
etc
If the properties array is non-null it will be used instead of the properties file (for the RMI and SOAP engines only). It may be useful to choose this way of constructing engine clients if you do not wish to use files to store the property definitions.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`categoriesShared`
`private boolean`	`customersShared`
`private java.lang.String`	`engineId` This is not designed to be set by developers.
`private java.lang.String`	`jaxwsClientFileName` The properties file used by a client-side of a SOAP/JAXWS engine
`private int`	`mode` Mode is SingleStore, MultiStore (Multi-DB) or MultiStore (Single-DB)
`static int`	`MODE_MULTI_STORE_NON_SHARED_DB` Constant for mode
`static int`	`MODE_MULTI_STORE_SHARED_DB` Constant for mode
`static int`	`MODE_SINGLE_STORE` Constant for mode
`private boolean`	`productsShared`
`private java.lang.String[]`	`properties`
`private java.lang.String`	`propertiesFileName` The properties file used by a server-side engine
`private java.lang.String`	`rmiClientFileName` The properties file used by a client-side of an RMI engine
`private java.lang.String`	`storeId`

Constructor Summary

Constructors
Constructor and Description

AdminEngineConfig()

Constructors
Constructor and Description
`AdminEngineConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdminEngineConfig`	`clone()` Clones the current object
`java.lang.String`	`getEngineId()`
`java.lang.String`	`getJaxwsClientFileName()` The name of the properties file for the KonaKart Admin JAXWS client (can be just the name of a file on the classpath or a full file path).
`int`	`getMode()` Used to configure the engine at startup.
`java.lang.String[]`	`getProperties()`
`java.lang.String`	`getPropertiesFileName()` The name of the properties file (can be just the name of a file on the classpath or a full file path).
`java.lang.String`	`getRmiClientFileName()` The properties file used by a client-side of an RMI engine
`java.lang.String`	`getStoreId()` Used in multi-store mode to configure the engine to use the correct store.
`boolean`	`isCategoriesShared()` Only relevant when in MODE_MULTI_STORE_SHARED_DB mode and products are shared.
`boolean`	`isCustomersShared()` Only relevant when in MODE_MULTI_STORE_SHARED_DB mode.
`boolean`	`isProductsShared()` Only relevant when in MODE_MULTI_STORE_SHARED_DB mode.
`void`	`setCategoriesShared(boolean categoriesShared)` Only relevant when in MODE_MULTI_STORE_SHARED_DB mode and products are shared.
`void`	`setCustomersShared(boolean customersShared)` Only relevant when in MODE_MULTI_STORE_SHARED_DB mode.
`void`	`setEngineId(java.lang.String engineId)`
`void`	`setJaxwsClientFileName(java.lang.String jaxwsClientFileName)` The name of the properties file for the KonaKart Admin JAXWS client (can be just the name of a file on the classpath or a full file path).
`void`	`setMode(int mode)` Used to configure the engine at startup.
`void`	`setProductsShared(boolean productsShared)` Only relevant when in MODE_MULTI_STORE_SHARED_DB mode.
`void`	`setProperties(java.lang.String[] properties)`
`void`	`setPropertiesFileName(java.lang.String propertiesFileName)` The name of the properties file (can be just the name of a file on the classpath or a full file path).
`void`	`setRmiClientFileName(java.lang.String rmiClientFileName)` The properties file used by a client-side of an RMI engine
`void`	`setStoreId(java.lang.String storeId)` Used in multi-store mode to configure the engine to use the correct store.
`java.lang.String`	`toString()`

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

- Field Detail
  - MODE_SINGLE_STORE
```
public static final int MODE_SINGLE_STORE
```
    Constant for mode
    
    See Also:
    
    Constant Field Values
  - MODE_MULTI_STORE_NON_SHARED_DB
```
public static final int MODE_MULTI_STORE_NON_SHARED_DB
```
    Constant for mode
    
    See Also:
    
    Constant Field Values
  - MODE_MULTI_STORE_SHARED_DB
```
public static final int MODE_MULTI_STORE_SHARED_DB
```
    Constant for mode
    
    See Also:
    
    Constant Field Values
  - storeId
```
private java.lang.String storeId
```
  - mode
```
private int mode
```
    Mode is SingleStore, MultiStore (Multi-DB) or MultiStore (Single-DB)
  - propertiesFileName
```
private java.lang.String propertiesFileName
```
    The properties file used by a server-side engine
  - jaxwsClientFileName
```
private java.lang.String jaxwsClientFileName
```
    The properties file used by a client-side of a SOAP/JAXWS engine
  - rmiClientFileName
```
private java.lang.String rmiClientFileName
```
    The properties file used by a client-side of an RMI engine
  - customersShared
```
private boolean customersShared
```
  - productsShared
```
private boolean productsShared
```
  - categoriesShared
```
private boolean categoriesShared
```
  - properties
```
private java.lang.String[] properties
```
  - engineId
```
private java.lang.String engineId
```
    This is not designed to be set by developers. Consider it to be read only
- Constructor Detail
  - AdminEngineConfig
```
public AdminEngineConfig()
```
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the AdminEngineConfig object.
  - clone
```
public AdminEngineConfig clone()
                        throws java.lang.CloneNotSupportedException
```
    Clones the current object
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    Returns a clone of the current object
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - getStoreId
```
public java.lang.String getStoreId()
```
    Used in multi-store mode to configure the engine to use the correct store.
    
    Returns:
    
    Returns the storeId.
  - setStoreId
```
public void setStoreId(java.lang.String storeId)
```
    Used in multi-store mode to configure the engine to use the correct store.
    
    Parameters:
    
    storeId - The storeId to set.
  - getMode
```
public int getMode()
```
    Used to configure the engine at startup. Valid values are:
    - EngineConfig.MODE_SINGLE_STORE
    - EngineConfig.MODE_MULTI_STORE_NON_SHARED_DB
    - EngineConfig.MODE_MULTI_STORE_SHARED_DB
    Returns:
    
    Returns the mode.
  - setMode
```
public void setMode(int mode)
```
    Used to configure the engine at startup. Valid values are:
    - EngineConfig.MODE_SINGLE_STORE
    - EngineConfig.MODE_MULTI_STORE_NON_SHARED_DB
    - EngineConfig.MODE_MULTI_STORE_SHARED_DB
    Parameters:
    
    mode - The mode to set.
  - getPropertiesFileName
```
public java.lang.String getPropertiesFileName()
```
    The name of the properties file (can be just the name of a file on the classpath or a full file path). The properties file used by a server-side engine
    
    Returns:
    
    Returns the propertiesFileName.
  - setPropertiesFileName
```
public void setPropertiesFileName(java.lang.String propertiesFileName)
```
    The name of the properties file (can be just the name of a file on the classpath or a full file path). The properties file used by a server-side engine
    
    Parameters:
    
    propertiesFileName - The propertiesFileName to set.
  - isCustomersShared
```
public boolean isCustomersShared()
```
    Only relevant when in MODE_MULTI_STORE_SHARED_DB mode. If set to true, customers are shared between all stores. If we aren't in MODE_MULTI_STORE_SHARED_DB mode, it always returns false.
    
    Returns:
    
    Returns true or false
  - setCustomersShared
```
public void setCustomersShared(boolean customersShared)
```
    Only relevant when in MODE_MULTI_STORE_SHARED_DB mode. If set to true, customers are shared between all stores.
    
    Parameters:
    
    customersShared - set to true or false
  - isProductsShared
```
public boolean isProductsShared()
```
    Only relevant when in MODE_MULTI_STORE_SHARED_DB mode. If set to true, products can be shared between all stores.
    
    Returns:
    
    the productsShared
  - setProductsShared
```
public void setProductsShared(boolean productsShared)
```
    Only relevant when in MODE_MULTI_STORE_SHARED_DB mode. If set to true, products can be shared between all stores.
    
    Parameters:
    
    productsShared - the productsShared to set
  - isCategoriesShared
```
public boolean isCategoriesShared()
```
    Only relevant when in MODE_MULTI_STORE_SHARED_DB mode and products are shared. If set to true, categories can be shared between all stores.
    
    Returns:
    
    the categoriesShared
  - setCategoriesShared
```
public void setCategoriesShared(boolean categoriesShared)
```
    Only relevant when in MODE_MULTI_STORE_SHARED_DB mode and products are shared. If set to true, categories can be shared between all stores.
    
    Parameters:
    
    categoriesShared - the categoriesShared to set
  - getEngineId
```
public java.lang.String getEngineId()
```
    Returns:
    
    Returns the engineId. This will be "C" (Community), "B" (Business) or "E" (Enterprise) or it could be null if not yet initialised.
  - setEngineId
```
public void setEngineId(java.lang.String engineId)
```
    Parameters:
    
    engineId - The engineId to set.
  - getProperties
```
public java.lang.String[] getProperties()
```
    Returns:
    
    the properties. For RMI and SOAP, if set the properties are used to configure the engine instead of the values read from the properties file. The structure of the properties array is:
    properties[0] = key 1
    properties[1] = value 1
    properties[2] = key 2
    properties[3] = value 2
    etc
  - setProperties
```
public void setProperties(java.lang.String[] properties)
```
    Parameters:
    
    properties - the properties to set
  - getRmiClientFileName
```
public java.lang.String getRmiClientFileName()
```
    The properties file used by a client-side of an RMI engine
    
    Returns:
    
    the rmiClientFileName
  - setRmiClientFileName
```
public void setRmiClientFileName(java.lang.String rmiClientFileName)
```
    The properties file used by a client-side of an RMI engine
    
    Parameters:
    
    rmiClientFileName - the rmiClientFileName to set
  - getJaxwsClientFileName
```
public java.lang.String getJaxwsClientFileName()
```
    The name of the properties file for the KonaKart Admin JAXWS client (can be just the name of a file on the classpath or a full file path). If set to null, the default properties file is used - konakartadmin_jaxws_client.properties.
    
    Returns:
    
    the jaxwsClientFileName
  - setJaxwsClientFileName
```
public void setJaxwsClientFileName(java.lang.String jaxwsClientFileName)
```
    The name of the properties file for the KonaKart Admin JAXWS client (can be just the name of a file on the classpath or a full file path). If set to null, the default properties file is used - konakartadmin_jaxws_client.properties.
    
    Parameters:
    
    jaxwsClientFileName - the jaxwsClientFileName to set

Class AdminEngineConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MODE_SINGLE_STORE

MODE_MULTI_STORE_NON_SHARED_DB

MODE_MULTI_STORE_SHARED_DB

storeId

mode

propertiesFileName

jaxwsClientFileName

rmiClientFileName

customersShared

productsShared

categoriesShared

properties

engineId

Constructor Detail

AdminEngineConfig

Method Detail

toString

clone

getStoreId

setStoreId

getMode

setMode

getPropertiesFileName

setPropertiesFileName

isCustomersShared

setCustomersShared

isProductsShared

setProductsShared

isCategoriesShared

setCategoriesShared

getEngineId

setEngineId

getProperties

setProperties

getRmiClientFileName

setRmiClientFileName

getJaxwsClientFileName

setJaxwsClientFileName