org.mule.modules.as400

Class AS400Connector

java.lang.Object

org.mule.modules.as400.AS400Connector

@RequiresEnterpriseLicense(allowEval=true)
 @Connector(name="as400",
           friendlyName="AS400",
           minMuleVersion="3.6")
public class AS400Connector
extends Object

IBM i (AS400) Connector

Author:

Infoview Systems Inc

Field Summary

Fields

Modifier and Type	Field and Description
protected org.mule.api.MuleContext	muleContext

Constructor Summary

Constructors

Constructor and Description
AS400Connector()

Method Summary

Modifier and Type	Method and Description
void	commandCall(String cmd) Execute OS400 (IBM i) command
AS400ConnectionStrategy	getConnectionStrategy()
IBMiClient	getiClient()
String	getLicenseData() This method reads CustomLicenseUtils.LICENSE_FILE_NAME and returns license data.
String	getPublicKeyData(String publicKeyName) This method reads file CustomLicenseUtils.LICENSE_FILE_NAME_WITH_PUBLIC_KEY and returns public key.
String	getSerialN() This method returns server or LPAR serial number.
Map<String,Object>	programCallProcessor(String programName, String programLibrary, String procedureName, Boolean procedureReturnsValue, Boolean threadSafe, List<ProgramCallParameter> parameters) Implementation of IBM i program call.
void	readDataQueue(org.mule.api.callback.SourceCallback callback, String dtaq, String library, String dtaqKey, SearchType dtaqKeySearchType, Boolean peek, String formatFileName, String formatFileLibrary) Listens until the data queue message arrives or the end of times, whichever comes first.
Object	readDataQueueProcessor(org.mule.api.MuleEvent muleEvent, String dtaq, String library, String dtaqKey, SearchType dtaqKeySearchType, int dtaqwaittime, Boolean peek, String formatFileName, String formatFileLibrary) Data queue message reader - waits for specified period of time until the message arrives then times out.
void	setConnectionStrategy(AS400ConnectionStrategy connectionStrategy)
void	setiClient(IBMiClient iClient)
void	setMuleContext(org.mule.api.MuleContext muleContext)
void	verifyLicense() This method checks the license on connector initialization.
void	writeDataQueue(String dtaq, String library, String dqEntry, String dtaqKey, String formatFileName, String formatFileLibrary) Data queue message writer.

Methods inherited from class java.lang.Object

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

Field Detail

muleContext

@Inject
protected org.mule.api.MuleContext muleContext

Constructor Detail

AS400Connector

public AS400Connector()

Method Detail

getiClient

public IBMiClient getiClient()

setiClient

public void setiClient(IBMiClient iClient)

verifyLicense

@Start
public void verifyLicense()
                           throws AS400LicenseException

This method checks the license on connector initialization. If not in testing mode nor running inside studio, the license check has to be performed

Throws:

AS400LicenseException - when license invalid.

readDataQueue

@Source(friendlyName="Data Queue Listener",
        sourceStrategy=POLLING,
        pollingPeriod=1L)
public void readDataQueue(org.mule.api.callback.SourceCallback callback,
                                                                                                                                   @Placement(order=1) @FriendlyName(value="Data Queue")
                                                                                                                                   String dtaq,
                                                                                                                                   @Placement(order=2)
                                                                                                                                   String library,
                                                                                                                                   @Placement(order=3) @FriendlyName(value="Key") @Summary(value="Only for keyed data queues. If not specified, the data queue is not keyed.") @Optional
                                                                                                                                   String dtaqKey,
                                                                                                                                   @Placement(order=4) @FriendlyName(value="Key Search Type") @Summary(value="GE (Greater or Equal), GT (Greater Than), LE (Lesser or equal), LT, EQ (Equal), NE (Not Equal) Required if key is specified") @Optional
                                                                                                                                   SearchType dtaqKeySearchType,
                                                                                                                                   @Placement(order=5) @FriendlyName(value="Keep messages in Queue") @Default(value="false")
                                                                                                                                   Boolean peek,
                                                                                                                                   @Placement(order=7) @FriendlyName(value="Format File Name") @Optional
                                                                                                                                   String formatFileName,
                                                                                                                                   @Placement(order=8) @FriendlyName(value="Format File Library") @Optional
                                                                                                                                   String formatFileLibrary)
                                                                                                                            throws AS400DataQueueReadException,
                                                                                                                                   AS400TransportException

