Package com.softwaremining.mq

Interface MQInterface

All Known Implementing Classes:

MQImpl

public interface MQInterface

Interface for MQ-SERIES implementation.
Translation of applications using IBM MQ Series will ask MQManager class (in this package) to provide an Implementation of MQInterface.
Provision of the implementation class is responsibility of the end-user.
The purpose of this Interface is to ensure the basic MQ functionality (MQCONN, MQOPEN, MQPUT, MQGET and MQDISC) are provided.

Method Summary

Modifier and Type	Method	Description
int	close(IBaseService baseService, double hcConn, ISMDataType handleObj, double options, ISMNumeric completionCode, ISMNumeric reason)	MQCLOSE
int	connect(IBaseService baseService, ISMNumeric hcConn, ISMNumeric completionCode, ISMNumeric reason)	MQCONN NOTE: On z/OS, CICS applications do not have to issue this call.
int	connect(IBaseService baseService, String queueManager, ISMNumeric hcConn, ISMNumeric completionCode, ISMNumeric reason)	MQCONN NOTE: On z/OS, CICS applications do not have to issue this call.
int	disconnect(IBaseService baseService, double hcConn, ISMNumeric completionCode, ISMNumeric reason)	NOTE: On z/OS, CICS applications do not have to issue this call.
int	get(IBaseService baseService, double hcConn, double hObj, ISMDataType queueObjectName, ISMDataType msgOpts, double bufferLength, ISMDataType buffer, ISMNumeric dataLength, ISMNumeric completionCode, ISMNumeric reason)	MQGET
int	open(IBaseService baseService, double hcConn, ISMDataType queueObjectName, double options, double objRequestq, ISMNumeric completionCode, ISMNumeric reason)	MQOPEN
int	put(IBaseService baseService, double hcConn, double hObj, ISMDataType queueObjectName, ISMDataType msgOpts, double bufferLength, String buffer, ISMNumeric completionCode, ISMNumeric reason)	MQPUT

Method Details

connect

int connect(IBaseService baseService,
 String queueManager,
 ISMNumeric hcConn,
 ISMNumeric completionCode,
 ISMNumeric reason)

MQCONN NOTE: On z/OS, CICS applications do not have to issue this call. These applications are connected automatically to the queue manager to which the CICS system is connected. However, the MQCONN and MQDISC calls are still accepted from CICS applications.

connect

int connect(IBaseService baseService,
 ISMNumeric hcConn,
 ISMNumeric completionCode,
 ISMNumeric reason)

MQCONN NOTE: On z/OS, CICS applications do not have to issue this call. These applications are connected automatically to the queue manager to which the CICS system is connected. However, the MQCONN and MQDISC calls are still accepted from CICS applications.

open

int open(IBaseService baseService,
 double hcConn,
 ISMDataType queueObjectName,
 double options,
 double objRequestq,
 ISMNumeric completionCode,
 ISMNumeric reason)

MQOPEN

Parameters:

hcConn -

queueObjectName - - 4 types: Queue (or Namelists, Process definition, Queue Manager) there are 3 types of queues: LOCAL , REMOTE or DYNAMIC. Local and remote queues represent actual queues defined in the queue manager from an administrative prospective. They differ mostly in the way the name of the queue can be specified in the ObjectName field of the MQOD data structure

options -

objRequestq -

completionCode -

reason -

Returns:

close

int close(IBaseService baseService,
 double hcConn,
 ISMDataType handleObj,
 double options,
 ISMNumeric completionCode,
 ISMNumeric reason)

MQCLOSE

get

int get(IBaseService baseService,
 double hcConn,
 double hObj,
 ISMDataType queueObjectName,
 ISMDataType msgOpts,
 double bufferLength,
 ISMDataType buffer,
 ISMNumeric dataLength,
 ISMNumeric completionCode,
 ISMNumeric reason)

MQGET

put

int put(IBaseService baseService,
 double hcConn,
 double hObj,
 ISMDataType queueObjectName,
 ISMDataType msgOpts,
 double bufferLength,
 String buffer,
 ISMNumeric completionCode,
 ISMNumeric reason)

MQPUT

disconnect

int disconnect(IBaseService baseService,
 double hcConn,
 ISMNumeric completionCode,
 ISMNumeric reason)

NOTE: On z/OS, CICS applications do not have to issue this call. These applications are connected automatically to the queue manager to which the CICS system is connected. However, the MQCONN and MQDISC calls are still accepted from CICS applications.