com.dpslink.flash.erp

Class ERPInterfaceAS400

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.flash.erp.ERPInterfaceAS400

All Implemented Interfaces:

ERPInterface, java.io.Serializable

Direct Known Subclasses:

ARInformation, Control, CustomerMaintenance, OrderCancel, OrderInformation, OrderPlacement, OrderSummary, ProductInformation, TestAES, UserMaintenance

public abstract class ERPInterfaceAS400
extends MappedAttributesObject
implements ERPInterface

An abstract ERP interface definition for AS400 ERP systems. This is the class from which all AS400 ERP interfaces are derived. Provides default AS400 ERP interface functionality, plus method signatures for required interface-specific functionality.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ERPInterfaceAS400.Pcml Inner class for facilitating PCML processing.
protected class	ERPInterfaceAS400.Received Inner class for facilitating received data queue record parsing.

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.ibm.as400.access.AS400Text	AS400TEXT3 An AS400 text field of length 3.
protected com.ibm.as400.access.AS400	ivAS400 The current AS400 connection to the ERP system.
protected java.util.Properties	ivConfig A subset of Profile that contains only the keys and values which specifically pertain to the implementing class.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

ivHashCode, ivHashFlds, ivObjAttrs

Fields inherited from interface com.dpslink.flash.erp.ERPInterface

ERROR_CONNECT, ERROR_NONE, ERROR_PROGRAM, WARN_DUPLICATE, WARN_NONE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ERPInterfaceAS400() The constructor for the abstract AS400 interface.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	callProgram() Calls the ERP program for execution.
boolean	equals(java.lang.Object obj) Compares the given object to this object and determines if the two are equal.
FlashServletContext	getContext() Returns the ERP interface's servlet context (i.e.
protected int	getEncryptAESLength(java.lang.String fldname) Returns the forced length for a string to be encrypted for the given ERP properties field name.
int	getErrorType() Returns the type of error encountered during processing.
protected java.lang.String	getMixedCase(java.lang.String s) Returns a mixed case string for the given string.
protected byte[]	getQueueKey() Returns the data queue key.
protected com.ibm.as400.access.RecordFormat	getRecordFormat(java.lang.String fmtname) Returns a record format for a record format file name.
protected int	getRecordFormatFieldDecimals(com.ibm.as400.access.RecordFormat recfmt, java.lang.String fldname) Returns the number of decimals positions for a field based on the field's definition in the record format.
protected com.ibm.as400.access.KeyedDataQueue	getRecvQueue() Returns a reference to the inbound receiving data queue.
protected com.ibm.as400.access.KeyedDataQueue	getSendQueue() Returns a reference to the outbound sending data queue.
protected java.lang.String	getStoreCompany() Returns the configured store company id.
protected java.lang.String	getStoreWarehouse() Returns the configured store warehouse id.
int	getWarningType() Returns the type of warning encountered during processing.
protected boolean	isEncryptAES() Answers if the configured encrypt AES flag is true.
protected boolean	isYes(java.lang.String key) Answers if a configured value in ivConfig is yes ("Y" or "y").
protected abstract boolean	parseQueueEntry(java.lang.String fmtid, byte[] qbytes) Parses a data queue entry that was received on the inbound receiving data queue.
protected boolean	process() Controls the processing of an ERP interface request.
protected void	readDataQueue() Reads information placed on the inbound receiving data queue by the called ERP program.
protected abstract void	sendDataQueue() Places information on the outbound sending data queue.
void	setContext(FlashServletContext ctx) Sets the ERP interface's servlet context (i.e.
void	setErrorType(int type) Sets the type of error encountered during processing.
protected void	setQueueKey(java.lang.String seed) Sets the data queue key.
void	setWarningType(int type) Sets the type of warning encountered during processing.

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

AS400TEXT3

protected static final com.ibm.as400.access.AS400Text AS400TEXT3

An AS400 text field of length 3. Used to extract a record format id during the reading of data from the inbound receive data queue.