Listens until the data queue message arrives or the end of times, whichever comes first. For keyed data queues, specify key = ' ' and key search type = Greater Than Or Equal. When receiving the message from keyed data queue, the key value will be saved into InboundProperties parameter as400.dataqueue.key. The data queue message is saved into payload as String.

Parameters:

callback - the callback

dtaq - the name of data queue

library - the name of library

dtaqKey - only for keyed data queues. If not specified, the data queue is not keyed

dtaqKeySearchType - the key search type

peek - keep messages in queue

formatFileName - Format file (AS400 table) name

formatFileLibrary - Format file (AS400 table) library name

Throws:

AS400DataQueueReadException - if method can't read data from data queue

AS400TransportException - if as400 service or network is unavailable

programCallProcessor

@Processor(friendlyName="Program Call")
public Map<String,Object> programCallProcessor(@Placement(order=1) @FriendlyName(value="Program or Service Program Name")
                                                                                        String programName,
                                                                                        @Placement(order=2)
                                                                                        String programLibrary,
                                                                                        @Placement(order=3) @FriendlyName(value="Service Program Procedure Name") @Optional
                                                                                        String procedureName,
                                                                                        @Placement(order=4) @FriendlyName(value="Procedure Returns Value?") @Default(value="false")
                                                                                        Boolean procedureReturnsValue,
                                                                                        @Placement(order=4) @Default(value="false")
                                                                                        Boolean threadSafe,
                                                                                        @Placement(order=5) @Optional
                                                                                        List<ProgramCallParameter> parameters)
                                                                                 throws AS400TransportException,
                                                                                        AS400ProgramCallException

Implementation of IBM i program call. Supports all simple data types, as well as data structures (use type = STRUCTURE) and arrays. Element of data structure cannot be a data structure or an array. Element of an array cannot be an array.

Parameters:

programName - name of the program

programLibrary - name of the program library

procedureName - name of service program procedure

procedureReturnsValue - indicates if procedure returns Integer value (true) or no value (false)

threadSafe - indicator if the program is thread safe

parameters - list of ProgramCallParameter definitions and value references

Returns:

outputParameters map of parameter name and value pairs returned by the program call. Array values are represented as ArrayLists. Data structure values are returned as Map of String, Object.

Throws:

AS400TransportException - if as400 service or network is unavailable

AS400ProgramCallException - when program call completed in error

readDataQueueProcessor

@Processor(friendlyName="Read Data Queue")
public Object readDataQueueProcessor(org.mule.api.MuleEvent muleEvent,
                                                                                 @Placement(order=1) @FriendlyName(value="Data Queue")
                                                                                 String dtaq,
                                                                                 @Placement(order=2)
                                                                                 String library,
                                                                                 @Placement(order=3) @FriendlyName(value="Key") @Summary(value="Only for keyed data queues. If not specified, the data queue is not keyed.") @Optional
                                                                                 String dtaqKey,
                                                                                 @Placement(order=4) @FriendlyName(value="Key Search Type") @Summary(value="GE (Greater or Equal), GT (Greater Than), LE (Lesser or equal), LT, EQ (Equal), NE (Not Equal) Required if key is specified") @Optional
                                                                                 SearchType dtaqKeySearchType,
                                                                                 @Placement(order=5) @FriendlyName(value="Max Wait Time") @Summary(value="Defaults to 0 (don\'t wait if no entries).") @Default(value="0")
                                                                                 int dtaqwaittime,
                                                                                 @Placement(order=6) @FriendlyName(value="Keep messages in Queue") @Default(value="false")
                                                                                 Boolean peek,
                                                                                 @Placement(order=7) @FriendlyName(value="Format File Name") @Optional
                                                                                 String formatFileName,
                                                                                 @Placement(order=8) @FriendlyName(value="Format File Library") @Optional
                                                                                 String formatFileLibrary)
                                                                          throws AS400DataQueueReadException,
                                                                                 AS400TransportException