ivConfig

protected java.util.Properties ivConfig

A subset of Profile that contains only the keys and values which specifically pertain to the implementing class. The subset keys do not include the implementing class' prefix. Example:

In Profile:
erp.CustomerMaintenance.pcml
erp.CustomerMaintenance.prepay.default
erp.CustomerMaintenance.useMixedCase
erp.CustomerMaintenance.forceUpperCase.send

In ivConfig:
pcml
prepay.default
useMixedCase
forceUpperCase.send

ivAS400

protected com.ibm.as400.access.AS400 ivAS400

The current AS400 connection to the ERP system.

Constructor Detail

ERPInterfaceAS400

protected ERPInterfaceAS400()

The constructor for the abstract AS400 interface.

Method Detail

getContext

public FlashServletContext getContext()

Returns the ERP interface's servlet context (i.e. the current context for the servlet or thread using the interface). Implements getContext in ERPInterface.

Specified by:

getContext in interface ERPInterface

Returns:

FlashServletContext - The current servlet or thread context.

setContext

public void setContext(FlashServletContext ctx)

Sets the ERP interface's servlet context (i.e. the current context for the servlet or thread using the interface). Implements setContext in ERPInterface.

Specified by:

setContext in interface ERPInterface

Parameters:

ctx - (FlashServletContext) The current servlet or thread context.

getErrorType

public int getErrorType()

Returns the type of error encountered during processing. Implements getErrorType in ERPInterface.

Specified by:

getErrorType in interface ERPInterface

Returns:

int - The type of error.

setErrorType

public void setErrorType(int type)

Sets the type of error encountered during processing. Implements setErrorType in ERPInterface.

Specified by:

setErrorType in interface ERPInterface

Parameters:

type - (int) The error type.

getWarningType

public int getWarningType()

Returns the type of warning encountered during processing. Implements getWarningType in ERPInterface.

Specified by:

getWarningType in interface ERPInterface

Returns:

int - The type of warning.

setWarningType

public void setWarningType(int type)

Sets the type of warning encountered during processing. Implements setWarningType in ERPInterface.

Specified by:

setWarningType in interface ERPInterface

Parameters:

type - (int) The warning type.

equals

public boolean equals(java.lang.Object obj)

Compares the given object to this object and determines if the two are equal. Equality is based object class name. Overrides equals in MappedAttributesObject.

Specified by:

equals in class MappedAttributesObject

Parameters:

obj - (Object) The object to compare with this object.

Returns:

boolean - true if the specified object is equal to this object, otherwise false.

getEncryptAESLength

protected int getEncryptAESLength(java.lang.String fldname)

Returns the forced length for a string to be encrypted for the given ERP properties field name.

Parameters:

fldname - (String) The name of a field as defined in the ERP properties file. The value "erp.encrypt.aes.len." is prepended to the given value prior to looking up the defined length.

Returns:

int - The field's forced length for a string to be encrypted. The value to be encrypted is padded or truncated to match this length prior to being encrypted. See AS400StringEncrypter.

getMixedCase

protected java.lang.String getMixedCase(java.lang.String s)

Returns a mixed case string for the given string. Performs standard mixed case processing and then applies WordFix corrections to the result. This is a shortcut convenience method for getContext().getController(WordFixController.class).getMixedCase().

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

getQueueKey

protected byte[] getQueueKey()

Returns the data queue key.

Returns:

byte[] - The data queue key.

setQueueKey

protected void setQueueKey(java.lang.String seed)

Sets the data queue key. The typical data queue key, which is the session id of the context, is automatically set when the context is set. If a key other than the typical key is desired, it must be set before any other processing occurs.

Parameters:

seed - (String) The value on which to base the key.

getRecordFormat

protected com.ibm.as400.access.RecordFormat getRecordFormat(java.lang.String fmtname)
                                                     throws java.lang.Exception

Returns a record format for a record format file name.

Parameters:

fmtname - (String) The name of a record format file. If necessary the name is prepended with a forward slash (/) and appended with ".properties".