Data queue message reader - waits for specified period of time until the message arrives then times out. For keyed data queues, specify key and search type. The key will be saved into OutboundProperties parameter as400.dataqueue.key. The data queue message is saved into payload.

Parameters:

muleEvent - the Mule Event

dtaq - the name of data queue

library - the name of library

dtaqKey - the name of key

dtaqKeySearchType - the key search type

dtaqwaittime - the max wait time

peek - the keep messages in queue

formatFileName - Format file (AS400 table) name

formatFileLibrary - Format file (AS400 table) library name

Returns:

readMessage from data queue

Throws:

AS400DataQueueReadException - if method can't read data from data queue

AS400TransportException - if as400 service or network is unavailable

writeDataQueue

@Processor
public void writeDataQueue(@FriendlyName(value="Data Queue") @Placement(order=1)
                                       String dtaq,
                                       @Placement(order=2)
                                       String library,
                                       @Default(value="#[payload]") @FriendlyName(value="Data Entry") @Placement(order=3)
                                       String dqEntry,
                                       @FriendlyName(value="Key") @Placement(order=4) @Optional
                                       String dtaqKey,
                                       @Placement(order=5) @FriendlyName(value="Format File Name") @Optional
                                       String formatFileName,
                                       @Placement(order=6) @FriendlyName(value="Format File Library") @Optional
                                       String formatFileLibrary)
                                throws AS400DataQueueWriteException,
                                       AS400TransportException

Data queue message writer.

Parameters:

dtaq - the data queue

library - the name of library

dqEntry - the data entry

dtaqKey - the key

formatFileName - Format file (AS400 table) name

formatFileLibrary - Format file (AS400 table) library name

Throws:

AS400DataQueueWriteException - if method can't write data to data queue

AS400TransportException - if as400 service or network is unavailable

commandCall

@Processor(friendlyName="Command Call")
public void commandCall(@FriendlyName(value="Command") @Default(value="#[payload]")
                                                                 String cmd)
                                                          throws AS400CommandCallException,
                                                                 AS400TransportException

Execute OS400 (IBM i) command

Parameters:

cmd - the AS400 command

Throws:

AS400CommandCallException - if method can't call command

AS400TransportException - if as400 service or network is unavailable

getConnectionStrategy

public AS400ConnectionStrategy getConnectionStrategy()

Returns:

the connectionStrategy

getPublicKeyData

public String getPublicKeyData(String publicKeyName)

This method reads file CustomLicenseUtils.LICENSE_FILE_NAME_WITH_PUBLIC_KEY and returns public key.

Parameters:

publicKeyName - the file name witch contains publicKey

Returns:

the public key if file exists, otherwise returns empty string

getLicenseData

public String getLicenseData()

This method reads CustomLicenseUtils.LICENSE_FILE_NAME and returns license data.

Returns:

the license data if file of license exists, otherwise returns empty string

getSerialN

public String getSerialN()

This method returns server or LPAR serial number.

Returns:

the serial number of AS400 if available, otherwise returns empty string

setConnectionStrategy

public void setConnectionStrategy(AS400ConnectionStrategy connectionStrategy)

Parameters:

connectionStrategy - the connectionStrategy to set

setMuleContext

public void setMuleContext(org.mule.api.MuleContext muleContext)

Parameters:

muleContext - the muleContext to set