Returns:

RecordFormat - The record format.

Throws:

java.lang.Exception - - if an error occurs during processing.

getRecordFormatFieldDecimals

protected int getRecordFormatFieldDecimals(com.ibm.as400.access.RecordFormat recfmt,
                                           java.lang.String fldname)

Returns the number of decimals positions for a field based on the field's definition in the record format.

Parameters:

recfmt - (RecordFormat) The record format containing the field.

fldname - (String) The name of the desired field.

Returns:

int - The field's decimal positions or zero (0) if the record format doesn't contain the field or if the field isn't a type of field that has decimals.

getRecvQueue

protected com.ibm.as400.access.KeyedDataQueue getRecvQueue()
                                                    throws java.lang.Exception

Returns a reference to the inbound receiving data queue. A connection to the ERP system is required prior to invoking this method.

Returns:

KeyedDataQueue - The receiving data queue.

Throws:

java.lang.Exception - - if an error occurs during processing.

getSendQueue

protected com.ibm.as400.access.KeyedDataQueue getSendQueue()
                                                    throws java.lang.Exception

Returns a reference to the outbound sending data queue. A connection to the ERP system is required prior to invoking this method.

Returns:

KeyedDataQueue - The sending data queue.

Throws:

java.lang.Exception - - if an error occurs during processing.

getStoreCompany

protected java.lang.String getStoreCompany()

Returns the configured store company id.

Returns:

String - The store company id.

getStoreWarehouse

protected java.lang.String getStoreWarehouse()

Returns the configured store warehouse id.

Returns:

String - The store warehouse id.

isEncryptAES

protected boolean isEncryptAES()

Answers if the configured encrypt AES flag is true.

Returns:

boolean - true if true, otherwise false.

isYes

protected boolean isYes(java.lang.String key)

Answers if a configured value in ivConfig is yes ("Y" or "y").

Parameters:

key - (String) The key for the configured value to check.

Returns:

boolean - true if yes, otherwise false.

process

protected boolean process()

Controls the processing of an ERP interface request. Handles obtaining a connection to the ERP system. Invokes the sendDataQueue, runProgram and readDataQueue abstract methods.

Returns:

boolean - true if processing the request is successful, otherwise false.

readDataQueue

protected void readDataQueue()
                      throws java.lang.Exception

Reads information placed on the inbound receiving data queue by the called ERP program. A connection to the ERP system is required prior to invoking this method. Invoked by process after a successful call to the ERP program. Iterates through the received queue entries for the current queue key, determines each queue entry's record format id, and then invokes the parseQueueEntry method.

Throws:

java.lang.Exception - - if an error occurs with reading data on the queue.

callProgram

protected abstract boolean callProgram()
                                throws java.lang.Exception

Calls the ERP program for execution. A connection to the ERP system is required prior to invoking this method. Invoked by process after any data to be placed on the send queue has been successfully placed and sent.

Returns:

boolean - true if the call was successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs with the running of the ERP program.

parseQueueEntry

protected abstract boolean parseQueueEntry(java.lang.String fmtid,
                                           byte[] qbytes)
                                    throws java.lang.Exception

Parses a data queue entry that was received on the inbound receiving data queue. A connection to the ERP system is required prior to invoking this method. Invoked by readDataQueue for each queue entry that is read for the current queue key.

Parameters:

fmtid - (String) The record format id of the queue entry.

qbytes - (byte[]) The data queue entry's raw data.

Returns:

boolean - true to read the next entry from the receive data queue or false to stop reading.

Throws:

java.lang.Exception - - if an error occurs with reading data on the queue.

sendDataQueue

protected abstract void sendDataQueue()
                               throws java.lang.Exception

Places information on the outbound sending data queue. A connection to the ERP system is required prior to invoking this method. Invoked by process as the first step after a connection to the ERP system has been successfully established.

Throws:

java.lang.Exception - - if an error occurs with placing data on the queue and sending the queue.